New to Telerik Document ProcessingStart a free 30-day trial

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

C#
public class WorksheetViewState : SheetViewStateBase, ISheetViewState

Inheritance: objectSheetViewStateBaseWorksheetViewState

Implements: ISheetViewState

Inherited Members SheetViewStateBase.TabColorSheetViewStateBase.IsInvalidated

Constructors

Initializes a new instance of the WorksheetViewState class.

C#
public WorksheetViewState()

Methods

Freezes the sheet panes.

C#
public void FreezePanes(CellIndex fixedPaneTopLeftCellIndex, int frozenRowsCount, int frozenColumnsCount, CellIndex scrollableTopLeftCellIndex)
Parameters:fixedPaneTopLeftCellIndexCellIndex

The top left cell index of the fixed pane.

frozenRowsCountint

The number of rows which will be frozen.

frozenColumnsCountint

The number of columns which will be frozen.

scrollableTopLeftCellIndexCellIndex

The top left cell index of the scrollable pane.

Freezes the sheet panes.

C#
public void FreezePanes(CellIndex fixedPaneTopLeftCellIndex, int frozenRowsCount, int frozenColumnsCount)
Parameters:fixedPaneTopLeftCellIndexCellIndex

The top left cell index of the fixed pane.

frozenRowsCountint

The number of rows which will be frozen.

frozenColumnsCountint

The number of columns which will be frozen.

Freezes the sheet panes.

C#
public void FreezePanes(int frozenRowsCount, int frozenColumnsCount)
Parameters:frozenRowsCountint

The number of rows which will be frozen.

frozenColumnsCountint

The number of columns which will be frozen.

Returns a string that represents the current object.

C#
public override string ToString()
Returns:

string

A string that represents the current object.

Overrides: object.ToString()

Properties

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

C#
public bool CircleInvalidData { get; set; }
Property Value:

The value indicating whether to circle the invalid data.

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

C#
public bool IsSelected { get; set; }
Property Value:

The value indicating if the sheet is selected.

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

C#
public Pane Pane { get; set; }
Property Value:

The pane.

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

C#
public Size ScaleFactor { get; set; }
Property Value:

The scale factor.

Tracks the active cell and selected ranges within the worksheet.

C#
public SelectionState SelectionState { get; set; }
Property Value:

The state of the selection.

Controls the visibility of cell gridlines in the worksheet view.

C#
public bool ShowGridLines { get; set; }
Property Value:

The value indicating if the gridlines should be shown.

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

C#
public bool ShowRowColHeaders { get; set; }
Property Value:

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

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

C#
public CellIndex TopLeftCellIndex { get; set; }
Property Value:

The index of the top left cell of the screen.

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

C#
public SheetViewType ViewType { get; set; }
Property Value:

The desired view type.