Click or drag to resize

GHAPropertyAttribute Class

[This is preliminary documentation and is subject to change.]

Defines the behavior of properties of an IGHAObject
Inheritance Hierarchy
SystemObject
  SystemAttribute
    GHASchema.AttributesGHAPropertyAttribute

Namespace:  GHASchema.Attributes
Assembly:  GHASchema (in GHASchema.dll) Version: 1.1.8074.31450 (1.0.0.0)
Syntax
C#
Copy
[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple = false, 
	Inherited = true)]
public class GHAPropertyAttribute : Attribute

The GHAPropertyAttribute type exposes the following members.

Constructors
  NameDescription
Public methodGHAPropertyAttribute
Adds specific attributes to GHA Properties for handling by consuming objects
Top
Properties
  NameDescription
Public propertyAggregation
Defines the method used by parent objects to aggregate the property from children
Public propertyDescription
Text stating the purpose of the property
Public propertyFilter
Provides a filter for object searches. The format is search-root|.NET class (e.g. Filter = "gha://gharoot/Devices|GHASchema.Classes.Capabilities.InputOutput.IInfraredOutput"
Public propertyIsBindable
Property may be used as a binding point
Public propertyIsBrowsable
Public propertyIsDebugVisible
Safe to show this property when in debug mode. Some properties are not able to be serialized so use with caution
Public propertyIsEnumeration
Tells GHA that this property is an enumeration
Public propertyIsMomentary
Applies to boolean values. Property resets to false automatically.
Public propertyIsReadonly
Property should not be changed by GUI's
Public propertyIsRequired
Public propertyIsSaveOnChange
Instructs GHA to save it's current state when the property is changed Use sparingly. This is not intended to be used on properties that change frequently The default is false
Public propertyIsSortKey
Tells GHA that this property is the sort selection property for the parent class The name of a propery of the children of the parent class will go here. The property with this tag, must be a string
Public propertyIsVisible
Determines if the property is visible to UI's
Public propertySpecialHandling
An application-specific field that can be used tag the property for special handling (i.e. GUI rendering a specific control to display the property)
Top
See Also