Interface IUserCustomAction

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Public interface to define a UserCustomAction object

public interface IUserCustomAction : IDataModel<IUserCustomAction>, IDataModelParent, IDataModelWithContext, ISupportModules<IUserCustomAction>, IDataModelGet<IUserCustomAction>, IDataModelLoad<IUserCustomAction>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

Inherited Members

IDataModel<IUserCustomAction>.Requested

IDataModel<IUserCustomAction>.HasValue(string)

IDataModel<IUserCustomAction>.HasChanged(string)

IDataModel<IUserCustomAction>.IsPropertyAvailable(Expression<Func<IUserCustomAction, object>>)

IDataModel<IUserCustomAction>.ArePropertiesAvailable(params Expression<Func<IUserCustomAction, object>>[])

IDataModel<IUserCustomAction>.EnsureProperties(params Expression<Func<IUserCustomAction, object>>[])

IDataModel<IUserCustomAction>.EnsurePropertiesAsync(params Expression<Func<IUserCustomAction, object>>[])

IDataModel<IUserCustomAction>.ExecuteRequestAsync(ApiRequest)

IDataModel<IUserCustomAction>.ExecuteRequest(ApiRequest)

IDataModel<IUserCustomAction>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IUserCustomAction>.ExecuteRequestBatch(ApiRequest)

IDataModel<IUserCustomAction>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IUserCustomAction>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IDataModelGet<IUserCustomAction>.GetBatchAsync(Batch, params Expression<Func<IUserCustomAction, object>>[])

IDataModelGet<IUserCustomAction>.GetAsync(params Expression<Func<IUserCustomAction, object>>[])

IDataModelLoad<IUserCustomAction>.LoadBatchAsync(Batch, params Expression<Func<IUserCustomAction, object>>[])

IDataModelLoad<IUserCustomAction>.LoadAsync(params Expression<Func<IUserCustomAction, object>>[])

IDataModelUpdate.UpdateBatchAsync()

IDataModelUpdate.UpdateBatchAsync(Batch)

IDataModelUpdate.UpdateAsync()

IDataModelUpdate.UpdateBatch()

IDataModelUpdate.UpdateBatch(Batch)

IDataModelUpdate.Update()

IDataModelDelete.DeleteBatchAsync()

IDataModelDelete.DeleteBatchAsync(Batch)

IDataModelDelete.DeleteAsync()

IDataModelDelete.DeleteBatch()

IDataModelDelete.DeleteBatch(Batch)

IDataModelDelete.Delete()

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<string, string>, Action<Dictionary<string, string>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<string, string>>)

Properties

All

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

object All { get; }

Property Value

object

ClientSideComponentId

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

Guid ClientSideComponentId { get; set; }

Property Value

Guid

ClientSideComponentProperties

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

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.

string CommandUIExtension { get; set; }

Property Value

string

Description

Gets or sets the description of the custom action.

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.

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.

string HostProperties { get; set; }

Property Value

string

Id

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

Guid Id { get; }

Property Value

Guid

ImageUrl

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

string ImageUrl { get; set; }

Property Value

string

Location

Gets or sets the location of the custom action.

string Location { get; set; }

Property Value

string

Name

Gets or sets the name of the custom action.

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.

string RegistrationId { get; set; }

Property Value

string

RegistrationType

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

UserCustomActionRegistrationType RegistrationType { get; set; }

Property Value

UserCustomActionRegistrationType

Rights

Get or sets the base permissions of the action.

IBasePermissions Rights { get; set; }

Property Value

IBasePermissions

Scope

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

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.

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.

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.

int Sequence { get; set; }

Property Value

int

Title

Gets or sets the display title of the custom action.

string Title { get; set; }

Property Value

string

Url

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

string Url { get; set; }

Property Value

string

VersionOfUserCustomAction

Returns the version of the user custom action.

string VersionOfUserCustomAction { get; }

Property Value

string