IVersioningPersonalizable.Load(IDictionary) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Loads personalization data to a Web Parts control that does not have a corresponding personalized property for the data due to a version change.
public:
void Load(System::Collections::IDictionary ^ unknownProperties);public void Load (System.Collections.IDictionary unknownProperties);abstract member Load : System.Collections.IDictionary -> unitPublic Sub Load (unknownProperties As IDictionary)Parameters
- unknownProperties
- IDictionary
A dictionary of personalization data that could not be applied to a control.
Remarks
The unknownProperties parameter contains a merged representation of unknown personalization data, of both "User" and "Shared" scope, that could not be applied to the control. When a page is running in user scope, the unknown user-scope values are supplied (if available) rather than unknown shared-scope values. This information is stored as a series of name/value pairs where each name is the string name of a property that was not found on the control and each value contains the property value. It is the responsibility of the control to cast or convert the value to the appropriate type and carry out further processing (such as mapping data from an old property to a new property).
If a control's state changes, it should call SetPersonalizationDirty (either the inherited method, or the public static method in the case of a control that does not derive from WebPart). If a control marks itself as "dirty", the Web Parts control set will extract personalization data from the control, regardless of the control's "dirty" state, and save it back to the underlying data store later in the personalization life cycle. A control should mark itself as "dirty" if, as a result of processing the values in the unknownProperties parameter, the control's state has changed.
Note that if orphaned properties are detected when importing Web Parts controls, this method is automatically called.
