UA Bundle SDK .NET  2.2.1.258
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.ModelPropertyDescriptor Class Reference

A custom descriptor for a property for types used with reflection. More...

Inherits PropertyDescriptor.

Public Member Functions

override void AddValueChanged (object component, EventHandler handler)
 Enables other objects to be notified when this property changes. More...
 
override bool CanResetValue (object component)
 When overridden in a derived class, returns whether resetting an object changes its value. More...
 
override bool Equals (object obj)
 Determines whether the specified System.Object is equal to this instance. More...
 
override
PropertyDescriptorCollection 
GetChildProperties (object instance, Attribute[] filter)
 Returns a T:System.ComponentModel.PropertyDescriptorCollection for a given object using a specified array of attributes as a filter. More...
 
override object GetEditor (Type editorBaseType)
 Gets an editor of the specified type. More...
 
override int GetHashCode ()
 Returns a hash code for this instance. More...
 
override object GetValue (object component)
 When overridden in a derived class, gets the current value of the property on a component. More...
 
override void RemoveValueChanged (object component, EventHandler handler)
 Enables other objects to be notified when this property changes. More...
 
override void ResetValue (object component)
 When overridden in a derived class, resets the value for this property of the component to the default value. More...
 
override void SetValue (object component, object value)
 When overridden in a derived class, sets the value of the component to a different value. More...
 
override bool ShouldSerializeValue (object component)
 When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 

Protected Member Functions

 ModelPropertyDescriptor (PropertyDescriptor root)
 Initializes a new instance of the ModelPropertyDescriptor class. More...
 

Properties

override AttributeCollection Attributes [get]
 Gets the collection of attributes for this member. More...
 
override string Category [get]
 Gets the name of the category to which the member belongs, as specified in the T:System.ComponentModel.CategoryAttribute. More...
 
override Type ComponentType [get]
 When overridden in a derived class, gets the type of the component this property is bound to. More...
 
override TypeConverter Converter [get]
 Gets the type converter for this property. More...
 
override string Description [get]
 Gets the description of the member, as specified in the T:System.ComponentModel.DescriptionAttribute. More...
 
override bool DesignTimeOnly [get]
 Gets whether this member should be set only at design time, as specified in the T:System.ComponentModel.DesignOnlyAttribute. More...
 
override string DisplayName [get]
 Gets the name that can be displayed in a window, such as a Properties window. More...
 
override bool IsBrowsable [get]
 Gets a value indicating whether the member is browsable, as specified in the T:System.ComponentModel.BrowsableAttribute. More...
 
override bool IsLocalizable [get]
 Gets a value indicating whether this property should be localized, as specified in the T:System.ComponentModel.LocalizableAttribute. More...
 
override bool IsReadOnly [get]
 When overridden in a derived class, gets a value indicating whether this property is read-only. More...
 
override string Name [get]
 Gets the name of the member. More...
 
override Type PropertyType [get]
 When overridden in a derived class, gets the type of the property. More...
 
override bool SupportsChangeEvents [get]
 Gets a value indicating whether value change notifications for this property may originate from outside the property descriptor. More...
 
PropertyDescriptor Root [get]
 Gets the root. More...
 

Detailed Description

A custom descriptor for a property for types used with reflection.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ModelPropertyDescriptor.ModelPropertyDescriptor ( PropertyDescriptor  root)
inlineprotected

Initializes a new instance of the ModelPropertyDescriptor class.

Parameters
rootThe root.

Member Function Documentation

override void UnifiedAutomation.UaBase.ModelPropertyDescriptor.AddValueChanged ( object  component,
EventHandler  handler 
)
inline

Enables other objects to be notified when this property changes.

Parameters
componentThe component to add the handler for.
handlerThe delegate to add as a listener.
Exceptions
T:System.ArgumentNullExceptioncomponent or handler is null.
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.CanResetValue ( object  component)
inline

When overridden in a derived class, returns whether resetting an object changes its value.

Parameters
componentThe component to test for reset capability.
Returns
true if resetting the component changes its value; otherwise, false.
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.Equals ( object  obj)
inline

Determines whether the specified System.Object is equal to this instance.

Parameters
objThe System.Object to compare with this instance.
Returns
true if the specified System.Object is equal to this instance; otherwise, false.
override PropertyDescriptorCollection UnifiedAutomation.UaBase.ModelPropertyDescriptor.GetChildProperties ( object  instance,
Attribute[]  filter 
)
inline

Returns a T:System.ComponentModel.PropertyDescriptorCollection for a given object using a specified array of attributes as a filter.

Parameters
instanceA component to get the properties for.
filterAn array of type T:System.Attribute to use as a filter.
Returns
A T:System.ComponentModel.PropertyDescriptorCollection with the properties that match the specified attributes for the specified component.
override object UnifiedAutomation.UaBase.ModelPropertyDescriptor.GetEditor ( Type  editorBaseType)
inline

Gets an editor of the specified type.

Parameters
editorBaseTypeThe base type of editor, which is used to differentiate between multiple editors that a property supports.
Returns
An instance of the requested editor type, or null if an editor cannot be found.
override int UnifiedAutomation.UaBase.ModelPropertyDescriptor.GetHashCode ( )
inline

