DialogProperty<T> Class

DialogProperty is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).

Methods

Name Description
constructor<T>(description: PropertyDescription, _value: T, _displayValue?: string, _isDisabled?: boolean): DialogProperty<T>    
toDialogItem(editorPosition: EditorPosition, lockProperty?: DialogItem): DialogItem    

Properties

Name Type Description
description PropertyDescription    
dialogItemValue Accessor DialogItemValue    
dialogItemValue Setter dialogItemValue(val: DialogItemValue): void    
displayValue Accessor undefined | string    
displayValue Setter displayValue(val: string): void    
isDisabled Accessor boolean    
isDisabled Setter isDisabled(val: boolean): void    
item Accessor ReadOnly DialogPropertyItem    
name Accessor ReadOnly string    
syncItem Accessor ReadOnly DialogPropertySyncItem    
value Accessor T    
value Setter value(val: T): void    

Defined in

Last Updated: 29 April, 2025