Class CustomAction
Domain Object for custom actions associated with a SharePoint list, Web site, or subsite.
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class CustomAction : BaseModel, IProvisioningTemplateDescendant
Properties
ClientSideComponentId
Gets or sets a value for the ClientSideComponentId, if any
Declaration
public Guid ClientSideComponentId { get; set; }
Property Value
Guid
|
ClientSideComponentProperties
Gets or sets a value for the ClientSideComponentProperties, if any
Declaration
public String ClientSideComponentProperties { get; set; }
Property Value
String
|
CommandUIExtension
Declaration
public Xml.Linq.XElement CommandUIExtension { get; set; }
Property Value
System.Xml.Linq.XElement
|
Description
Gets or sets the description of the custom action.
Declaration
public string Description { get; set; }
Property Value
System.String
|
Enabled
Gets or sets the Enabled property value.
Declaration
public bool Enabled { get; set; }
Property Value
System.Boolean
|
Group
Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.
Declaration
public string Group { get; set; }
Property Value
System.String
|
ImageUrl
Gets or sets the URL of the image associated with the custom action.
Declaration
public string ImageUrl { get; set; }
Property Value
System.String
|
Location
Gets or sets the location of the custom action. A string that contains the location; for example, Microsoft.SharePoint.SiteSettings.
Declaration
public string Location { get; set; }
Property Value
System.String
|
Name
Gets or sets the name of the custom action.
Declaration
public string Name { get; set; }
Property Value
System.String
|
RegistrationId
Gets or sets the RegistrationId of the custom action.
Declaration
public string RegistrationId { get; set; }
Property Value
System.String
|
RegistrationType
Gets or sets the RegistrationType of the custom action.
Declaration
public UserCustomActionRegistrationType RegistrationType { get; set; }
Property Value
UserCustomActionRegistrationType
|
Remove
Gets or sets a value that specifies whether to Remove the CustomAction from the target
Declaration
public bool Remove { get; set; }
Property Value
System.Boolean
|
Rights
Gets or sets the value that specifies the permissions needed for the custom action.
Declaration
public BasePermissions Rights { get; set; }
Property Value
BasePermissions
|
RightsValue
Gets or sets the value that specifies the permissions needed for the custom action.
Declaration
public int RightsValue { get; set; }
Property Value
System.Int32
|
ScriptBlock
Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.
Declaration
public string ScriptBlock { get; set; }
Property Value
System.String
|
ScriptSrc
Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page
Declaration
public string ScriptSrc { get; set; }
Property Value
System.String
|
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.
Declaration
public int Sequence { get; set; }
Property Value
System.Int32
|
Title
Gets or sets the display title of the custom action.
Declaration
public string Title { get; set; }
Property Value
System.String
|
Url
Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.
Declaration
public string Url { get; set; }
Property Value
System.String
|
Methods
Equals(CustomAction)
Compares CustomAction object based on CommandUIExtension, Description, Enabled, Group, ImageUrl, Location, Name, RegistrationId, RegistrationType, Remove, Rights, ScriptBlock, ScriptSrc, Sequence, Title, Url, ClientSideComponentId, ClientSideComponentProperties, and ClientSideHostProperties properties.
Declaration
public bool Equals(CustomAction other)
Parameters
CustomAction
other
CustomAction object |
Returns
System.Boolean
true if the CustomAction object is equal to the current object; otherwise, false. |
Equals(Object)
Compares object with CustomAction
Declaration
public override bool Equals(object obj)
Parameters
System.Object
obj
Object that represents CustomAction |
Returns
System.Boolean
true if the current object is equal to the CustomAction |
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
System.Int32
Returns HashCode |