Share via


SPUserCustomAction members

Contains metadata used to define a custom action entry point.

The SPUserCustomAction type exposes the following members.

Properties

  Name Description
Public property CommandUIExtension Gets and sets XML that defines an extension to the ribbon.
Public property CommandUIExtensionResource Gets an SPUserResource object that represents translations for the CommandUIExtension property.
Public property Description Gets or sets a description of the custom action.
Public property DescriptionResource Gets an SPUserResource object that represents translations for the description of the custom action.
Public property Group Gets or sets the name of an action group that the custom action belongs to.
Public property Id Gets a GUID value that uniquely identifies the custom action.
Public property ImageUrl Gets and sets the URL to an image that represents an icon for the custom action.
Public property Location Gets and sets the location of the custom action.
Public property Name Gets or sets the name of the custom action.
Public property 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).
Public property RegistrationType Gets or sets an enumeration value that specifies the type of custom action.
Public property Rights Gets or sets a value that specifies the permissions needed for the custom action.
Public property Scope Gets a value that specifies the scope of the custom action.
Public property ScriptBlock Gets or sets the value that specifies the JavaScript to be executed when the custom action is performed.
Public property ScriptSrc Gets or sets the URL to a file that contains JavaScript to be executed when the custom action is performed.
Public property Sequence Gets or sets an implementation-specific value that determines the order of the custom action that appears on the page.
Public property Title Gets or sets the caption title for the custom action.
Public property TitleResource Gets an SPUserResource object that represents the translations for the title of custom action.
Public property Url Gets or sets the action that will be taken when the custom action is fired.
Public property VersionOfUserCustomAction Gets a value that represents an implementation-specific version identifier.

Top

Methods

  Name Description
Public method Delete() Deletes the custom action.
Protected method Delete(Int32, Int32) Deletes the custom action and returns the number of actions remaining for the current and parent scope.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method Update Updates the custom action by writing changes to the database.
Protected method Validate Performs validation of the custom action prior to saving it.

Top

See also

Reference

SPUserCustomAction class

Microsoft.SharePoint namespace