Class: ActionEventArgs
Arguments passed to the event handler.
Constructors
new ActionEventArgs()
new ActionEventArgs(
type,sender,store,args,state):ActionEventArgs
Creates arguments for the event handler.
Parameters
• type: string
the event type.
• sender: ComponentData
the component that triggered the event.
• store: Store
the form viewer settings.
• args: any[]
the event arguments.
• state: ComponentState
the ComponentState instance.
Returns
Properties
args
readonlyargs:any[]
the event arguments.
index?
readonlyoptionalindex:number
The index of the component in the array, if the component is in the array.
renderedProps
renderedProps:
Record<string,any>
The component properties that were used to render the sender component.
sender
readonlysender:ComponentData
the component that triggered the event.
store
readonlystore:Store
the form viewer settings.
type
readonlytype:string
the event type.
Accessors
data
Get Signature
get data():
Record<string,unknown>
Returns
Record<string, unknown>
the object for reading and changing form data.
event
Get Signature
get event():
null|SyntheticEvent<Element,Event>
Returns
null | SyntheticEvent<Element, Event>
the event handled by the event handler.
parentData
Get Signature
get parentData():
undefined|Record<string,unknown>
Returns
undefined | Record<string, unknown>
the object to read and modify parent data (available for array elements).
rootData
Get Signature
get rootData():
Record<string,unknown>
Returns
Record<string, unknown>
the object to read and modify root form data.
value
Get Signature
get value():
any
Returns
any
the first element of the event argument array, which is treated as a value.
Methods
setUserDefinedProps()
setUserDefinedProps(
props?):void
Sets user-defined properties for the React component that override other properties of the component.
Parameters
• props?: Record<string, any>
the component properties.
Returns
void