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.UI.Xaml.Grid.ScrollAxis
Assembly: Syncfusion.SfGridCommon.UWP.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.

Properties

ClippedCorner

Gets the clipped corner.

Declaration
public double ClippedCorner { get; }
Property Value
Type Description
System.Double

The clipped corner.

ClippedCornerExtent

Gets the clipped corner extent.

Declaration
public double ClippedCornerExtent { get; }
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

Determines whether this instance is clipped taking into consideration whether it is the the first or last visible line and no clipping is needed for these cases.

Declaration
public bool IsClippedBody { get; }
Property Value
Type
System.Boolean

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.

IsLastVisibleLine

Returns whether the line is last visible line.

Declaration
public bool IsLastVisibleLine { get; }
Property Value
Type
System.Boolean

IsVisible

Determines if the line is visible.

Declaration
public bool IsVisible { get; }
Property Value
Type
System.Boolean

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.

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 the type name with state of this instance.

Declaration
public override string ToString()
Returns
Type
System.String

Implements

System.IComparable<>

Extension Methods