Class ControlLocation

• C#
• Visual Basic

[Obfuscation(Exclude = true, ApplyToMembers = true)]
[Serializable]
public class ControlLocation

Inheritance

System.Object

ControlLocation

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: HomeSeer.PluginSdk.Devices.Controls

Assembly: PluginSdk.dll

---

The location and size of a control available on a HsFeature.

It describes the row and column a control occupies in the grid as well as how many columns wide it is.

Constructors

ControlLocation()

Initialize a new location with a row and column position of 0 and a width of 1 column.

Declaration

• C#
• Visual Basic

public ControlLocation()

ControlLocation(Int32, Int32, Int32)

Initialize a new location with the specified row and column position and desired width.

Declaration

• C#
• Visual Basic

public ControlLocation(int row, int column, int width = 1)

Parameters

Type	Name	Description
System.Int32	row	The 1 index of the location row. Must be >= 1
System.Int32	column	The 1 index of the location column. Must be >= 1
System.Int32	width	The number of columns the control occupies. Must be >= 1

Fields

_column

Declaration

• C#
• Visual Basic

int _column

Field Value

Type	Description
System.Int32

_row

Declaration

• C#
• Visual Basic

int _row

Field Value

Type	Description
System.Int32

_width

Declaration

• C#
• Visual Basic

int _width

Field Value

Type	Description
System.Int32

Properties

Column

The column the control is located in.

This is a 1 based index starting from the left side and going right.

Declaration

• C#
• Visual Basic

public int Column { get; set; }

Property Value

Type	Description
System.Int32

Row

The row the control is located in.

This is a 1 based index starting from the top and going down.

Declaration

• C#
• Visual Basic

public int Row { get; set; }

Property Value

Type	Description
System.Int32

Width

The number of columns the control takes up

Must be between 1 and 4.

Declaration

• C#
• Visual Basic

public int Width { get; set; }

Property Value

Type	Description
System.Int32

Methods

Equals(Object)

Compare this object with another to see if they are equal

Declaration

• C#
• Visual Basic

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare

Returns

Type	Description
System.Boolean	langword_csharp_True if they are equal, langword_csharp_False if they are not

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Get the hash code

Declaration

• C#
• Visual Basic

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code based on the Row, Column and Width values

Overrides

System.Object.GetHashCode()