IGHARemotePropertyDescriptor Interface |
Provides info on IGHAObject properties
Namespace: RemoteRESTLib
Assembly: GHARemoteRESTLib (in GHARemoteRESTLib.dll) Version: 1.0.14
SyntaxThe IGHARemotePropertyDescriptor type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Aggregation |
Determines how the property is being aggregated (if any) up the GHA Hierarchy
|
| DeclaringType |
The class the defined the property
|
| Description |
Description of the property
|
| Filter |
Provides a filter for object searches.
The format is search-root|.NET class (e.g. Filter = "gha://gharoot/Devices|GHASchema.Classes.Capabilities.InputOutput.IInfraredOutput"
|
| IsBindable |
Determines if the property may be bound
|
| IsBrowsable |
Determines if the property can be displayed in a class property grid
|
| IsDebugVisible |
Determines if the property is to be displayed in a debugging mode regardless of the IsVisible setting
|
| IsEnumerataion |
Tags the property as an enumeration. Should be used to map GHA-defined enumerations into local enumerations for the consuming
application
|
| IsMomentary |
Determines if the property's value is persistent or momentary. Currently supported for Boolean values
Typical use case is to initiate an action by setting the property to true, and having GHA automatically reset the
property to false after a few seconds
|
| IsReadonly |
Determine if the consuming application should display the property
|
| IsRequired |
Determines if the property value is required
|
| IsSaveOnChange |
When set to true, changing this property triggers an immediate saving of the GHA Hierarchy. Normally, the saving
is scheduled to occur periodically. Use sparingly, as this is an expensive transaction
|
| IsVisible |
Determines if the UI should display the property
|
| PropertyName |
Name of the property
|
| PropertyType |
The type of the property value
|
| SpecialHandling |
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)
Currently supported commands include:
slider:[min]/[max] - defines that the property should be managed by a slider control with the specified minimum/maximum
crontab - defines that the property is a crontab value and potentially be handled with a crontab editor
mqttmap - defines that the property is an mqtt map and potentially should be handled with an mqtt mapping editor
multiline - defines tha the property should be rendered with a multiline text control
classbrowser - defines that the property should use a GHA Class browser to select a GHA class
These are currently defined in GHA, but custom drivers and modules may define their own special handling commands
|
See Also