Class VisibleLineInfo

Contains information about a visible line (can also be a row or column).

Inheritance

System.Object

VisibleLineInfo

Implements

System.IComparable<VisibleLineInfo>

Namespace: Syncfusion.GridCommon.ScrollAxis

Assembly: Syncfusion.GridCommon.Portable.dll

Syntax

public sealed class VisibleLineInfo : Object, IComparable<VisibleLineInfo>

Constructors

VisibleLineInfo(Int32, Int32, Double, Double, Double, Boolean, Boolean)

Initializes a new instance of the VisibleLineInfo class.

Declaration

public VisibleLineInfo(int visibleIndex, int lineIndex, double size, double clippedOrigin, double scrollOffset, bool isHeader, bool isFooter)

Parameters

Type	Name	Description
System.Int32	visibleIndex	Visible index of the line.
System.Int32	lineIndex	Absolute index of the line.
System.Double	size	The size.
System.Double	clippedOrigin	The clipped origin.
System.Double	scrollOffset	The scroll offset.
System.Boolean	isHeader	if set to true line is a header.
System.Boolean	isFooter	if set to true line is a footer.

Fields

IsLastLine

A boolean value indicating whether the visible line is the last line.

Declaration

public bool IsLastLine

Field Value

Type
System.Boolean

Properties

ClippedCorner

Gets the clipped corner.

Declaration

public double ClippedCorner { get; }

Property Value

Type	Description
System.Double	The clipped corner.

ClippedCornerExtent

Gets or sets the clipped corner extent.

Declaration

public double ClippedCornerExtent { get; set; }

Property Value

Type	Description
System.Double	The clipped corner extent.

ClippedOrigin

Gets the clipped origin.

Declaration

public double ClippedOrigin { get; }

Property Value

Type	Description
System.Double	The clipped origin.

ClippedSize

Gets the size of the clipped area.

Declaration

public double ClippedSize { get; }

Property Value

Type	Description
System.Double	The size of the clipped area.

Corner

Gets the corner.

Declaration

public double Corner { get; }

Property Value

Type	Description
System.Double	The corner.

IsClipped

Gets a value indicating whether this instance is clipped.

Declaration

public bool IsClipped { get; }

Property Value

Type	Description
System.Boolean	True if this instance is clipped, otherwise false.

IsClippedBody

Gets a value indicating whether this instance is clipped taking into consideration, whether it is the first or last visible line and no clipping is needed for these cases.

Declaration

public bool IsClippedBody { get; }

Property Value

Type	Description
System.Boolean	A boolean value indicating whether this instance is clipped taking into consideration, whether it is the first or last visible line and no clipping is needed for these cases.

IsClippedCorner

Gets a value indicating whether this instance corner is clipped.

Declaration

public bool IsClippedCorner { get; }

Property Value

Type	Description
System.Boolean	True if this instance corner is clipped, otherwise false.

IsClippedOrigin

Gets a value indicating whether this instance origin is clipped.

Declaration

public bool IsClippedOrigin { get; }

Property Value

Type	Description
System.Boolean	True if this instance origin is clipped, otherwise false.

IsFooter

Gets a value indicating whether this instance is a footer.

Declaration

public bool IsFooter { get; }

Property Value

Type	Description
System.Boolean	True if this instance is a footer, otherwise false.

IsHeader

Gets a value indicating whether this instance is a header.

Declaration

public bool IsHeader { get; }

Property Value

Type	Description
System.Boolean	True if this instance is a header, otherwise false.

IsVisible

Gets a value indicating whether the line is visible.

Declaration

public bool IsVisible { get; }

Property Value

Type	Description
System.Boolean	A boolean value indicating whether the line is visible.

LineIndex

Gets the index of the line.

Declaration

public int LineIndex { get; }

Property Value

Type	Description
System.Int32	The index of the line.

Origin

Gets the origin.

Declaration

public double Origin { get; }

Property Value

Type	Description
System.Double	The origin.

Region

Gets the axis region this line belongs to.

Declaration

public ScrollAxisRegion Region { get; }

Property Value

Type	Description
ScrollAxisRegion	The axis region this line belongs to.

ScrollOffset

Gets the scroll offset.

Declaration

public double ScrollOffset { get; }

Property Value

Type	Description
System.Double	The scroll offset.

Size

Gets the size.

Declaration

public double Size { get; }

Property Value

Type	Description
System.Double	The size.

VisibleIndex

Gets the visible index of the line.

Declaration

public int VisibleIndex { get; }

Property Value

Type	Description
System.Int32	The visible index of the line.

Methods

CompareTo(VisibleLineInfo)

Compares the current object with another object of the same type.

Declaration

public int CompareTo(VisibleLineInfo other)

Parameters

Type	Name	Description
VisibleLineInfo	other	An object to compare with this object.

Returns

Type	Description
System.Int32	A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other.

ToString()

Returns a string describing the state of the object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string describing the state of the object.

Implements

System.IComparable<>