Class SheetViewport

Represents the sheet viewport.

Inheritance
System.Object
SheetViewport
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Layout
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class SheetViewport

Properties

Height

Gets the height.

Declaration
public double Height { get; }
Property Value
System.Double

The height.

Item[ViewportPaneType]

Gets or sets the ViewportPane with the specified pane.

Declaration
public ViewportPane this[ViewportPaneType pane] { get; set; }
Parameters
ViewportPaneType pane

Property Value
ViewportPane

The viewport pane.

ViewportPanes

Gets the viewport panes.

Declaration
public ViewportPane[] ViewportPanes { get; }
Property Value
ViewportPane[]

The viewport panes.

ViewportPanesCount

Gets the viewport panes count.

Declaration
public int ViewportPanesCount { get; }
Property Value
System.Int32

The viewport panes count.

Width

Gets the width.

Declaration
public double Width { get; }
Property Value
System.Double

The width.

Methods

Contains(Int32, Int32)

Determines whether the sheet viewport contains the specified row and column index.

Declaration
public bool Contains(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

Contains(Point)

Determines whether the SheetViewport contains the specified point.

Declaration
public bool Contains(Point point)
Parameters
System.Windows.Point point

The point.
Returns
System.Boolean

True if contains the point.

Contains(Rect)

Determines whether [contains] [the specified bounding rectangle].

Declaration
public bool Contains(Rect boundingRectangle)
Parameters
System.Windows.Rect boundingRectangle

The bounding rectangle.
Returns
System.Boolean

Contains(CellIndex)

Determines whether the SheetViewport contains the specified cell index.

Declaration
public bool Contains(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
System.Boolean

True if contains the cell index.

ContainsColumnIndex(Int32)

Determines whetherthe SheetViewport contains the specified column index.

Declaration
public bool ContainsColumnIndex(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if contains the column index.

ContainsRowIndex(Int32)

Determines whether the SheetViewport contains the specified row index.

Declaration
public bool ContainsRowIndex(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
System.Boolean

True if contains the row index.

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The object to compare with the current object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetCellRangeContainingCellIndex(Int32, Int32)

Gets the index of the cell range containing cell.

Declaration
public CellRange GetCellRangeContainingCellIndex(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
CellRange

GetCellRangeContainingCellIndex(CellIndex)

Gets the cell range containing cell index.

Declaration
public CellRange GetCellRangeContainingCellIndex(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellRange

The cell range.

GetDocumentPointFromViewPoint(Point)

Gets the document point from view point.

Declaration
public Point GetDocumentPointFromViewPoint(Point point)
Parameters
System.Windows.Point point

The view point point.
Returns
System.Windows.Point

The document point.

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

GetLeftMostViewportPaneContainingRowIndex(Int32)

Gets the left most viewport pane containing row index.

Declaration
public ViewportPane GetLeftMostViewportPaneContainingRowIndex(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
ViewportPane

The viewport pane containing row index.

GetTopLeftPoint()

Gets the top left point.

Declaration
public Point GetTopLeftPoint()
Returns
System.Windows.Point

GetTopMostViewportPaneContainingColumnIndex(Int32)

Gets the top most viewport pane containing column index.

Declaration
public ViewportPane GetTopMostViewportPaneContainingColumnIndex(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.
Returns
ViewportPane

The viewport pane containing column index.

GetViewPointFromDocumentPoint(Point)

Gets the view point from document point.

Declaration
public Point GetViewPointFromDocumentPoint(Point point)
Parameters
System.Windows.Point point

The document point.
Returns
System.Windows.Point

The view point.

GetViewportPaneContainingCellIndex(CellIndex)

Gets the index of the viewport pane containing cell.

Declaration
public ViewportPane GetViewportPaneContainingCellIndex(CellIndex index)
Parameters
CellIndex index

The index.
Returns
ViewportPane

The viewport pane containing cell.

GetViewportPaneFromDocumentPoint(Point)

Gets the viewport pane from document point.

Declaration
public ViewportPane GetViewportPaneFromDocumentPoint(Point point)
Parameters
System.Windows.Point point

The document point.
Returns
ViewportPane

The viewport pane.

Translate(Point, ViewportPaneType)

Translates the specified point.

Declaration
public Point Translate(Point point, ViewportPaneType pointContainingPaneType)
Parameters
System.Windows.Point point

The point.
ViewportPaneType pointContainingPaneType

Type of the pane that contains the point.
Returns
System.Windows.Point

The translated point.

Operators

Equality(SheetViewport, SheetViewport)

Implements the equals operator.

Declaration
public static bool operator ==(SheetViewport first, SheetViewport second)
Parameters
SheetViewport first

The first value.
SheetViewport second

The second value.
Returns
System.Boolean

The result of the operator.

Inequality(SheetViewport, SheetViewport)

Implements the less operator.

Declaration
public static bool operator !=(SheetViewport first, SheetViewport second)
Parameters
SheetViewport first

The first value.
SheetViewport second

The second value.
Returns
System.Boolean

The result of the operator.

Extension Methods