SheetView Class
Holds per-sheet UI state (undo/redo history, rendering layout) that is not part of the document model.
Inheritance
Object
Spreadsheet.SheetView
Namespace: Radzen.Blazor.Spreadsheet
Assembly: Radzen.Blazor.dll
Syntax
public class SheetViewConstructors
SheetViewlink
Initializes a new instance of the SheetView class.
Declaration
public SheetView(Documents.Spreadsheet.Worksheet sheet)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Worksheet | sheet |
Properties
ColumnHeaderOffsetlink
Gets or sets the header offset for columns (width of row headers in pixels).
Declaration
public double ColumnHeaderOffset { get; set; }Property Value
| Type | Description |
|---|---|
| double | Gets or sets the header offset for columns (width of row headers in pixels). |
Commandslink
Gets the per-sheet undo/redo stack.
Declaration
public Spreadsheet.UndoRedoStack Commands { get; }Property Value
| Type | Description |
|---|---|
| Spreadsheet.UndoRedoStack | Gets the per-sheet undo/redo stack. |
Editorlink
Gets the per-sheet editor.
Declaration
public Spreadsheet.Editor Editor { get; }Property Value
| Type | Description |
|---|---|
| Spreadsheet.Editor | Gets the per-sheet editor. |
RowHeaderOffsetlink
Gets or sets the header offset for rows (height of column headers in pixels).
Declaration
public double RowHeaderOffset { get; set; }Property Value
| Type | Description |
|---|---|
| double | Gets or sets the header offset for rows (height of column headers in pixels). |
ScrollLeftlink
Gets or sets the horizontal scroll position for this sheet.
Declaration
public double ScrollLeft { get; set; }Property Value
| Type | Description |
|---|---|
| double | Gets or sets the horizontal scroll position for this sheet. |
ScrollToplink
Gets or sets the vertical scroll position for this sheet.
Declaration
public double ScrollTop { get; set; }Property Value
| Type | Description |
|---|---|
| double | Gets or sets the vertical scroll position for this sheet. |
TotalHeightlink
Gets the total scrollable height including the row header offset.
Declaration
public double TotalHeight { get; }Property Value
| Type | Description |
|---|---|
| double | Gets the total scrollable height including the row header offset. |
TotalWidthlink
Gets the total scrollable width including the column header offset.
Declaration
public double TotalWidth { get; }Property Value
| Type | Description |
|---|---|
| double | Gets the total scrollable width including the column header offset. |
Worksheetlink
Gets the document sheet this view wraps.
Declaration
public Documents.Spreadsheet.Worksheet Worksheet { get; }Property Value
| Type | Description |
|---|---|
| Documents.Spreadsheet.Worksheet | Gets the document sheet this view wraps. |
Methods
GetColumnPixelRangelink
Gets the pixel range for the specified column indices, offset by the column header width.
Declaration
public Spreadsheet.PixelRange GetColumnPixelRange(int startIndex, int endIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | startIndex | |
| int | endIndex |
Returns
| Type | Description |
|---|---|
| Spreadsheet.PixelRange |
GetColumnPixelRangelink
Gets the pixel range for the specified column indices, offset by the column header width.
Declaration
public Spreadsheet.PixelRange GetColumnPixelRange(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
Returns
| Type | Description |
|---|---|
| Spreadsheet.PixelRange |
GetColumnRangelink
Gets the visible column index range for the given scroll position and viewport width. Accounts for the column header offset.
Declaration
public Spreadsheet.IndexRange GetColumnRange(double start, double end, bool includeFrozen)Parameters
| Type | Name | Description |
|---|---|---|
| double | start | |
| double | end | |
| bool | includeFrozen |
Returns
| Type | Description |
|---|---|
| Spreadsheet.IndexRange |
GetRangeslink
Splits a range into regions based on frozen pane boundaries for rendering.
Declaration
public IEnumerable<Spreadsheet.RangeInfo> GetRanges(Documents.Spreadsheet.RangeRef range)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.RangeRef | range |
Returns
| Type | Description |
|---|---|
| IEnumerable<Spreadsheet.RangeInfo> |
GetRowPixelRangelink
Gets the pixel range for the specified row indices, offset by the row header height.
Declaration
public Spreadsheet.PixelRange GetRowPixelRange(int startIndex, int endIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | startIndex | |
| int | endIndex |
Returns
| Type | Description |
|---|---|
| Spreadsheet.PixelRange |
GetRowPixelRangelink
Gets the pixel range for the specified row indices, offset by the row header height.
Declaration
public Spreadsheet.PixelRange GetRowPixelRange(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
Returns
| Type | Description |
|---|---|
| Spreadsheet.PixelRange |
GetRowRangelink
Gets the visible row index range for the given scroll position and viewport height. Accounts for the row header offset.
Declaration
public Spreadsheet.IndexRange GetRowRange(double start, double end, bool includeFrozen)Parameters
| Type | Name | Description |
|---|---|---|
| double | start | |
| double | end | |
| bool | includeFrozen |
Returns
| Type | Description |
|---|---|
| Spreadsheet.IndexRange |