Class

Sheet

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

Declaration

public bool IsLayoutUpdateSuspended { get; }

Property Value

Implements ISheet.IsLayoutUpdateSuspended

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

Declaration

public bool IsProtected { get; }

Property Value

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

Implements ISheet.Name

Gets the sheet page setup.

Declaration

protected abstract SheetPageSetupBase SheetPageSetup { get; }

Property Value

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

Declaration

public abstract SheetType Type { get; }

Property Value

Implements ISheet.Type

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

Declaration

public SheetVisibility Visibility { get; set; }

Property Value

Implements ISheet.Visibility

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

Implements ISheet.Workbook

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

Declaration

public void BeginUndoGroup()

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

Declaration

protected abstract ISheetViewState CreateViewState()

Returns

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

Declaration

public void Dispose()

Implements IDisposable.Dispose()

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

Declaration

protected virtual void Dispose(bool disposing)

Parameters

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

Declaration

public void EndUndoGroup()

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

Declaration

protected virtual void OnIsProtectedChanged()

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

Declaration

protected virtual void OnLayoutInvalidated()

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

Declaration

protected virtual void ResumeLayoutUpdate()

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

Declaration

protected virtual void SuspendLayoutUpdate()

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

Declaration

public event EventHandler IsProtectedChanged

Event Value

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

Declaration

public event EventHandler LayoutInvalidated

Event Value

Implements ISheet.LayoutInvalidated

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

Declaration

public event EventHandler NameChanged

Event Value