SPUserCustomAction Members
Include Protected Members
Include Inherited Members
Contains metadata used to define a custom action entry point.
The SPUserCustomAction type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CommandUIExtension | Gets and sets XML that defines an extension to the ribbon. |
|
CommandUIExtensionResource | Gets an SPUserResource object that represents translations for the CommandUIExtension property. |
|
Description | Gets or sets a description of the custom action. |
|
DescriptionResource | Gets an SPUserResource object that represents translations for the description of the custom action. |
|
Group | Gets or sets the name of an action group that the custom action belongs to. |
|
Id | Gets a GUID value that uniquely identifies the custom action. |
|
ImageUrl | Gets and sets the URL to an image that represents an icon for the custom action. |
|
Location | Gets and sets the location of the custom action. |
|
Name | Gets or sets the name of the custom action. |
|
RegistrationId | Gets and sets the identifier of the list or item content type that this custom action is associated with, or the file type or program identifier (ProgID). |
|
RegistrationType | Gets or sets an enumeration value that specifies the type of custom action. |
|
Rights | Gets or sets a 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 JavaScript to be executed when the custom action is performed. |
|
ScriptSrc | Gets or sets the URL to a file that contains JavaScript to be executed when the custom action is performed. |
|
Sequence | Gets or sets an implementation-specific value that determines the order of the custom action that appears on the page. |
|
Title | Gets or sets the caption title for the custom action. |
|
TitleResource | Gets an SPUserResource object that represents the translations for the title of custom action. |
|
Url | Gets or sets the action that will be taken when the custom action is fired. |
|
VersionOfUserCustomAction | Gets a value that represents an implementation-specific version identifier. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Delete() | Deletes the custom action. |
.gif "Protected method") |
Delete(Int32, Int32) | Deletes the custom action and returns the number of actions remaining for the current and parent scope. |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
|
Update | Updates the custom action by writing changes to the database. |
|
Validate | Performs validation of the custom action prior to saving it. |
Top