Class ControlEvent 

[Obfuscation(Exclude = true, ApplyToMembers = true)]
[Serializable]
public class ControlEvent
Inheritance
System.Object
ControlEvent
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: HomeSeer.PluginSdk.Devices.Controls
Assembly: PluginSdk.dll

The description of an event representing a controlled change of a HsFeature.


Constructors

View Source

ControlEvent(Int32)

Create a new ControlEvent for a Ref

Declaration
public ControlEvent(int devRef)
Parameters
Type Name Description
System.Int32 devRef

The Ref of the HsFeature being controlled

Fields

View Source

_controlString

Declaration
string _controlString
Field Value
Type Description
System.String
View Source

_controlType

Declaration
EControlType _controlType
Field Value
Type Description
EControlType
View Source

_controlUse

Declaration
EControlUse _controlUse
Field Value
Type Description
EControlUse
View Source

_controlValue

Declaration
double _controlValue
Field Value
Type Description
System.Double
View Source

_index

Declaration
int _index
Field Value
Type Description
System.Int32
View Source

_label

Declaration
string _label
Field Value
Type Description
System.String
View Source

_ref

Declaration
int _ref
Field Value
Type Description
System.Int32

Properties

View Source

CCIndex

A unique index representing the CAPIControl in HomeSeer.

Declaration
[Obsolete("This is a carry over from the legacy API. It should not need to be used anymore and is maintained for compatibility.", false)]
public int CCIndex { get; set; }
Property Value
Type Description
System.Int32
Remarks

This is a carry over from the legacy API. It should not need to be used anymore and is maintained for compatibility.

View Source

ControlString

A string containing control data for the event. This is used for ColorPickers

Declaration
public string ControlString { get; set; }
Property Value
Type Description
System.String
Remarks

This is NOT the Label to display in the DisplayedStatus of the HsFeature. This is not displayed anywhere.

View Source

ControlType

The EControlType of the StatusControl used to generate this event.

Declaration
public EControlType ControlType { get; set; }
Property Value
Type Description
EControlType
View Source

ControlUse

The EControlUse of the StatusControl used to generate this event.

Declaration
public EControlUse ControlUse { get; set; }
Property Value
Type Description
EControlUse
View Source

ControlValue

The target value for the event. This is the desired Value

Declaration
public double ControlValue { get; set; }
Property Value
Type Description
System.Double
View Source

Label

A human-readable string representing the label to display on the HsFeature for this event.

Declaration
public string Label { get; set; }
Property Value
Type Description
System.String
View Source

TargetRef

The Ref of the HsFeature being controlled.

Declaration
public int TargetRef { get; set; }
Property Value
Type Description
System.Int32

See Also