dundas.PropertyDescriptor Class

Represents an object's property setting made available in the property grid.
 

Inheritance Hierarchy

 
Class
   dundas.EventDisposable
      dundas.PropertyDescriptor
         dundas.BooleanPropertyDescriptor
         dundas.BorderPropertyDescriptor
         dundas.BrushPropertyDescriptor
         dundas.CollectionPropertyDescriptor
         dundas.ComplexObjectPropertyDescriptor
         dundas.DateTimePropertyDescriptor
         dundas.DialogPropertyDescriptor
         dundas.DockLocationPropertyDescriptor
         dundas.NumericPropertyDescriptor
         dundas.OptionsPropertyDescriptor
         dundas.ScriptPropertyDescriptor
         dundas.StrokePropertyDescriptor
         dundas.TimeSpanPropertyDescriptor
 

Constructors

 
  Name Description
init Initializes the object. Called during construction.
 
 

Properties

 
  Name Description
category Gets or sets the name of the property's category.
defaultValue Gets or sets the default value for the property.
description Gets or sets the description of the property.
disabled Gets or sets the value to indicate whether or not this descriptor should be disabled.
doNotRecordHistory Gets or sets the value to indicate whether or not this descriptor should record its value history upon changes.
editor Gets or sets the editor associated with this descriptor.
editorType Gets or sets the type of the editor that should be used to edit the property.
id Gets or sets the name of the property's ID, which is a unique way to identify the property.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.EventDisposable.
isNameVisible Gets or sets a value indicating whether the property's name should be shown.
isNullable Gets or sets a value indicating whether the property supports having a value of null.
isReadOnly Gets or sets a value indicating whether the property's editor should not allow modifications.
isUnique Gets or sets a value indicating this property is unique.
name Gets the name of the property.
objectDescriptorParent Gets or sets the object descriptor that owns the property.
oldValue Gets or sets the old value.
section Gets or sets the ID of the property's section.
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.
sortKey Gets or sets the key used to determine the property's order when being sorted for display.
uiCache Gets the UI cache table Inherited from dundas.EventDisposable.
value Gets or sets the value of the property.
 
 

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.
notifyPropertyGridRenderCompleted Notify the object that owns this property that the rendering of the hosting property grid has completed and visible.
notifyPropertyValueChangeStart Notify the object that owns this property that the value is about to change.
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.