Class ElementLocation

The methods and properties in the ElementLocation class provide information from the element location.

Inheritance

object

ElementLocation

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: WRQ.Verastream.HostIntegrator

Assembly: WRQ.Verastream.HostIntegrator.dll

Syntax

[Serializable]
public class ElementLocation

Properties

ElementType

Gets the type of element.

This can be one of the following:

• ELEMENT_TYPE_ATTRIBUTE - an entity attribute
• ELEMENT_TYPE_PATTERN - an entity pattern
• ELEMENT_TYPE_FIELD - a recordset field
• ELEMENT_TYPE_RECORDSET - a recordset
• ELEMENT_TYPE_UNKNOWN - unknown element

Declaration

public virtual ElementType ElementType { get; }

Property Value

Type	Description
ElementType	int - the element type

LeftColumn

Gets the location of the left column of an element.

Declaration

public virtual int LeftColumn { get; }

Property Value

Type	Description
int	Gets the location of the left column of an element.

Remarks

Use the LeftColumn property to get the location of the left column of an element that is defined as a rectangular region. If the element is defined as a linear region, the value returned is -1.

Length

Gets the length of an element.

Declaration

public virtual int Length { get; }

Property Value

Type	Description
int	Gets the length of an element.

Remarks

Use the Length property to get the length of an element that is defined as a linear region. If the element is defined as a rectangular region, the value returned is -1.

Name

Gets the name of an element.

Declaration

public virtual string Name { get; }

Property Value

Type	Description
string	Gets the name of an element.

Remarks

Gets the name of an element.

NumColumns

Gets the number of columns for an element.

Declaration

public virtual int NumColumns { get; }

Property Value

Type	Description
int	Gets the number of columns for an element.

Remarks

Use the NumColumns property to get the number of columns for an element that is defined as a rectangular region. If the element is defined as a linear region, the value returned is -1.

NumRows

Gets the number of rows for an element.

Declaration

public virtual int NumRows { get; }

Property Value

Type	Description
int	Gets the number of rows for an element.

Remarks

Use the NumRows property to get the number of rows for an element that is defined as a rectangular region. If the element is defined as a linear region, the value returned is -1.

Offset

Gets the offset for an element.

Declaration

public virtual int Offset { get; }

Property Value

Type	Description
int	Gets the offset for the element.

Remarks

Use the Offset property to get the offset for an element that is defined as a linear region. If the element is defined as a rectangular region, the value returned is -1.

RegionType

Gets the type of region for an element.

Declaration

public virtual RegionType RegionType { get; }

Property Value

Type	Description
RegionType	The value returned is a member of the RegionType enumeration.

Remarks

The value returned is a member of the RegionType enumeration.

TopRow

Gets the location of the top row flag for an element.

Declaration

public virtual int TopRow { get; }

Property Value

Type	Description
int	Gets the location of the top row flag for an element.

Remarks

Use the TopRow property to get the location of the top row of an element that is defined as a rectangular region. If the element is defined as a linear region, the value returned is -1.