Skip to main content

One of the properties of the Web Part has an incorrect format

I was trying to insert a Content Editor Web Part (CEWP) to a Master Page. I used the recommended route of using Design Manager. Let me share the steps if you are new to this:

1. Navigate to Site Settings
2. Under Look and Feel, click on Design Manager
3. Click on Edit Master Pages and click on perticular Master Page which you would like to edit (before editing, ensure you have a copy of the file for backup)
4. Click on Snippets
5. In the Snippet Gallery, insert CEWP, and set the web part properties
6. Click on Update button
7. Copy the HTML snippet generated and paste it in the Master page (.html file)
8. Upload the [[Master Page]].html file and publish

With this approach, you can attach any custom HTML/JavaScript which you would want to execute in all the pages in a site. After publishing the master page, when I refreshed the page, I got the below error:
One of the properties of the Web Part has an incorrect format. Microsoft SharePoint Foundation cannot deserialize the Web Part. Check the format of the properties and try again.

This error was frustating as it did not tell which property has incorrect format. Luckily I had the Developer Dashboard which came handy in this case. This tool gave me enough information like this:

System.InvalidOperationException: Instance validation error: 'None' is not a valid value for FrameType. at Microsoft.Xml.Serialization.GeneratedAssembly.XmlSerializationReaderContentEditorWebPart.Read7_FrameType(String s) at Microsoft.Xml.Serialization.GeneratedAssembly.XmlSerializationReaderContentEditorWebPart.Read12_ContentEditorWebPart(Boolean isNullable, Boolean checkType) at Microsoft.Xml.Serialization.GeneratedAssembly.XmlSerializationReaderContentEditorWebPart.Read13_WebPart()

The culprit was the property "FrameType" which was present in the HTML as

<!--MS:<frametype>--><!--SPM:None--><!--ME:</FrameType>-->

I had set this property to None in web part properties box. Interestingly, this value is not recognized by the SharePoint! Though I could have spent time in finding out the correct value, I just went ahead and deleted this property from the HTML snippet in the master page.

Well, the story did not end here. I got similar error for the following Properties one by one (It is so frustating that I had to remove each line one by one, publish the Master Page for every error).

System.InvalidOperationException: Instance validation error: 'Normal' is not a valid value for FrameState.

System.InvalidOperationException: Instance validation error: 'Modeless' is not a valid value for WebPartHelpMode.

System.InvalidOperationException: Instance validation error: 'Default' is not a valid value for Direction.

After clearing the above HTML lines, finally the page was loaded.

I am still clueless why Snippets generated the HTML code which does not work! If I get time to research on this, will share my findings here.

Comments

  1. That was helpful...
    Just to clarify - HTML code (which actually is rather XML than HTML in this case) is generated well. Whole mess happens when you upload your masterpage and it's translated to .master file. All properties are then broken into seperate lines with nice line indents so they are easy to read. But unfortunately serializer treats those whitespaces as parts of value. And there we go.

    ReplyDelete
    Replies
    1. Thanks for the clarification @Anonymous.

      Delete

Post a Comment

Popular posts from this blog

How to update Person field with multiple values using REST API

Person or Group field in SharePoint is similar to a Lookup field. When you are updating this field using REST API, you need to append "Id" to the name of the column in the body construct. For example, the body construct looks like this:

data: { "__metadata": { "type": "SP.Data.ListNameListItem" }, "Title": "First Item", "PeopleFieldId": "4" };

The highlighted portions should be replaced by the actual List Name and Column Name. In the above example, the REST call is updating a List item with Title and People columns.

How to get the value for user ID ("4" in the above example) needs a separate explanation and that will be my next post!

The above example works fine if Person field is configured to accept only one value. If we change the Person field to accept multiple values, how do we pass more than one value in the REST call? Since we normally separate user names with semicolon in people picker, I…

All about SharePoint List View Styles

Sometimes, there are out of the box features which we tend to ignore and later when we do apply, we are more than happy about the feature which is readily available in SharePoint. One such feature is List View Style. I never thought I would write a post on this. However, whenever I spoke about this with users, people were excited to see the result. That prompted me to write this post.

Instead of getting into only theory part, I will basically take use cases where these styles can be applied and also touch up on on some minor limitations with certain style.

When you are creating/modifying a List view, you will get an option to select View Style. As shown below, there are 8 options available and Default is always set if you ignore this style.


I will take typical Contact List and Announcement List to explian about these styles. Let us go one by one.

Default:
This view, as name suggest, is the default style in a view. This is one of the widely seen style in SharePoint site. This is how it…

Difference between Choice and Lookup fields in SharePoint

When you have to provide users an option of selecting a value from a list, you can go for a Choice field or a Lookup field. Have you ever wondered which one to use and when? Which option should be chosen over other? To address these questions, one need to understand the differences between these two data types in SharePoint. This post outlines these differences to help users decide the appropriate column type based on their needs.

FactorChoiceLookupPermissionTo add values to a Choice field, you need minimum Design permissionTo add values to a Lookup field, you need minimum Contribute/Add permissionChanging existing ValuesIf you change a value in a Choice field, it does not affect the existing values. For example, let us say one of the values was NY and there are items with this value. If you change it to New York in the field schema, it only affects the new values. All existing values will retain NY.If you change a value in a Lookup field, all the existing rows reflect the new value,…