Table of contents
TOC
Collapse the table of content
Expand the table of content

CustomAction Class

SharePoint Dev Documents|Last Updated: 9/8/2017
|
1 Contributor

Domain Object for custom actions associated with a SharePoint list, Web site, or subsite.

Domain Object for custom actions associated with a SharePoint list, Web site, or subsite.

Namespace:OfficeDevPnP.Core.Framework.Provisioning.Model
Assembly: OfficeDevPnP.Core.dll

Inheritance Hierarchy

System.Object
OfficeDevPnP.Core.Framework.Provisioning.Model.BaseModel

Syntax

public class CustomAction: BaseModel, IEquatable<CustomAction>

Constructors

NameDescription
CustomAction()Domain Object for custom actions associated with a SharePoint list, Web site, or subsite. Domain Object for custom actions associated with a SharePoint list, Web site, or subsite.

Properties

NameDescription
ClientSideComponentIdGets or sets a value for the ClientSideComponentId, if any
ClientSideComponentPropertiesGets or sets a value for the ClientSideComponentProperties, if any
CommandUIExtension
DescriptionGets or sets the description of the custom action.
EnabledGets or sets the Enabled property value.
GroupGets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.
ImageUrlGets or sets the URL of the image associated with the custom action.
LocationGets or sets the location of the custom action. A string that contains the location; for example, Microsoft.SharePoint.SiteSettings.
NameGets or sets the name of the custom action.
RegistrationIdGets or sets the RegistrationId of the custom action.
RegistrationTypeGets or sets the RegistrationType of the custom action.
RemoveGets or sets a value that specifies whether to Remove the CustomAction from the target
RightsGets or sets the value that specifies the permissions needed for the custom action.
RightsValueGets or sets the value that specifies the permissions needed for the custom action. https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.permissionkind.aspx
ScriptBlockGets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.
ScriptSrcGets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page
SequenceGets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page.
TitleGets or sets the display title of the custom action.
UrlGets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.

Methods

NameDescription
Equals(Object)Compares object with CustomAction
Equals(CustomAction)Compares CustomAction object based on CommandUIExtension, Description, Enabled, Group, ImageUrl, Location, Name, RegistrationId, RegistrationType, Remove, Rights, ScriptBlock, ScriptSrc, Sequence, Title and Url properties.
GetHashCode()Gets the hash code

See also

© 2018 Microsoft