Class VisibleLinesCollection
A strong-typed collection of VisibleLineInfo items.
Inheritance
Namespace: Syncfusion.GridCommon.ScrollAxis
Assembly: Syncfusion.GridCommon.Portable.dll
Syntax
public class VisibleLinesCollection : List<VisibleLineInfo>Constructors
VisibleLinesCollection()
Initializes a new instance of the VisibleLinesCollection class.
Declaration
public VisibleLinesCollection()Properties
FirstBodyVisibleIndex
Gets or sets the index of the first visible line in the body region.
Declaration
public int FirstBodyVisibleIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The index of the first visible line in the body region. |
FirstFooterVisibleIndex
Gets or sets the index of the first visible line in the footer region.
Declaration
public int FirstFooterVisibleIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The index of the first visible line in the footer region. |
LastBodyVisibleIndex
Gets the index of the last visible line in the body region.
Declaration
public int LastBodyVisibleIndex { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The index of the last visible line in the body region. |
VisibleLineIndexes
Gets the visible line indexes.
Declaration
public Dictionary<int, VisibleLineInfo> VisibleLineIndexes { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.Int32, VisibleLineInfo> | The visible line indexes. |
Methods
AnyVisibleLines(Int32, Int32)
Gets a boolean value indicating whether any of the lines with the given absolute line index are visible.
Declaration
public bool AnyVisibleLines(int lineIndex1, int lineIndex2)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | lineIndex1 | The line index 1. |
| System.Int32 | lineIndex2 | The line index 2. |
Returns
| Type | Description |
|---|---|
| System.Boolean | A boolean value indicating whether any of the lines with the given absolute line index are visible. |
Clear()
Removes all elements from the collection.
Declaration
public void Clear()GetVisibleLineAtLineIndex(Int32)
Gets the visible line at line index.
Declaration
public VisibleLineInfo GetVisibleLineAtLineIndex(int lineIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | lineIndex | Index of the line. |
Returns
| Type | Description |
|---|---|
| VisibleLineInfo | The visible line at line index. |
GetVisibleLineAtPoint(Double)
Gets the visible line at point.
Declaration
public VisibleLineInfo GetVisibleLineAtPoint(double point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | point | The point at which the visible line is to be obtained. |
Returns
| Type | Description |
|---|---|
| VisibleLineInfo | The visible line at point. |
GetVisibleLineNearLineIndex(Int32)
Gets the visible line for a line index. If the specified line is hidden the next visible line is returned.
Declaration
public VisibleLineInfo GetVisibleLineNearLineIndex(int lineIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | lineIndex | Index of the line. |
Returns
| Type | Description |
|---|---|
| VisibleLineInfo | The first visible line for a line index that is not hidden. |