dundas.OptionsPropertyDescriptor Class

Represents an object's property setting made available in the property grid as a list of options.
 

Inheritance Hierarchy

 
Class
   dundas.EventDisposable
      dundas.PropertyDescriptor
         dundas.OptionsPropertyDescriptor
            dundas.StringPropertyDescriptor
 

Constructors

 
  Name Description
init Initializes the object. Called during construction. Inherited from dundas.PropertyDescriptor.
 
 

Properties

 
  Name Description
category Gets or sets the name of the property's category. Inherited from dundas.PropertyDescriptor.
defaultValue Gets or sets the default value for the property. Inherited from dundas.PropertyDescriptor.
description Gets or sets the description of the property. Inherited from dundas.PropertyDescriptor.
disabled Gets or sets the value to indicate whether or not this descriptor should be disabled. Inherited from dundas.PropertyDescriptor.
doNotRecordHistory Gets or sets the value to indicate whether or not this descriptor should record its value history upon changes. Inherited from dundas.PropertyDescriptor.
editor Gets or sets the editor associated with this descriptor. Inherited from dundas.PropertyDescriptor.
editorType Gets or sets the type of the editor that should be used to edit the property. Inherited from dundas.PropertyDescriptor.
enumLocalizationPrefix Gets or sets a string prefix that can be passed with a property name from the value of options into String.prototype.localize to retrieve displayed text.
hierarchy Gets or sets a value containing the hierarchy to use for the options displayed. If this is set, a hierarchy picker is used instead of a flat list. This can be left null and a regular list is displayed instead. The multi-select option will turn on / off the checkboxes for the hierarchy picker as expected. If this property is set, options and isAsyncOptions properties are ignored.
id Gets or sets the name of the property's ID, which is a unique way to identify the property. Inherited from dundas.PropertyDescriptor.
isAsyncOptions Gets or sets a value indicating whether the options need to be populated via an async call. If this is set to true, the options property must be populated with a jQuery.Promise object, and if isNullable is also true, a defaultValue should be populated.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.EventDisposable.
isMultiSelect Gets or sets a value indicating whether this is a multi-select options or not. If so, an array is expected for the value.
isNameVisible Gets or sets a value indicating whether the property's name should be shown. Inherited from dundas.PropertyDescriptor.
isNullable Gets or sets a value indicating whether the property supports having a value of null. Inherited from dundas.PropertyDescriptor.
isReadOnly Gets or sets a value indicating whether the property's editor should not allow modifications. Inherited from dundas.PropertyDescriptor.
isUnique Gets or sets a value indicating this property is unique. Inherited from dundas.PropertyDescriptor.
name Gets the name of the property. Inherited from dundas.PropertyDescriptor.
objectDescriptorParent Gets or sets the object descriptor that owns the property. Inherited from dundas.PropertyDescriptor.
oldValue Gets or sets the old value. Inherited from dundas.PropertyDescriptor.
options Gets or sets the property value options.
section Gets or sets the ID of the property's section. Inherited from dundas.PropertyDescriptor.
simpleModeCategory Gets or sets the value to slot the property correctly when it's displayed for simple property mode. More than one descriptor can be set for a category and will be set when the UI changes, however only the first one discovered will represent the value in the UI. Inherited from dundas.PropertyDescriptor.
sortKey Gets or sets the key used to determine the property's order when being sorted for display. Inherited from dundas.PropertyDescriptor.
uiCache Gets the UI cache table Inherited from dundas.EventDisposable.
value Gets or sets the value of the property. Inherited from dundas.PropertyDescriptor.
 
 

Methods

 
  Name Description
bind Bind an event to this class object. Inherited from dundas.EventDisposable.
dispose Performs tasks associated with releasing resources from this object once it is unneeded. Inherited from dundas.EventDisposable.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getDisplayedOptions Gets the final list of options, which may be generated from an enum.
getDisplayedOptionsAsync Gets the final list of options from an async deferred. Once called, getDisplayedOptions can be used instead to get the items.
notifyPropertyGridRenderCompleted Notify the object that owns this property that the rendering of the hosting property grid has completed and visible. Inherited from dundas.PropertyDescriptor.
notifyPropertyValueChangeStart Notify the object that owns this property that the value is about to change. Inherited from dundas.PropertyDescriptor.
raiseBindEvent Fire the event specified with eventName, or subscribe a handler. Inherited from dundas.EventDisposable.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.EventDisposable.
subscribeDisposed Subscribe to the disposed event. Inherited from dundas.EventDisposable.
subscribeOnce Subscribe a one time event handler for an event. Inherited from dundas.EventDisposable.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trigger Raise an event. Inherited from dundas.EventDisposable.
unbind Unsubscribe an event. if handler is specified, unsubscribe that handler. if no parameters are specified, unbind everything. Inherited from dundas.EventDisposable.
unbindAll unsubscribe all events. Inherited from dundas.EventDisposable.
updateValue Updates the property's value and raises the propertyChanged event. Inherited from dundas.PropertyDescriptor.