API Reference > ui-abstract > Dialog > DialogLayoutDataProvider DialogLayoutDataProvider Class DialogLayoutDataProvider Abstract class that allows property values to be passed between hosting API and Dialog that generates and arranges components dynamically including the buttons at the bottom of the dialog. Extends UiLayoutDataProvider Methods Name Description constructor(): DialogLayoutDataProvider fireDialogButtonsReloadEvent(): void Called to inform listeners that modal dialog button data needs to be refreshed. supplyButtonData(): undefined | DialogButtonDef[] Inherited methods Name Inherited from Description applyUiPropertyChange(_updatedValue: DialogPropertySyncItem): void UiLayoutDataProvider Applies change of a single property - this is the default method used when property editors are dynamically generated. fireItemsReloadedEvent(): void UiLayoutDataProvider Called to inform listeners that new properties are ready for display in UI. fireSyncPropertiesEvent(syncProperties: DialogPropertySyncItem[]): void UiLayoutDataProvider Called to inform listener that the UiDataProvider has updated values for the UI loadItemsInternal(items: undefined | ): void Protected UiLayoutDataProvider processChangesInUi(properties: DialogPropertyItem[]): PropertyChangeResult UiLayoutDataProvider Applies changes from one or more properties - some dialogs will use this to send a bulk set of changes back to the provider reloadDialogItems(emitEvent: boolean = true): void UiLayoutDataProvider Called to inform listeners that new properties are ready for display in UI. supplyAvailableProperties(): DialogPropertyItem[] UiLayoutDataProvider Used to pass properties between a tool and an explicity defined UI dialog. supplyDialogItems(): undefined | DialogItem[] UiLayoutDataProvider Called by UI to request available properties that can be bound to user supplied UI components (See Tool1UiProvider for example). syncProperties(syncProperties: DialogPropertySyncItem[]): void UiLayoutDataProvider Called to sync properties synchronously if a UiDataProvider is active for the UI validateProperty(_item: DialogPropertyItem): PropertyChangeResult UiLayoutDataProvider Called by UI to validate a property value editorWantsLabel(item: DialogItem): boolean Static UiLayoutDataProvider Determines if a dialog item editor wants a label getItemDisabledState(baseDialogItem: BaseDialogItem): boolean Static UiLayoutDataProvider Gets the disabled state for a given dialog item getPropertyRecord(dialogItem: BaseDialogItem): PropertyRecord Static UiLayoutDataProvider Gets a property record for a given dialog item hasAssociatedLockProperty(item: DialogItem): boolean Static UiLayoutDataProvider Determines if a dialog items has an associated lock property onlyContainButtonGroupEditors(row: DialogRow): boolean Static UiLayoutDataProvider Determines if a dialog row only contains button group editors Properties Name Type Description onButtonsReloadedEvent BeUiEvent<void> Inherited properties Name Type Inherited from Description items Accessor ReadOnly undefined UiLayoutDataProvider onItemsReloadedEvent BeUiEvent<void> UiLayoutDataProvider onSyncPropertiesChangeEvent SyncPropertiesChangeEvent UiLayoutDataProvider Get Sync UI Control Properties Event rows Accessor ReadOnly DialogRow[] UiLayoutDataProvider Array of dialog rows Defined in ui/abstract/src/ui-abstract/dialogs/UiLayoutDataProvider.ts Line 197 Last Updated: 12 June, 2024