dashboard : IDashboard [ in ]

The main shellUI object.

callbacks : Object [ in ]

Contains callback methods for the dashboard.

onInitialize Method [ optional ]

Called when the dashboard has been initialized. You can use functions of environment object after this call.

environment : DashboardEnv [ in ]

The dashboard environment object.

onEnableControls Method [ optional ]

Called when the control buttons (i.e. save and close buttons) are enabled.

onDisableControls Method [ optional ]

Called when the control buttons (i.e. save and close buttons) are disabled.

onSave Method [ optional ]

Called when the user has clicked the save button.

objectVersionAndProperties : IObjectVersionAndProperties [ in ]

Contains the object and its original property values. Null if there is no original object.

propertyValues : IPropertyValues [ in ]

Contains the current property values.

Return Type

Boolean; false cancel the saving operation.

onClose Method [ optional ]

Called when the user has clicked Close button.

Return Type

Boolean; false cancel the closing operation.

onEdit Method [ optional ]

Called when user starts to edit a property value.

Return Type

Boolean; false prevent the editing.

onPropertyValueChange Method [ optional ]

Called when the user is finishing the editing of an individual control.

propertyValue : IPropertyValue [ in ]

The new propery value.

Return Type

Boolean; false prevent the change.

onUpdateDashboard Method [ optional ]

Called when the dashboard is about to update, possibly due changed selection or changed metadata.

objectVersionAndProperties : IObjectVersionAndProperties [ in ]

Contains the new object and its property values.