Class CustomActionEntity

CustomActionEntity class describes the information for a Custom Action

Inheritance
System.Object
CustomActionEntity
Namespace: PnP.Framework.Entities
Assembly: PnP.Framework.dll
Syntax
public class CustomActionEntity : object

Properties

ClientSideComponentId

Gets or sets the client side component id. Only applies to custom actions which are added to SharePoint Online.

Declaration
public Guid ClientSideComponentId { get; set; }
Property Value
Guid

ClientSideComponentProperties

Gets or sets the client side component properties. Only applies to custom actions which are added to SharePoint Online.

Declaration
public string ClientSideComponentProperties { get; set; }
Property Value
System.String

ClientSideHostProperties

Gets or sets the client side host properties. Only applies to custom actions which are added to SharePoint Online.

Declaration
public string ClientSideHostProperties { get; set; }
Property Value
System.String

CommandUIExtension

Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action

Declaration
public string CommandUIExtension { get; set; }
Property Value
System.String

Description

Description of the custom action

Declaration
public string Description { get; set; }
Property Value
System.String

Group

The group of this custom action

Declaration
public string Group { get; set; }
Property Value
System.String

ImageUrl

The URL to the image used for this custom action

Declaration
public string ImageUrl { get; set; }
Property Value
System.String

Location

Custom action location (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 value that specifies the identifier of the object associated with the custom action.

Declaration
public string RegistrationId { get; set; }
Property Value
System.String

RegistrationType

Specifies the type of object associated with the custom action. A Nullable Type

Declaration
public UserCustomActionRegistrationType? RegistrationType { get; set; }
Property Value
System.Nullable<UserCustomActionRegistrationType>

Remove

Indicates if the custom action will need to be removed

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

ScriptBlock

The JavaScript to be executed by this custom action

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

The sequence number of this custom action

Declaration
public int Sequence { get; set; }
Property Value
System.Int32

Title

Custom action title

Declaration
public string Title { get; set; }
Property Value
System.String

Url

The URL this custom action should navigate the user to

Declaration
public string Url { get; set; }
Property Value
System.String

Extension Methods