Returns a hash code for this instance.

Returns
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
override object UnifiedAutomation.UaBase.ModelPropertyDescriptor.GetValue ( object  component)
inline

When overridden in a derived class, gets the current value of the property on a component.

Parameters
componentThe component with the property for which to retrieve the value.
Returns
The value of a property for a given component.
override void UnifiedAutomation.UaBase.ModelPropertyDescriptor.RemoveValueChanged ( object  component,
EventHandler  handler 
)
inline

Enables other objects to be notified when this property changes.

Parameters
componentThe component to remove the handler for.
handlerThe delegate to remove as a listener.
Exceptions
T:System.ArgumentNullExceptioncomponent or handler is null.
override void UnifiedAutomation.UaBase.ModelPropertyDescriptor.ResetValue ( object  component)
inline

When overridden in a derived class, resets the value for this property of the component to the default value.

Parameters
componentThe component with the property value that is to be reset to the default value.
override void UnifiedAutomation.UaBase.ModelPropertyDescriptor.SetValue ( object  component,
object  value 
)
inline

When overridden in a derived class, sets the value of the component to a different value.

Parameters
componentThe component with the property value that is to be set.
valueThe new value.
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.ShouldSerializeValue ( object  component)
inline

When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.

Parameters
componentThe component with the property to be examined for persistence.
Returns
true if the property should be persisted; otherwise, false.
override string UnifiedAutomation.UaBase.ModelPropertyDescriptor.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Property Documentation

override AttributeCollection UnifiedAutomation.UaBase.ModelPropertyDescriptor.Attributes
get

Gets the collection of attributes for this member.

Returns
An T:System.ComponentModel.AttributeCollection that provides the attributes for this member, or an empty collection if there are no attributes in the P:System.ComponentModel.MemberDescriptor.AttributeArray.
override string UnifiedAutomation.UaBase.ModelPropertyDescriptor.Category
get

Gets the name of the category to which the member belongs, as specified in the T:System.ComponentModel.CategoryAttribute.

Returns
The name of the category to which the member belongs. If there is no T:System.ComponentModel.CategoryAttribute, the category name is set to the default category, Misc.
override Type UnifiedAutomation.UaBase.ModelPropertyDescriptor.ComponentType
get

When overridden in a derived class, gets the type of the component this property is bound to.

Returns
A T:System.Type that represents the type of component this property is bound to. When the M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object) or M:System.ComponentModel.PropertyDescriptor.SetValue(System.Object,System.Object) methods are invoked, the object specified might be an instance of this type.
override TypeConverter UnifiedAutomation.UaBase.ModelPropertyDescriptor.Converter
get

Gets the type converter for this property.

Returns
A T:System.ComponentModel.TypeConverter that is used to convert the T:System.Type of this property.
override string UnifiedAutomation.UaBase.ModelPropertyDescriptor.Description
get

Gets the description of the member, as specified in the T:System.ComponentModel.DescriptionAttribute.

Returns
The description of the member. If there is no T:System.ComponentModel.DescriptionAttribute, the property value is set to the default, which is an empty string ("").
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.DesignTimeOnly
get

Gets whether this member should be set only at design time, as specified in the T:System.ComponentModel.DesignOnlyAttribute.

Returns
true if this member should be set only at design time; false if the member can be set during run time.
override string UnifiedAutomation.UaBase.ModelPropertyDescriptor.DisplayName
get

Gets the name that can be displayed in a window, such as a Properties window.

Returns
The name to display for the member.
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.IsBrowsable
get

Gets a value indicating whether the member is browsable, as specified in the T:System.ComponentModel.BrowsableAttribute.

Returns
true if the member is browsable; otherwise, false. If there is no T:System.ComponentModel.BrowsableAttribute, the property value is set to the default, which is true.
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.IsLocalizable
get

Gets a value indicating whether this property should be localized, as specified in the T:System.ComponentModel.LocalizableAttribute.

Returns
true if the member is marked with the T:System.ComponentModel.LocalizableAttribute set to true; otherwise, false.
override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.IsReadOnly
get

When overridden in a derived class, gets a value indicating whether this property is read-only.

Returns
true if the property is read-only; otherwise, false.
override string UnifiedAutomation.UaBase.ModelPropertyDescriptor.Name
get

Gets the name of the member.

Returns
The name of the member.
override Type UnifiedAutomation.UaBase.ModelPropertyDescriptor.PropertyType
get

When overridden in a derived class, gets the type of the property.

Returns
A T:System.Type that represents the type of the property.
PropertyDescriptor UnifiedAutomation.UaBase.ModelPropertyDescriptor.Root
getprotected

Gets the root.

override bool UnifiedAutomation.UaBase.ModelPropertyDescriptor.SupportsChangeEvents
get

Gets a value indicating whether value change notifications for this property may originate from outside the property descriptor.

Returns
true if value change notifications may originate from outside the property descriptor; otherwise, false.

The documentation for this class was generated from the following file: