GXDN: Gurux Developer Network
GXProperty Class
NamespacesGurux.DeviceGXProperty
The GXProperty component implements the GXProperty interface, which represents a property of a physical device. GXProperty components can be queried from a GXDevice object.
Members
All Members Constructors Methods Properties Events



Icon Member Description
GXProperty()()()
Initializes a new instance of the GXProperty class

AcceptChanges()()()
Commits all the changes made to this IGXProperties collection since it was loaded or since the last time AcceptChanges was called.

AccessMode
AccessMode determines access mode, for example, read or read-write for the GXProperty.

AccessType
AccessType determines access type (mandatory/optional/etc.) for the GXProperty.

AutoNotifyPropertyChange
AutoNotifyPropertyChange automatically notifies the GXDevice, if a value or state of the GXProperty changes.

AvailableDisplayTypes
AvailableDisplayTypes determines types, in which the value can be shown.

BeginUpdate()()()
BeginUpdate maintains performance, when content is updated. Suspends sending of notifications until EndUpdate is called.

BitMask
BitMask determines, if the property value is handled as a bit mask.

Category
Category is the category, where GXProperty instance is located. Categories are used to group properties.

Clear()()()
Clear clears the GXProperty.

Clone()()()
Creates a new object that is a copy of the current instance.
(Inherited from GXObject.)
Copy(Object)
The Copy method copies object content from the target object.
(Inherited from GXObject.)
DecimalPlaces
A number of digits to the right of the decimal separator.

Description
Description is a textual description of the GXProperty object.

Device
GXDevice is the device that contains the GXProperty instance.

DeviceValueFormula
DeviceValueFormula converts a UI value to a device value.

DeviceValueValidationFormula
ValidateDeviceValueFormula retrieves or sets the formula that is used to validate device value.

DisabledActions
Determines which actions are blocked from use.

DisableFormulas
DisableFormulas disables UIValueFormula, DeviceValueFormula, ValidateDeviceValueFormula and ValidateUIValueFormula.

DisconnectDeviceOnReadFailure
DisconnectDeviceOnReadFailure determines, if the device should be disconnected, when a property read fails.

DisconnectDeviceOnWriteFailure
DisconnectDeviceOnWriteFailure determines, if the device should be disconnected, when a property write fails.

DisplayName
DisplayName is a localized name for the GXProperty.

DisplayType
DisplayType property informs how to present numeric values. If DisplayType is not found in AvailableDisplayTypes, property does not support the type and it is not set. The attempt to set an unavailable display type as DisplayType is ignored, and the type stays as is.

Dispose(Boolean) (Overrides GXObject.Dispose(Boolean).)
Dispose()()() (Inherited from GXObject.)
Dynamic
Dynamic determines, if the property is created dynamically using CreateProperty method of the device.

EndUpdate()()()
EndUpdate notifies that the property group content has changed. Resumes sending of notifications.

Equals(Object)
Determines whether two objects are equal.
(Overrides GXObject.Equals(Object).)
ErrorDescription
ErrorDescription describes the occurred error.

ErrorSeverityLevel
ErrorSeverityLevel determines the severity level of an error.

Finalize()()() (Inherited from GXObject.)
FindByParameter(String, Object)
Returns collection of objects that match search parameters.
(Inherited from GXObject.)
ForcePresetValues
ForcePresetValues sets that value must be set to one of the GXValueCollection or an error event is raised. ErrorSeverityLevel is -1, and ErrorDescription is "Undefined value".

GetChanges()()()
Gets a copy of the IGXProperties collection that contains all changes made to it since it was loaded or since AcceptChanges() was last called.

GetControls()()()
Returns a collection of controls that use this component.
(Inherited from GXObject.)
GetDefaultValue(Boolean)
DefaultValue is the default value of a GXProperty.

GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetMaximum(Boolean)
Gets the maximum value of a GXProperty.

GetMinimum(Boolean)
Gets the minimum value of a GXProperty.

GetOcx()()()
Retrieves a reference to the underlying ActiveX control.
(Inherited from GXObject.)
GetStatistic(PropertyStatistic)
Gets statistic value of determined type.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
GetValue(VariantType, Boolean)
GetValue returns the value of a GXProperty instance.

GXObjectType
Sender object type. Reserved for inner use. Do Not Use!
(Inherited from GXObject.)
Hidden
Hidden determines visibility of the GXProperty in the user interface.

ID
Object Identifier.
(Inherited from GXObject.)
InitialAction
InitialAction determines what is done, when device is added, removed, connected or disconnected.

IsCommand
IsCommand determines, if the property is handled as a command.

IsKeepAliveMessage
Determines, if the property is a Keep Alive message.

IsNotify
IsNotify is the location type of a GXProperty. This is set to True, if the GXProperty is a notification and therefore is in the notifies collection.

