UserCustomAction Members
Include Protected Members
Include Inherited Members
Represents a custom action associated with a SharePoint list, Web site, or subsite.
The UserCustomAction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
UserCustomAction |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CommandUIExtension | Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. |
|
Context | Returns the context that is associated with the client object. (Inherited from ClientObject.) |
|
Description | Gets or sets the description of the custom action. |
|
Group | Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. |
|
Id | Gets a value that specifies the identifier of the custom action. |
|
ImageUrl | Gets or sets the URL of the image associated with the custom action. |
|
Location | Gets or sets the location of the custom action. |
|
Name | Gets or sets the name of the custom action. |
.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 re-created on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.) |
|
RegistrationId | Gets or sets the value that specifies the identifier of the object associated with the custom action. |
|
RegistrationType | Gets or sets the value that specifies the type of object associated with the custom action. |
|
Rights | Gets or sets the value that specifies the permissions needed for the custom action. |
|
Scope | Gets a value that specifies the scope of the custom action. |
|
ScriptBlock | Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. |
|
ScriptSrc | Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page |
|
Sequence | Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. |
|
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.) |
|
Title | Gets or sets the display title of the custom action. |
|
Url | Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action. |
|
VersionOfUserCustomAction | Gets a value that specifies an implementation specific version identifier. |
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.) |
|
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.) |
|
DeleteObject | Deletes the custom action. |
|
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 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 | When overridden in a derived class, initializes the extended properties associated with the client object. (Inherited from ClientObject.) |
|
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.) |
|
ToString | (Inherited from Object.) |
|
Update | Updates the custom action. |
Top