Class Sheet

Abstract base for all sheet types in a workbook, providing naming, visibility, protection, and layout coordination for derived sheet implementations (Worksheet, future chart sheets).

Inheritance
System.Object
NotifyPropertyChangedBase
Sheet
Worksheet
Inherited Members
System.Object.ToString()
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 abstract class Sheet : NotifyPropertyChangedBase, INotifyPropertyChanged, ISheet, IDisposable

Properties

IsLayoutUpdateSuspended

Indicates whether layout invalidation events are deferred, typically during batch operations to avoid redundant recalculations.

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

The value indicating whether the layout update is suspended.
Implements

IsProtected

Indicates whether sheet protection is currently enforced, restricting user modifications based on protection options.

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

The is protected.

Name

User-visible sheet name displayed on tabs, validated for uniqueness and Excel naming constraints (length, forbidden characters).

Declaration
public string Name { get; set; }
Property Value
System.String

The name of the sheet.
Implements

SheetPageSetup

Gets the sheet page setup.

Declaration
protected abstract SheetPageSetupBase SheetPageSetup { get; }
Property Value
SheetPageSetupBase

The sheet page setup.

Type

Discriminates the sheet category (Worksheet, future chart sheets) to route type-specific operations.

Declaration
public abstract SheetType Type { get; }
Property Value
SheetType

The type of the sheet.
Implements

Visibility

Controls whether the sheet is visible, hidden, or very hidden (hidden from UI visibility toggles).

Declaration
public SheetVisibility Visibility { get; set; }
Property Value
SheetVisibility

The visibility.
Implements

Workbook

Workbook that owns this sheet, assigned once when the sheet is added to a workbook's sheet collection.

Declaration
public Workbook Workbook { get; }
Property Value
Workbook

The workbook.
Implements

Methods

BeginUndoGroup()

Begins a logical undo group so that subsequent commands are undone or redone together as a single user action.

Declaration
public void BeginUndoGroup()

CreateViewState()

Creates the view state object that tracks panes, selection, and scroll position for this sheet type.

Declaration
protected abstract ISheetViewState CreateViewState()
Returns
ISheetViewState

Dispose()

Releases resources held by the sheet, primarily clearing the workbook reference; call when removing the sheet from a workbook.

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

Dispose(Boolean)

Releases managed resources when disposing is true, clearing the workbook reference and preventing reuse.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
System.Boolean disposing

The disposing.

EndUndoGroup()

Closes the current logical undo group, allowing the grouped commands to be undone or redone as a unit.

Declaration
public void EndUndoGroup()

OnIsProtectedChanged()

Raises the IsProtectedChanged event, notifying subscribers that protection status has toggled.

Declaration
protected virtual void OnIsProtectedChanged()

OnLayoutInvalidated()

Raises the LayoutInvalidated event, signaling that UI should recalculate positions and sizes.

Declaration
protected virtual void OnLayoutInvalidated()

ResumeLayoutUpdate()

Re-enables layout invalidation notifications and raises any deferred LayoutInvalidated event if changes occurred.

Declaration
protected virtual void ResumeLayoutUpdate()

SuspendLayoutUpdate()

Defers layout invalidation notifications until ResumeLayoutUpdate is called, improving performance during batch modifications.

Declaration
protected virtual void SuspendLayoutUpdate()

Events

IsProtectedChanged

Raised when sheet protection is applied or removed, signaling that UI should update editing controls.

Declaration
public event EventHandler IsProtectedChanged
Event Type
System.EventHandler

LayoutInvalidated

Raised when sheet content changes require layout recalculation, unless layout updates are suspended.

Declaration
public event EventHandler LayoutInvalidated
Event Type
System.EventHandler

Implements

NameChanged

Raised when the sheet's name changes, allowing UI to refresh tab labels.

Declaration
public event EventHandler NameChanged
Event Type
System.EventHandler

Explicit Interface Implementations

ISheet.InvalidateLayout()

Declaration
void ISheet.InvalidateLayout()
Implements

ISheet.ResumeLayoutUpdate()

Declaration
void ISheet.ResumeLayoutUpdate()
Implements

ISheet.SuspendLayoutUpdate()

Declaration
void ISheet.SuspendLayoutUpdate()
Implements

ISheet.ViewState

Declaration
ISheetViewState ISheet.ViewState { get; }
Returns
ISheetViewState

Implements