Interface IUserCustomAction

Public interface to define a UserCustomAction object

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IUserCustomAction : IDataModel<IUserCustomAction>, IDataModelParent, IDataModelWithContext, ISupportModules<IUserCustomAction>, IDataModelGet<IUserCustomAction>, IDataModelLoad<IUserCustomAction>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

Properties

All

A special property used to add an asterisk to a $select statement

Declaration
object All { get; }
Property Value
System.Object

ClientSideComponentId

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

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

ClientSideComponentProperties

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

Declaration
string ClientSideComponentProperties { 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
string CommandUIExtension { get; set; }
Property Value
System.String

Description

Gets or sets the description of the custom action.

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

Group

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

Declaration
string Group { get; set; }
Property Value
System.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.

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

Id

Gets a value that specifies the identifier of the custom action.

Declaration
Guid Id { get; }
Property Value
Guid

ImageUrl

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

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

Location

Gets or sets the location of the custom action.

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

Name

Gets or sets the name of the custom action.

Declaration
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
string RegistrationId { get; set; }
Property Value
System.String

RegistrationType

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

Declaration
UserCustomActionRegistrationType RegistrationType { get; set; }
Property Value
UserCustomActionRegistrationType

Rights

Get or sets the base permissions of the action.

Declaration
IBasePermissions Rights { get; set; }
Property Value
IBasePermissions

Scope

Gets a value that specifies the scope of the custom action.

Declaration
UserCustomActionScope Scope { get; }
Property Value
UserCustomActionScope

ScriptBlock

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

Declaration
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
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
int Sequence { get; set; }
Property Value
System.Int32

Title

Gets or sets the display title of the custom action.

Declaration
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
string Url { get; set; }
Property Value
System.String

VersionOfUserCustomAction

Returns the version of the user custom action.

Declaration
string VersionOfUserCustomAction { get; }
Property Value
System.String

Extension Methods