WebPart members

  • Article

Represents a Web Part on a Web Part Page.

The WebPart type exposes the following members.

Constructors

  Name Description
Public method WebPart

Top

Properties

  Name Description
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property ExportMode
Public property Hidden Gets or sets a value that specifies whether a Web Part is displayed on a Web Part Page.
Public property IsClosed Gets a value that specifies whether a Web Part is currently closed on a Web Part Page.
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Properties
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property Subtitle Gets a value that specifies a string that is concatenated with the Title property value to form a complete title for a Web Part.
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property Title Gets or sets a value that specifies the title of a Web Part.
Public property TitleUrl Gets or sets a value that specifies a URL to supplemental information about a Web Part.
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property ZoneIndex Gets a value that specifies the index position of a Web Part within the Web Part zone.

Top

Methods

  Name Description
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)

Top

See also

Reference

WebPart class

Microsoft.SharePoint.Client.WebParts namespace