ClassWorksheetViewState
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:
public class WorksheetViewState : SheetViewStateBase, ISheetViewStateInheritance: objectSheetViewStateBaseWorksheetViewState
Implements:
Inherited Members
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
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
The value indicating if the sheet is selected.
Pane
Defines the frozen pane configuration for locking rows and columns during scrolling.
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
The scale factor.
SelectionState
Tracks the active cell and selected ranges within the worksheet.
Declaration
public SelectionState SelectionState { get; set; }Property Value
The state of the selection.
ShowGridLines
Controls the visibility of cell gridlines in the worksheet view.
Declaration
public bool ShowGridLines { get; set; }Property Value
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
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
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
The desired view type.
Methods
FreezePanes(CellIndex, int, int)
Freezes the sheet panes.
Declaration
public void FreezePanes(CellIndex fixedPaneTopLeftCellIndex, int frozenRowsCount, int frozenColumnsCount)Parameters
fixedPaneTopLeftCellIndex
The top left cell index of the fixed pane.
frozenRowsCount
The number of rows which will be frozen.
frozenColumnsCount
The number of columns which will be frozen.
FreezePanes(CellIndex, int, int, CellIndex)
Freezes the sheet panes.
Declaration
public void FreezePanes(CellIndex fixedPaneTopLeftCellIndex, int frozenRowsCount, int frozenColumnsCount, CellIndex scrollableTopLeftCellIndex)Parameters
fixedPaneTopLeftCellIndex
The top left cell index of the fixed pane.
frozenRowsCount
The number of rows which will be frozen.
frozenColumnsCount
The number of columns which will be frozen.
scrollableTopLeftCellIndex
The top left cell index of the scrollable pane.
FreezePanes(int, int)
Freezes the sheet panes.