IsTypeNumeric
Determines, whether the property type is numeric or not.

LocalizedNames
LocalizedNames is the collection containing all localized names of the GXProperty.

LocalizedValueItems
LocalizedValueItems is the collection of localized value items.

LogItems
Retrieves a listing of log items (timestamped actions) of the GXProperty.

Mask
A pattern for all data to be entered.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name (Overrides GXObject.Name.)
NotifyPropertyChange(Int32, PropertyStates)
NotifyPropertyChange informs software of changes in the GXProperty.

OnDisplayTypeChanged
Notifies, when the display type has changed.

OnPropertyChanged
Notifies, when the state and/or value of a GXProperty has changed.

Parameters
Parameters is the collection of GXParameterCollection, which are used as attached data storage items.

Parent
Parent is a parent properties collection.

ReadDependencies
ReadDependencies is collection of properties that this property is dependent of.

ReadExpiration
ReadExpiration determines the minimum time (in ms) between read transactions of the GXProperty.

ReadOffset
Determines the position of the wanted value in the register. Counted in bits, from the beginning of the register to the start of the wanted value.

ReadOrder
Individual order number of the property. Determines the order, in which the properties are read.

ReadSize
ReadSize is the bit or byte count to be read.

ReadTime
ReadTime is the time, when GXProperty was last read.

RejectChanges()()()
Rolls back all the changes made to the IGXProperties collection since it was created, or since the last time AcceptChanges was called.

ResetErrors()()()
ResetErrors resets all errors of the GXProperty.

ResetLastReadValue()()()
ResetLastReadValue resets the value to last read value. If the value has not been read before, then default value is set.

ResetStatistic(PropertyStatistic)
Reset statistic value of determined type.

Rows
Rows is the collection of row items of a GXProperty that is in a table.

SetDefaultValue(Object, Boolean)
Sets default value for the property.

SetError(String, Int32)
SetError sets an error state to a GXProperty.

SetMaximum(Object, Boolean)
Sets maximum value for the property.

SetMinimum(Object, Boolean)
Sets minimum value for the property.

SetToDefault()()()
SetToDefault resets the value to the default value. Notify is made with ValueReset (GX_PROPERTY_STATE_VALUE_RESET) value.

SetValue(Object, VariantType, Boolean, PropertyStates)
SetValue sets the value of a GXProperty. If ValueItems are used, the value must be in the ValueItems collection and the Type must be String (GX_VT_STR).

SourceProperty
SourceProperty is a parent property; a register, that includes more than one property value. To read or write a single property value inside the parent property, the offset and the size of the value data must be determined.

StatisticAverage(Boolean)
StatisticAverage is an average of values received after last statistic reset.

StatisticMaximum(Boolean)
StatisticMaximum is the highest value since the last statistic reset.

StatisticMinimum(Boolean)
StatisticMinimum is the lowest value since the last statistic reset.

StatisticReset(Int32)
StatisticReset resets all statistic values of the GXProperty.

Status
Status is the status of the GXProperty object.

Storable
Storable determines, if the parameter is storable.

SwapData
Determines if property data is swapped, when moving between device and UI.

Table
Table is the table where the GXProperty is positioned. If the GXProperty is not in a table, NULL is returned.

ToString()()()
ToString returns a string that represents the current object.
(Inherited from GXObject.)
TransactionDelay
TransactionDelay is the minimum time, in ms, between transactions. This value is used to decrease traffic after a process that takes a long time. Default value -1 indicates that the transaction delay of the device is used.

TreatAsError
TreatAsError determines, if the values of the GXProperty are treated as errors.

Type
Type is the data type of the GXProperty object.

UIType
UIType determines the data type, in which data is shown on the UI.

UIValueFormula
UIValueFormula converts a device value to a UI value.

UIValueValidatationFormula
ValidateUIValueFormula retrieves or sets the formula that is used to validate UI value.

Unit
Unit is the unit of the GXProperty object.

UpdateStatisticValue(PropertyStatistic, Object)
A statistic value, retrieved from the physical device, can be set to replace the current statistic value of a property.

ValueItems
ValueItems is the collection containing all preset values of the GXProperty.

ValueStatus
Reserved for inner use. Do not use!

WriteDependencies
WriteDependencies is collection of properties that this property is dependent of.

WriteExpiration
WriteExpiration determines the minimum time (in ms) between write transactions of the GXProperty.

WriteOffset
Determines the position of the wanted value in the register. Counted in bits, from the beginning of the register to the start of the wanted value.

WriteOrder
Individual order number of the property. Determines the order, in which the properties are written.

WriteSize
WriteSize is the bit or byte count to be written.

WriteTime
WriteTime is the time, when GXProperty was last written.

Inheritance Hierarchy
Object
GXObject
  GXProperty

Assembly: Gurux.Device (Module: Gurux.Device) Version: 5.0.0.1