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).
Definition
Namespace:Telerik.Documents.Spreadsheet.Model
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public abstract class Sheet : NotifyPropertyChangedBase, INotifyPropertyChanged, ISheet, IDisposableInheritance: objectNotifyPropertyChangedBaseSheet
Derived Classes:
Implements:
Inherited Members
Properties
Indicates whether layout invalidation events are deferred, typically during batch operations to avoid redundant recalculations.
public bool IsLayoutUpdateSuspended { get; }The value indicating whether the layout update is suspended.
Implements:
Indicates whether sheet protection is currently enforced, restricting user modifications based on protection options.
public bool IsProtected { get; }The is protected.
User-visible sheet name displayed on tabs, validated for uniqueness and Excel naming constraints (length, forbidden characters).
public string Name { get; set; }The name of the sheet.
Implements:
Gets the sheet page setup.
protected abstract SheetPageSetupBase SheetPageSetup { get; }The sheet page setup.
Discriminates the sheet category (Worksheet, future chart sheets) to route type-specific operations.
public abstract SheetType Type { get; }The type of the sheet.
Implements:
Controls whether the sheet is visible, hidden, or very hidden (hidden from UI visibility toggles).
public SheetVisibility Visibility { get; set; }The visibility.
Implements:
Methods
Begins a logical undo group so that subsequent commands are undone or redone together as a single user action.
public void BeginUndoGroup()Creates the view state object that tracks panes, selection, and scroll position for this sheet type.
Releases resources held by the sheet, primarily clearing the workbook reference; call when removing the sheet from a workbook.
public void Dispose()Implements:
Releases managed resources when disposing is true, clearing the workbook reference and preventing reuse.
Closes the current logical undo group, allowing the grouped commands to be undone or redone as a unit.
public void EndUndoGroup()Raises the IsProtectedChanged event, notifying subscribers that protection status has toggled.
protected virtual void OnIsProtectedChanged()Raises the LayoutInvalidated event, signaling that UI should recalculate positions and sizes.
protected virtual void OnLayoutInvalidated()Re-enables layout invalidation notifications and raises any deferred LayoutInvalidated event if changes occurred.
protected virtual void ResumeLayoutUpdate()Defers layout invalidation notifications until ResumeLayoutUpdate is called, improving performance during batch modifications.
protected virtual void SuspendLayoutUpdate()Events
Raised when sheet protection is applied or removed, signaling that UI should update editing controls.
public event EventHandler IsProtectedChangedRaised when sheet content changes require layout recalculation, unless layout updates are suspended.
public event EventHandler LayoutInvalidatedImplements:
Raised when the sheet's name changes, allowing UI to refresh tab labels.
public event EventHandler NameChanged