Class AddUserCustomActionOptions

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Options to specify when adding User Custom Action

public class AddUserCustomActionOptions

Inheritance

object

AddUserCustomActionOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ClientSideComponentId

Gets or sets the unique identifier of the associated client side component.

public Guid? ClientSideComponentId { get; set; }

Property Value

Guid?

ClientSideComponentProperties

Gets or sets the JSON formatted properties of the associated client side component.

public string ClientSideComponentProperties { get; set; }

Property Value

string

CommandUIExtension

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

public string CommandUIExtension { get; set; }

Property Value

string

Description

Gets or sets the description of the custom action.

public string Description { get; set; }

Property Value

string

Group

Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.

public string Group { get; set; }

Property Value

string

HostProperties

This property is only used when an application customizer is created and preallocated placeholders are specified.
It is optional. If non-empty, the string must contain a JSON object with one or two properties for the height amount needed to be preallocated.

public string HostProperties { get; set; }

Property Value

string

ImageUrl

Gets or sets the URL of the image associated with the custom action.

public string ImageUrl { get; set; }

Property Value

string

Location

Gets or sets the location of the custom action.

public string Location { get; set; }

Property Value

string

Name

Gets or sets the name of the custom action.

public string Name { get; set; }

Property Value

string

RegistrationId

Gets or sets the value that specifies the identifier of the object associated with the custom action.

public string RegistrationId { get; set; }

Property Value

string

RegistrationType

Gets or sets the value that specifies the type of object associated with the custom action.

public UserCustomActionRegistrationType? RegistrationType { get; set; }

Property Value

UserCustomActionRegistrationType?

Rights

Gets or sets the Rights for this action.

public IBasePermissions Rights { get; set; }

Property Value

IBasePermissions

ScriptBlock

Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.

public string ScriptBlock { get; set; }

Property Value

string

ScriptSrc

Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page.

public string ScriptSrc { get; set; }

Property Value

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.

public int? Sequence { get; set; }

Property Value

int?

Title

Gets or sets the display title of the custom action.

public string Title { get; set; }

Property Value

string

Url

Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.

public string Url { get; set; }

Property Value

string