Try our conversational search powered by Generative AI!

smithsson68@gmail.com
Jan 5, 2010
  9886
(1 votes)

Saving Page Objects

EPiServer CMS 6 introduces Page Objects. A Page Object is simply a .NET object that is created by the developer and then associated to an EPiServer CMS page via the EPiServer.Core.PageData.PageObjects collection.

Saving Page Objects is a relatively simple task but there a couple of pitfalls so here are some best practice guidelines to follow:

Saving a Page Object for the first time

Create your object as normal:

   1: MyClass obj = new MyClass();
   2: obj.StringValue = "Hello World!";

Add the object to the PageObjects collection for the current page:

   1: PageData pd = null;
   2:  
   3: if (this.CurrentPage.IsModified)
   4: {
   5:     pd = this.CurrentPage;
   6: }
   7: else
   8: {
   9:     pd = this.CurrentPage.CreateWritableClone();
  10: }
  11:  
  12: pd.PageObjects["MyKey"] = obj;

And then save the current page (as the same version)

   1: DataFactory.Instance.Save(pd, 
   2:                 EPiServer.DataAccess.SaveAction.Publish | 
   3:                 EPiServer.DataAccess.SaveAction.ForceCurrentVersion, 
   4:                 EPiServer.Security.AccessLevel.NoAccess);

Updating an existing object requires a modified flag to be set so the DataFactory knows what to update:

   1: PageData pd = null;
   2:  
   3: if (this.CurrentPage.IsModified)
   4: {
   5:     pd = this.CurrentPage;
   6: }
   7: else
   8: {
   9:     pd = this.CurrentPage.CreateWritableClone();
  10: }
  11:  
  12: // It is important to do the cloning first
  13: // as the clone has a different instance of
  14: // the Page Object to the original
  15: // and therefore you will update the 
  16: // wrong version!!
  17:  
  18: MyClass obj = pd.PageObjects["MyKey"] as MyClass;
  19: obj.StringValue = this.SomeTextBox.Text;
  20:  
  21: // Tell the collection something has changes
  22: pd.PageObjects.SetObjectModified(["MyKey");
  23:  
  24: // And Save
  25: DataFactory.Instance.Save(pd, 
  26:                 EPiServer.DataAccess.SaveAction.Publish |
  27:                 EPiServer.DataAccess.SaveAction.ForceCurrentVersion, 
  28:                 EPiServer.Security.AccessLevel.NoAccess);

IMPORTANT: Replacing an existing object will create a new row in the database if your object does not implement EPiServer.Data.Dynamic.IDynamicData as it’s identity cannot be determined.

Removing a Page Object is simple:

   1: PageData pd = null;
   2:  
   3: if (this.CurrentPage.IsModified)
   4: {
   5:     pd = this.CurrentPage;
   6: }
   7: else
   8: {
   9:     pd = this.CurrentPage.CreateWritableClone();
  10: }
  11:  
  12: pd.PageObjects.Remove("MyKey");
  13:  
  14: DataFactory.Instance.Save(pd, 
  15:                 EPiServer.DataAccess.SaveAction.Publish | 
  16:                 EPiServer.DataAccess.SaveAction.ForceCurrentVersion, 
  17:                 EPiServer.Security.AccessLevel.NoAccess);
Jan 05, 2010

Comments

Sep 21, 2010 10:33 AM

When the Page Object is modified , after modification , how is the instruction pd.PageObjects.SetObjectModified(["MyKey") connecting to the modified object "obj" .

Thanks in advance.
Regards,

S.K. SreeRaghavendra
/ S.K. SreeRaghavendra

smithsson68@gmail.com
smithsson68@gmail.com Sep 21, 2010 10:33 AM

The variable 'obj' was obtained by accessing the PageObjects collection using the key 'MyKey'.

As the MyClass instance is not aware in any way of the PageObjects collection it cannot tell the DataFactory that is needs re-saving because one of it's properties (StringValue) has been updated. Therefore you need to tell the PageObjects collection that one of its object has been modified so it will know it has to save it down to the Dynamic Data Store when the DataFactory.Save method is called for the PageData instrance.

Sep 21, 2010 10:33 AM

Thanks Paul for the reply.


In the code as specified above obj's Property StringValue is being changed.Then in the statement " pd.PageObjects.SetObjectModified(["MyKey");" the collection is indicated of some changes .In the Save method thereafter the Pagedata object "pd" is passed .But there is no statement where the changed object "obj" is again set in the PageObject's Collection.i.e after the statement obj.StringValue is executed.

Kindly clarify my doubt..
Thanks again..


/ S.K. SreeRaghavendra

Sep 21, 2010 10:33 AM

Hi,

This is because by calling

MyClass obj = pd.PageObjects["MyKey"] as MyClass;

you hold a reference to the same physical object still in the PageData.PageObject collection and therefore when you save the PageData the DataFactory looks for any modified flags on Page Objects (which it will find because of the SetObjectModified call) and then save the object back to the Dynamic Data Store.
/ Paul Smith

Sep 21, 2010 10:33 AM

Ok, so when the object "obj" is changed,the pageObject Collection also observers a change and to commit that change ,SetObjectMethod does the rest of the work.

Cool,.
Thank you very very much for your prompt response.
/ S.K. SreeRaghavendra

Please login to comment.
Latest blogs
The A/A Test: What You Need to Know

Sure, we all know what an A/B test can do. But what is an A/A test? How is it different? With an A/B test, we know that we can take a webpage (our...

Lindsey Rogers | Apr 15, 2024

.Net Core Timezone ID's Windows vs Linux

Hey all, First post here and I would like to talk about Timezone ID's and How Windows and Linux systems use different IDs. We currently run a .NET...

sheider | Apr 15, 2024

What's new in Language Manager 5.3.0

In Language Manager (LM) version 5.2.0, we added an option in appsettings.json called TranslateOrCopyContentAreaChildrenBlockForTypes . It does...

Quoc Anh Nguyen | Apr 15, 2024

Optimizely Search & Navigation: Boosting in Unified Search

In the Optimizely Search & Navigation admin view, administrators can set a certain weight of different properties (title, content, summary, or...

Tung Tran | Apr 15, 2024

Optimizely CMS – Getting all content of a specific property with a simple SQL script

When you need to retrieve all content of a specific property from a Page/Block type, normally you will use the IContentLoader or IContentRepository...

Tung Tran | Apr 15, 2024

Join the Content Recommendations Work Smarter webinar May 8th 16.00-16.45 CET with expert Aidan Swain

Learn more about Content Recommendations, with Optimizely’s very own Senior Solutions consultant, Aidan Swain . He will discuss best practices and...

Karen McDougall | Apr 12, 2024