Try our conversational search powered by Generative AI!

KennyG
Jan 25, 2019
  2485
(1 votes)

PropertyList Changes Not Detected, Adding vs Updating

So here is a little nuance, that took me some time to figure out. I was programmatically updating a PropertyList but it never seemed to actually update.

Let’s take the following propertylist as an example:

namespace PropertyListDemo.Models
{
    public class Character
    {
        [Display(Name = "Hero Name")]
        public string Name { get; set; }
        [Display(Name = "Team Affiliation")]
        public string Affiliation { get; set; }
        [Display(Name = "Secret Identity Name")]
        public string SecretIdentity { get; set; }
    }

    [PropertyDefinitionTypePlugIn]
    public class CharacterListProperty : PropertyListBase<Character>
    {
    }

    public class PropertyListBase<T> : PropertyList<T>
    {
        public PropertyListBase()
        {
            _objectSerializer = this._objectSerializerFactory.Service.GetSerializer("application/json");
        }
        private Injected<ObjectSerializerFactory> _objectSerializerFactory;

        private IObjectSerializer _objectSerializer;
        protected override T ParseItem(string value)
        {
            return _objectSerializer.Deserialize<T>(value);
        }

        public override PropertyData ParseToObject(string value)
        {
            ParseToSelf(value);
            return this;
        }
    }

    [EditorDescriptorRegistration(TargetType = typeof(IList<Character>))]
    public class CharacterCollectionEditorDescriptor : CollectionEditorDescriptor<Character>
    {
    }
}

Adding to the propertylist worked as expected:

            var standardPage = currentPage.CreateWritableClone() as StandardPage;

            if (standardPage?.Heroes != null && standardPage.Heroes.Any())
            {

                standardPage.Heroes.Add(new Character()
                {
                    Name = "Hulk",
                    Affiliation = "Avengers",
                    SecretIdentity = "Bruce Banner"
                });


                contentRepository.Save(standardPage, SaveAction.Publish, AccessLevel.NoAccess);
            }

However, if instead of adding I was trying to update the propertylist:

            var standardPage = currentPage.CreateWritableClone() as StandardPage;

            if (standardPage?.Heroes != null && standardPage.Heroes.Any())
            {
                var match = standardPage.Heroes.FirstOrDefault(x => x.Name == "Superman");
                if (match != null)
                {
                    match.Name = "Iron Man";
                    match.Affiliation = "Avengers";
                    match.SecretIdentity = "Tony Stark";
                }


                contentRepository.Save(standardPage, SaveAction.Publish, AccessLevel.NoAccess);
            }

It would act like it had saved but the data wouldn’t be any different.

After a lot of time Googling and debugging, I determined that there is a Boolean “IsModified” flag from the ContentData abstract class.

standardPage.Property["Heroes"].IsModified = true;

This needs to be true when saving the page. When adding to the propertylist it is true, but when updating it is false, so it has to be manually set. So, an update followed by an add would work but update by itself doesn’t work.

So, it’s a good idea to go ahead and set the flag yourself before saving the page.

            var standardPage = currentPage.CreateWritableClone() as StandardPage;

            if (standardPage?.Heroes != null && standardPage.Heroes.Any())
            {
                var match = standardPage.Heroes.FirstOrDefault(x => x.Name == "Superman");
                if (match != null)
                {
                    match.Name = "Iron Man";
                    match.Affiliation = "Avengers";
                    match.SecretIdentity = "Tony Stark";
                }

                standardPage.Property["Heroes"].IsModified = true;

                contentRepository.Save(standardPage, SaveAction.Publish, AccessLevel.NoAccess);
            }
Jan 25, 2019

Comments

Praful Jangid
Praful Jangid Mar 5, 2019 02:55 PM

Is this the case only applicable for PropertyList type? Or we need to set this IsModified for any kind of Episerver property type?

KennyG
KennyG Mar 5, 2019 10:05 PM

Hey Praful, I tried a quick test with a string and it updated just fine. I can't say it's all types but simple ones seem fine.

Please login to comment.
Latest blogs
Build a headless blog with Astro and Optimizely SaaS CMS

I’m a big fan of using the right tool for the right job. I’m also a big fan of Astro , for the right use case. Let's explore Astro to see what it's...

Jacob Pretorius | May 28, 2024

Microsoft announces Natural language to SQL

Finally, Microsoft launches "Natural language to SQL," after it has been available for several months in Optimizely CMS!

Tomas Hensrud Gulla | May 23, 2024 | Syndicated blog

Five easy ways to start personalizing your content right now

If you clicked on this article, you already know that getting the right message to the right person at the right time helps drive conversions and...

Kara Andersen | May 23, 2024

ExtendedCms.TinyMceEnhancements – serwer side webp support

Today I will introduce another small feature of TinyMceEnhancements plugin. The functionality is used to automatically detect whether a browser...

Grzegorz Wiecheć | May 22, 2024 | Syndicated blog

Azure AI Language– Detect Healthcare Content in Optimizely CMS

In this blog post, I showcase how the Azure AI Language service's Text Analytics for health feature can be used to detect healthcare content within...

Anil Patel | May 22, 2024 | Syndicated blog

Stott Security Version 2 So Far

In December 2023, I unveiled the initial version of Stott Security version 2. Although I typically announce each version I release on LinkedIn and...

Mark Stott | May 22, 2024