WPSC Object

  • Article

Applies to: SharePoint Foundation 2010

A client-side JavaScript component that encapsulates the set of services provided to Web Parts and Web Part Pages.

Public Methods

The following table shows the methods of the WPSC object and a brief description of each.

Method

Description

Convert Method  

Supports conversion between encoded and unencoded URLs.

Init Method   

Initializes the WPSC object.

RaiseEvent Method   

Notifies Web Parts within a Web Part Page that an event has occurred.

RaiseConnectionEvent Method

Raises a multicast event that notifies other Web Parts within a Web Part Page that an event has occurred.

RaiseConnectionEventSpecial Method

Enables client-side Web Parts that are ActiveX controls to raise connection events by transforming VBArrays to ECMAScript (JScript, JavaScript) arrays, converting them to an appropriate EventArgs structure, and then calling the RRaiseConnectionEvent Method method.

RegisterForEvent Method

Enables a Web Part to register for a system or custom event.

RegisterForPromptedSave Method

Enables Web Parts to prompt the user only once to save changes to modified Web Parts, rather then multiple times, when the user leaves the page.

UnregisterForEvent Method

Unregisters an event for which a Web Part was previously registered.

Public Properties

The following table shows the methods of the WPSC object and a brief description of each

Method

Description

WebPartPage Property  

Returns a pointer to a WebPartPage Object.

Remarks

During Web Part Page rendering, a single WPSC object is inserted into the page by the Web Part infrastructure, making the Web Part Page Services Component (WPSC) services available to Web Parts on that page.

See Also

Other Resources

Web Part Page Services Component (WPSC) Object Model