Share via

PropertyCollection Object (State Management Service)

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The PropertyCollection object makes it possible for properties to be retrieved, set, added, or deleted. Only properties that are set for the object appear.

**Note   **Removing a property is not the same as setting the property value to NULL.

Methods

PropertyObject Add (PropertyName,);
Remove (Index);
PropertyObject Item (Index);
Count Count ();

Parameters

  • Index
    Identifies the property in the collection. The value of Index can be one of the following:

    • An integer that indicates the position of the property in the collection

    • A string, which is the combination of URN and property Name separated by the pound sign (#) or colon (:); for example, Part.Properties.Item ("urn:schemas-microsoft-com:webpart:PartStorage")

      **Note   **In the Add method, the value of Index must be a string.

  • PropertyObject
    The returned property object.
  • S_OK, E_FAIL, E_INVALIDARG
    Return values used for error handling.

See Also

State Management Service | Part Object (State Management Service) | Dashboard Object (State Management Service) | Property Object (State Management Service) | State Management Service Example