FormCustomizerContext class

Form Customizer Context. This object contains contextual services and properties for the form.

Extends

Constructors

(constructor)(extensionContextParameters, formCustomizerContextParameters)

Constructs a new instance of the FormCustomizerContext class

Properties

contentType

The content type associated with the form.

domElement

The root DOM element of the form. This is a DIV element container for the custom form.

folderInfo

The folder information where the item is located/should be created.

item

The item data of the item being edited or viewed.

itemId

The item id of the item being edited or viewed.

list

The list associated with the form.

Constructor Details

(constructor)(extensionContextParameters, formCustomizerContextParameters)

Constructs a new instance of the FormCustomizerContext class

constructor(extensionContextParameters: _IExtensionContextParameters, formCustomizerContextParameters: IFormCustomizerContextParameters);

Parameters

extensionContextParameters
@microsoft/sp-extension-base!_IExtensionContextParameters:interface
formCustomizerContextParameters
@microsoft/sp-listview-extensibility!_IFormCustomizerContextParameters:interface

Property Details

contentType

The content type associated with the form.

get contentType(): IContentType;

Property Value

domElement

The root DOM element of the form. This is a DIV element container for the custom form.

get domElement(): HTMLElement;

Property Value

HTMLElement

folderInfo

The folder information where the item is located/should be created.

get folderInfo(): IFolderInfo;

Property Value

item

The item data of the item being edited or viewed.

get item(): IListItem | undefined;

Property Value

IListItem | undefined

itemId

The item id of the item being edited or viewed.

get itemId(): number | undefined;

Property Value

number | undefined

list

The list associated with the form.

get list(): IList;

Property Value