Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelWorksheetInfo

OfficeIMO.Excel

Namespace
OfficeIMO.Excel
Assembly
OfficeIMO.Excel
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

Immutable worksheet inspection snapshot.

Inheritance

  • object
  • ExcelWorksheetInfo

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public ExcelWorksheetInfo() #

Properties

public string Name { get; internal set; } #

Worksheet name.

public int ConditionalFormattingRuleCount { get; internal set; } #

Number of standard and Office extension conditional-formatting rules captured with this worksheet.

public int Index { get; internal set; } #

Zero-based worksheet index in workbook order.

public bool Hidden { get; internal set; } #

Whether the worksheet is hidden.

public string VisibilityState { get; internal set; } #

Loaded Open XML worksheet state token: visible, hidden, or veryHidden. Defaults to visible when the state is absent.

public bool IsActive { get; internal set; } #

Whether the worksheet is the workbook's active worksheet.

public bool RightToLeft { get; internal set; } #

Whether the worksheet is displayed right-to-left.

public bool ShowGridlines { get; internal set; } #

Whether worksheet gridlines are visible.

public string? View { get; internal set; } #

Worksheet view mode, when present.

public uint? ZoomScale { get; internal set; } #

Active worksheet zoom percentage, when present.

public uint? ZoomScaleNormal { get; internal set; } #

Normal-view worksheet zoom percentage, when present.

public string? TabColorArgb { get; internal set; } #

Worksheet tab color in ARGB hexadecimal form, when present.

public bool? OutlineSummaryBelow { get; internal set; } #

Whether row summary controls appear below grouped rows, when specified.

public bool? OutlineSummaryRight { get; internal set; } #

Whether column summary controls appear to the right of grouped columns, when specified.

public int FrozenRowCount { get; internal set; } #

Number of frozen rows detected on the worksheet.

public int FrozenColumnCount { get; internal set; } #

Number of frozen columns detected on the worksheet.

public string UsedRangeA1 { get; internal set; } #

Used-range address in A1 notation.

public IReadOnlyList<ExcelCellInfo> Cells { get; } #

Non-empty cells discovered during inspection.

public IReadOnlyList<ExcelMergedRangeInfo> MergedRanges { get; } #

Merged ranges discovered during inspection.

public IReadOnlyList<ExcelColumnInfo> Columns { get; } #

Explicit column definitions discovered during inspection.

public IReadOnlyList<ExcelRowInfo> Rows { get; } #

Explicit row definitions discovered during inspection.

public IReadOnlyList<ExcelDataValidationInspectionInfo> Validations { get; } #

Worksheet data validations discovered during inspection.

public ExcelAutoFilterInspectionInfo? AutoFilter { get; internal set; } #

Worksheet-level auto filter discovered during inspection, when present.

public ExcelWorksheetProtectionInfo? Protection { get; internal set; } #

Worksheet protection discovered during inspection, when present.

public IReadOnlyList<ExcelTableInspectionInfo> Tables { get; } #

Tables discovered on the worksheet.

public IReadOnlyList<ExcelThreadedCommentInfo> ThreadedComments { get; } #

Threaded comments discovered on the worksheet.