Back to all docs
API Reference / Telerik.Windows.Documents.Spreadsheet.Layout / SheetViewport
New to Telerik UI for WinForms? Start a free 30-day trial

SheetViewport

Class

Manages the visible area and frozen panes of a worksheet, translating between document coordinates and view coordinates.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Layout

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:
C#
public class SheetViewport

Inheritance: objectSheetViewport

Properties

Height

Gets the total visible height across all viewport panes.

C#
public double Height { get; }
Property Value:

The height.

this[ViewportPaneType]

Gets or sets the ViewportPane of the specified type.

C#
public ViewportPane this[ViewportPaneType pane] { get; set; }
Parameters:paneViewportPaneTypeProperty Value:

The viewport pane.

ViewportPanes

Gets the array of non-empty viewport panes created by frozen rows or columns.

C#
public ViewportPane[] ViewportPanes { get; }
Property Value:

The viewport panes.

ViewportPanesCount

Gets the count of non-empty viewport panes created by frozen rows or columns.

C#
public int ViewportPanesCount { get; }
Property Value:

The viewport panes count.

Width

Gets the total visible width across all viewport panes.

C#
public double Width { get; }
Property Value:

The width.

Methods

Contains(CellIndex)

Determines whether the viewport contains the specified cell index in any visible range.

C#
public bool Contains(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

bool

True if contains the cell index.

Contains(int, int)

Determines whether the viewport contains the cell at the specified row and column index in any visible range.

C#
public bool Contains(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

bool

Contains(Point)

Determines whether the viewport contains the specified point within any pane.

C#
public bool Contains(Point point)
Parameters:pointPoint

The point.

Returns:

bool

True if contains the point.

Contains(Rect)

Determines whether the viewport contains the specified bounding rectangle within any pane.

C#
public bool Contains(Rect boundingRectangle)
Parameters:boundingRectangleRect

The bounding rectangle.

Returns:

bool

ContainsColumnIndex(int)

Determines whether the viewport contains the specified column index in any visible range.

C#
public bool ContainsColumnIndex(int columnIndex)
Parameters:columnIndexint

Index of the column.

Returns:

bool

True if contains the column index.

ContainsRowIndex(int)

Determines whether the viewport contains the specified row index in any visible range.

C#
public bool ContainsRowIndex(int rowIndex)
Parameters:rowIndexint

Index of the row.

Returns:

bool

True if contains the row index.

Equals(object)

Determines whether the specified object is equal to the current object.

C#
public override bool Equals(object obj)
Parameters:objobject

The object to compare with the current object.

Returns:

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides: object.Equals(object)

GetCellRangeContainingCellIndex(CellIndex)

Gets the visible range of the viewport pane that contains the specified cell index.

C#
public CellRange GetCellRangeContainingCellIndex(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellRange

The cell range.

GetCellRangeContainingCellIndex(int, int)

Gets the visible range of the viewport pane that contains the cell at the specified row and column.

C#
public CellRange GetCellRangeContainingCellIndex(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

CellRange

GetDocumentPointFromViewPoint(Point)

Converts a point from view coordinates to document coordinates, accounting for frozen panes and scaling.

C#
public Point GetDocumentPointFromViewPoint(Point point)
Parameters:pointPoint

The view point point.

Returns:

Point

The document point.

GetHashCode()

Serves as a hash function for a particular type.

C#
public override int GetHashCode()
Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

GetLeftMostViewportPaneContainingRowIndex(int)

Gets the leftmost viewport pane that contains the specified row index.

C#
public ViewportPane GetLeftMostViewportPaneContainingRowIndex(int rowIndex)
Parameters:rowIndexint

Index of the row.

Returns:

ViewportPane

The viewport pane containing row index.

GetTopLeftPoint()

Gets the top-left corner point of the first non-empty viewport pane.

C#
public Point GetTopLeftPoint()
Returns:

Point

GetTopMostViewportPaneContainingColumnIndex(int)

Gets the topmost viewport pane that contains the specified column index.

C#
public ViewportPane GetTopMostViewportPaneContainingColumnIndex(int columnIndex)
Parameters:columnIndexint

Index of the column.

Returns:

ViewportPane

The viewport pane containing column index.

GetViewPointFromDocumentPoint(Point)

Converts a point from document coordinates to view coordinates, accounting for frozen panes and scaling.

C#
public Point GetViewPointFromDocumentPoint(Point point)
Parameters:pointPoint

The document point.

Returns:

Point

The view point.

GetViewportPaneContainingCellIndex(CellIndex)

Gets the viewport pane that contains the specified cell index.

C#
public ViewportPane GetViewportPaneContainingCellIndex(CellIndex index)
Parameters:indexCellIndex

The index.

Returns:

ViewportPane

The viewport pane containing cell.

GetViewportPaneFromDocumentPoint(Point)

Determines which viewport pane contains the specified point in document coordinates.

C#
public ViewportPane GetViewportPaneFromDocumentPoint(Point point)
Parameters:pointPoint

The document point.

Returns:

ViewportPane

The viewport pane.

Translate(Point, ViewportPaneType)

Translates the specified point to viewport coordinates relative to the containing pane.

C#
public Point Translate(Point point, ViewportPaneType pointContainingPaneType)
Parameters:pointPoint

The point.

pointContainingPaneTypeViewportPaneType

Type of the pane that contains the point.

Returns:

Point

The translated point.

Operators

operator !=(SheetViewport, SheetViewport)

Implements the less operator.

C#
public static bool operator !=(SheetViewport first, SheetViewport second)
Parameters:firstSheetViewport

The first value.

secondSheetViewport

The second value.

Returns:

bool

The result of the operator.

operator ==(SheetViewport, SheetViewport)

Implements the equals operator.

C#
public static bool operator ==(SheetViewport first, SheetViewport second)
Parameters:firstSheetViewport

The first value.

secondSheetViewport

The second value.

Returns:

bool

The result of the operator.

In this article
DefinitionPropertiesHeightthis[ViewportPaneType]ViewportPanesViewportPanesCountWidthMethodsContains(CellIndex)Contains(int, int)Contains(Point)Contains(Rect)ContainsColumnIndex(int)ContainsRowIndex(int)Equals(object)GetCellRangeContainingCellIndex(CellIndex)GetCellRangeContainingCellIndex(int, int)GetDocumentPointFromViewPoint(Point)GetHashCode()GetLeftMostViewportPaneContainingRowIndex(int)GetTopLeftPoint()GetTopMostViewportPaneContainingColumnIndex(int)GetViewPointFromDocumentPoint(Point)GetViewportPaneContainingCellIndex(CellIndex)GetViewportPaneFromDocumentPoint(Point)Translate(Point, ViewportPaneType)Operatorsoperator !=(SheetViewport, SheetViewport)operator ==(SheetViewport, SheetViewport)
Not finding the help you need?
Contact Support