JsonConfEditorAttribute Class

Defines extra information for type and member declarations for use in the json configuration editor.

Definition

Constructors

JsonConfEditorAttribute Constructor with default values.

Properties

ChildName The generic name for the children of this type. If not specified, the un-namespaced child type editor name is used. Controls the default label for children (e.g. "{ChildName} [1]") and the add new button (e.g. "Add new {ChildName}").
ChildTypeEditor The name of the default/custom type editor that should be used for this value's children. If this value is set, and TypeEditor isn't, the "array" will be assumed as the TypeEditor.
ClearOnCopy When true, the value of this field is clear when creating a copying of the item in the editor.
Commentable Indicates whether the item can be commented.
DefaultValue The default value for this type/member. Only works for simple values.
DocReference A short text for the member or type so users understand it's purpose, how/when to use it, etc... May be displayed as a tool tip or in other context specific places.
ExtendsEditor The name of the type editor that should be extended for this value.
ForceChildLeafBehavior If set to true, forces the child items of an array in the configurators navigation tree (not the grid) to be rendered as a leaf node, preventing their children from being shown in the tree. This option has no effect on an item that would already classify as a leaf.
ForceLeafBehavior If set to true, forces an item in the configurators navigation tree (not the grid) to be rendered as a leaf node, preventing the items children from being shown in the tree. This option has no effect on an item that would already classify as a leaf.
HelpText A short text for the member or type so users understand it's purpose, how/when to use it, etc... May be displayed as a tool tip or in other context specific places.
HelpTextResourceId Same as the help text but a localizable resource id instead of hard coded text. Both can be specified but the resource based text is used in the first place.
Hidden Used to prevent a value/key from appearing in the editor. If specified on an object (complex type), none of it's children will be visible.
HideWhen Visibility condition. Via JSPath. When true, the value is hidden in the Editor. Example: HideWhen = ".SiblingProperty == 'Test' " HideWhen = ".SiblingProperty{.NestedProperty == 'Test'} "
IsRequired Validation option. If this is set to true, and no value is specified, a validation message will be shown to the user.
Label The human readable name to show for this value. If not specified, the member or type name will be shown.
NameMember The member whose value can be used as a unique name for an instance of the type. Useful when displaying objects in a list (array).
Options Additional options to pass to the editor. Specified in json.
RegExMask When provided, the regular expression mask will be enforced as a validation requirement.
ResourceIdPrefix Prefix that can be pre-pended to resource id strings in localizable string properties.
ShowWhen Visibility condition. Via JSPath. When true, the value is shown in the Editor. Example: ShowWhen = ".SiblingProperty == 'Test' " ShowWhen = ".SiblingProperty{.NestedProperty == 'Test'} "
TypeEditor The name of the default/custom type editor that should be used for this value. If not specified the system will choose the editor based on the type, and may generate an editor dynamically.
UseNonPublicMembers  
UsesAdapter Used in conjunction with an editor that is tagged as "IsAdapter = True". Members where the UsesAdapter = True / The items editor has IsAdapter = True are piped through the adapter for updates.
ValueMember If a simple value can be directly cast to this type, this is the member of the type that the value will be set to.

Methods

GetOptions Gets the custom options defined by this attribute.
HasAttr Allows for simple checking of a key within the options expando objects.
HasOptions Determines if this attribute defines custom options.

See Also