Class AddUserCustomActionOptions
Options to specify when adding User Custom Action
Inheritance
System.Object
AddUserCustomActionOptions
Assembly: PnP.Core.dll
Syntax
public class AddUserCustomActionOptions : object
Properties
Gets or sets the unique identifier of the associated client side component.
Declaration
public Guid? ClientSideComponentId { get; set; }
Property Value
Gets or sets the JSON formatted properties of the associated client side component.
Declaration
public string ClientSideComponentProperties { get; set; }
Property Value
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
Gets or sets the description of the custom action.
Declaration
public string Description { get; set; }
Property Value
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
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.
Declaration
public string HostProperties { get; set; }
Property Value
Gets or sets the URL of the image associated with the custom action.
Declaration
public string ImageUrl { get; set; }
Property Value
Gets or sets the location of the custom action.
Declaration
public string Location { get; set; }
Property Value
Gets or sets the name of the custom action.
Declaration
public string Name { get; set; }
Property Value
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
Gets or sets the value that specifies the type of object associated with the custom action.
Declaration
public UserCustomActionRegistrationType? RegistrationType { get; set; }
Property Value
Gets or sets the Rights for this action.
Declaration
public IBasePermissions Rights { get; set; }
Property Value
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
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
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.Nullable<System.Int32>
|
Gets or sets the display title of the custom action.
Declaration
public string Title { get; set; }
Property Value
Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.
Declaration
public string Url { get; set; }
Property Value