Class WorksheetViewState

Manages the visible portion and display settings of a worksheet, including zoom, frozen panes, selection, and gridline visibility.

Inheritance
System.Object
SheetViewStateBase
WorksheetViewState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class WorksheetViewState : SheetViewStateBase, ISheetViewState

Constructors

WorksheetViewState()

Initializes a new instance of the WorksheetViewState class.

Declaration
public WorksheetViewState()

Properties

CircleInvalidData

Gets or sets a value indicating whether to circle the invalid data.

Declaration
public bool CircleInvalidData { get; set; }
Property Value
System.Boolean

The value indicating whether to circle the invalid data.

IsSelected

Indicates whether this worksheet is the currently active sheet in the workbook.

Declaration
public bool IsSelected { get; set; }
Property Value
System.Boolean

The value indicating if the sheet is selected.

Pane

Defines the frozen pane configuration for locking rows and columns during scrolling.

Declaration
public Pane Pane { get; set; }
Property Value
Pane

The pane.

ScaleFactor

Controls the zoom level for the worksheet view, affecting how content is displayed without changing cell data.

Declaration
public Size ScaleFactor { get; set; }
Property Value
System.Windows.Size

The scale factor.

SelectionState

Tracks the active cell and selected ranges within the worksheet.

Declaration
public SelectionState SelectionState { get; set; }
Property Value
SelectionState

The state of the selection.

ShowGridLines

Controls the visibility of cell gridlines in the worksheet view.

Declaration
public bool ShowGridLines { get; set; }
Property Value
System.Boolean

The value indicating if the gridlines should be shown.

ShowRowColHeaders

Controls the visibility of row numbers and column letters in the worksheet view.

Declaration
public bool ShowRowColHeaders { get; set; }
Property Value
System.Boolean

The value indicating if the row and column headings should be shown.

TopLeftCellIndex

Identifies the cell displayed at the top-left corner of the scrollable viewport, determining the visible area.

Declaration
public CellIndex TopLeftCellIndex { get; set; }
Property Value
CellIndex

The index of the top left cell of the screen.

ViewType

Gets or sets a value indicating how the worksheet should be displayed.

Declaration
public SheetViewType ViewType { get; set; }
Property Value
SheetViewType

The desired view type.

Methods

FreezePanes(Int32, Int32)

Freezes the sheet panes.

Declaration
public void FreezePanes(int frozenRowsCount, int frozenColumnsCount)
Parameters
System.Int32 frozenRowsCount

The number of rows which will be frozen.
System.Int32 frozenColumnsCount

The number of columns which will be frozen.

FreezePanes(CellIndex, Int32, Int32)

Freezes the sheet panes.

Declaration
public void FreezePanes(CellIndex fixedPaneTopLeftCellIndex, int frozenRowsCount, int frozenColumnsCount)
Parameters
CellIndex fixedPaneTopLeftCellIndex

The top left cell index of the fixed pane.
System.Int32 frozenRowsCount

The number of rows which will be frozen.
System.Int32 frozenColumnsCount

The number of columns which will be frozen.

FreezePanes(CellIndex, Int32, Int32, CellIndex)

Freezes the sheet panes.

Declaration
public void FreezePanes(CellIndex fixedPaneTopLeftCellIndex, int frozenRowsCount, int frozenColumnsCount, CellIndex scrollableTopLeftCellIndex)
Parameters
CellIndex fixedPaneTopLeftCellIndex

The top left cell index of the fixed pane.
System.Int32 frozenRowsCount

The number of rows which will be frozen.
System.Int32 frozenColumnsCount

The number of columns which will be frozen.
CellIndex scrollableTopLeftCellIndex

The top left cell index of the scrollable pane.

ToString()

Returns a System.String that represents the current System.Object.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents the current System.Object.
Overrides
System.Object.ToString()

Extension Methods