FieldCustomizerContext class

This object provides contextual information for BaseFieldCustomizer.

Extends

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FieldCustomizerContext class.

Properties

field

Provides access to the SharePoint field that the customizer will operate on.

Methods

tryGetListView()

If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined.

Property Details

field

Provides access to the SharePoint field that the customizer will operate on.

get field(): SPField;

Property Value

Method Details

tryGetListView()

If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined.

tryGetListView(): ListViewAccessor | undefined;

Returns

ListViewAccessor | undefined

the SharePoint list view, or undefined if there is none.

Remarks

Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form.