IFieldCustomizerCellEventParameters interface

Package:

@microsoft/sp-listview-extensibility

Event parameters for BaseFieldCustomizer.onRenderCell()

Properties

domElement	The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called.
fieldValue	The value of the field being rendered.
listItem	The list item being edited.
userData	An implementation defined storage property.

Property Details

domElement

The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called.

readonly domElement: HTMLDivElement;

Property Value

HTMLDivElement

fieldValue

The value of the field being rendered.

readonly fieldValue: any;

Property Value

any

listItem

The list item being edited.

readonly listItem: ListItemAccessor;

Property Value

ListItemAccessor

userData

An implementation defined storage property.

userData: any;

Property Value

any

Remarks

For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed.