Share via

PartCollection Object (Part Discovery 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 PartCollection object makes it possible for Web Parts to be registered, unregistered, and retrieved by index or enumeration. Because the code to register Web Parts is generated automatically by the dashboard factory, Web Parts only should use the registration functions if they are designed to add or remove Web Parts from the page dynamically.

Methods

PartObj Register (WebPartQualifier, WebPartID, DOMObj,);
UnRegister (Index);
PartObj Item (Index);
Count Count ();

Parameters

  • WebPartQualifier
    Unique identifier for a Web Part on the dashboard. This is generated automatically by the dashboard factory when the dashboard page is rendered.
  • WebPartID
    Uniquely identifies a part in the store and is used by state management service to post modification back to the store module. If the Init function has not been called, WebPartID must be a fully qualified URL. If the Init function has been called, WebPartID is used as a parameter to identify the Web Part.
  • Index
    Identifies the Web Part in the Web Part collection. The value of Index can be either the WebPartQualifier or an integer that indicates the location of the Web Part in the collection.
  • S_OK, E_FAIL, or E_INVALIDARG
    Return values used for error handling.

See Also

Part Discovery Service | DDSC Object (Part Discovery Service) | Dashboard Object (Part Discovery Service) | Part Object (Part Discovery Service) | Part Discovery Service Example