WebPartDefinition members
Represents a Web Part on a Web Part Page.
The WebPartDefinition type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
WebPartDefinition |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Context | Returns the context that is associated with the client object. (Inherited from ClientObject.) |
|
Id | Gets a value that specifies the Web Part identifier of the Web Part. |
.gif "Protected property") |
ObjectData | Gets the object data for the current client object. (Inherited from ClientObject.) |
|
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.) |
|
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.) |
|
ServerObjectIsNull | Gets the server object and returns null if the server object is null. (Inherited from ClientObject.) |
|
Tag | Gets or sets data that is associated with the client object. (Inherited from ClientObject.) |
|
TypedObject | Gets the object with the correct type information returned from the server. (Inherited from ClientObject.) |
|
WebPart | The WebPart object represents a Web Part on a Web Part Page associated with this WebPartDefinition. |
|
ZoneId |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
CheckUninitializedProperty | Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.) |
|
CloseWebPart | Closes the Web Part. |
|
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.) |
|
DeleteWebPart | Deletes the Web Part from the page. |
|
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.) |
|
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.) |
|
InitOnePropertyFromJson | (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).) |
|
IsObjectPropertyInstantiated | Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.) |
|
IsPropertyAvailable | Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.) |
|
LoadExpandoFields | Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.) |
|
MoveWebPartTo | Moves the Web Part to a different location on a Web Part Page. |
|
OpenWebPart | Opens the Web Part. |
|
RefreshLoad | Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.) |
|
RemoveFromParentCollection | Removes the current client object from the parent client object collection. (Inherited from ClientObject.) |
|
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.) |
|
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.) |
|
SaveWebPartChanges | Saves changes to the Web Part made using other properties and methods on the WebPartDefinition object. |
|
ToString | (Inherited from Object.) |
|
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