API Reference
LegacyXlsWorksheet
Represents a worksheet parsed from a legacy XLS workbook stream.
Inheritance
- Object
- LegacyXlsWorksheet
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property LegacyXlsWorkbook.Worksheets
Constructors
public LegacyXlsWorksheet(String name, Int32 streamOffset, Byte visibility, Byte sheetType) #Creates a parsed legacy XLS worksheet.
Parameters
- name System.String
- Worksheet name.
- streamOffset System.Int32
- Byte offset of the worksheet substream in the BIFF workbook stream.
- visibility System.Byte
- Legacy worksheet visibility flag.
- sheetType System.Byte
- Legacy sheet type flag.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Name { get; } #Gets the worksheet name.
public Int32 StreamOffset { get; } #Gets the byte offset of the worksheet substream in the BIFF workbook stream.
public Byte Visibility { get; } #Gets the legacy visibility flag.
public Nullable<LegacyXlsSheetVisibility> VisibilityKind { get; } #Gets the decoded sheet visibility state, when the BoundSheet value is recognized.
public String VisibilityName { get; } #Gets the decoded sheet visibility state name, or a hexadecimal fallback for unknown values.
public Byte SheetType { get; } #Gets the legacy sheet type flag.
public String CodeName { get; set; } #Gets the sheet object name used by the VBA project, when specified.
public IReadOnlyList<LegacyXlsCell> Cells { get; } #Gets the parsed cells for this worksheet.
public IReadOnlyList<LegacyXlsColumnLayout> Columns { get; } #Gets parsed column layout metadata for this worksheet.
public IReadOnlyList<LegacyXlsCellWatch> CellWatches { get; } #Gets watched-cell metadata parsed for this worksheet.
public IReadOnlyList<LegacyXlsComment> Comments { get; } #Gets parsed cell comments for this worksheet.
public IReadOnlyList<LegacyXlsConditionalFormatting> ConditionalFormattings { get; } #Gets parsed conditional formatting rules for this worksheet.
public IReadOnlyList<LegacyXlsConditionalFormattingExtensionRecord> ConditionalFormattingExtensions { get; } #Gets preserve-only conditional-formatting extension records for this worksheet.
public IReadOnlyList<LegacyXlsDataValidation> DataValidations { get; } #Gets parsed data validation rules for this worksheet.
public IReadOnlyList<LegacyXlsDataValidationCollectionRecord> DataValidationCollections { get; } #Gets parsed DVal collection headers for this worksheet.
public LegacyXlsDataConsolidationSettings DataConsolidationSettings { get; set; } #Gets worksheet-level data-consolidation settings parsed from a BIFF DCon record.
public IReadOnlyList<LegacyXlsArrayFormulaRecord> ArrayFormulaRecords { get; } #Gets preserve/projection metadata for Array formula records discovered on this worksheet.
public IReadOnlyList<LegacyXlsAutoFilterCriteria> AutoFilterCriteria { get; } #Gets parsed AutoFilter criteria for this worksheet.
public Nullable<UInt16> AutoFilterDropDownCount { get; set; } #Gets the declared AutoFilter drop-down count, when present.
public IReadOnlyList<LegacyXlsPageBreak> ColumnPageBreaks { get; } #Gets explicit manual column page breaks parsed for this worksheet.
public LegacyXlsPhoneticSettings PhoneticSettings { get; set; } #Gets worksheet-level phonetic display defaults parsed from a BIFF PhoneticInfo record.
public IReadOnlyList<LegacyXlsHyperlink> Hyperlinks { get; } #Gets parsed hyperlinks for this worksheet.
public IReadOnlyList<LegacyXlsIgnoredError> IgnoredErrors { get; } #Gets ignored formula error metadata parsed from BIFF8 shared-feature records.
public IReadOnlyList<LegacyXlsProtectedRange> ProtectedRanges { get; } #Gets protected ranges parsed from BIFF8 worksheet shared-feature records.
public IReadOnlyList<LegacyXlsMergedRange> MergedRanges { get; } #Gets parsed merged ranges for this worksheet.
public IReadOnlyList<LegacyXlsWorksheetMetadataRecord> MetadataRecords { get; } #Gets decoded worksheet metadata source records.
public IReadOnlyList<LegacyXlsSheetFutureMetadataRecord> FutureMetadataRecords { get; } #Gets preserve-only extended metadata records decoded from this worksheet or chart-sheet substream.
public IReadOnlyList<LegacyXlsPageBreak> RowPageBreaks { get; } #Gets explicit manual row page breaks parsed for this worksheet.
public IReadOnlyList<LegacyXlsScenario> Scenarios { get; } #Gets worksheet scenarios parsed from SCENARIO records.
public IReadOnlyList<LegacyXlsRowLayout> Rows { get; } #Gets parsed row layout metadata for this worksheet.
public IReadOnlyList<LegacyXlsSelection> Selections { get; } #Gets parsed worksheet selections.
public IReadOnlyList<LegacyXlsWorksheetWindowView> WindowViews { get; } #Gets worksheet-window view records parsed from BIFF Window2 records.
public LegacyXlsSortSettings SortSettings { get; set; } #Gets parsed worksheet sort dialog metadata, when present.
public LegacyXlsScenarioManager ScenarioManager { get; set; } #Gets scenario-manager metadata parsed from a ScenMan record.
public LegacyXlsFreezePane FreezePane { get; set; } #Gets parsed frozen pane metadata for this worksheet.
public LegacyXlsSplitPane SplitPane { get; set; } #Gets parsed non-frozen split pane metadata for this worksheet.
public Nullable<Boolean> FrozenWithoutSplit { get; set; } #Gets whether the frozen pane Window2 record requests the BIFF frozen-without-split state.
public LegacyXlsWorksheetProtection Protection { get; set; } #Gets parsed worksheet protection metadata.
public LegacyXlsWorksheetDimension DeclaredUsedRange { get; set; } #Gets the used-range bounds declared by the legacy worksheet DIMENSIONS record, when present.
public LegacyXlsPageSetup PageSetup { get; set; } #Gets parsed worksheet page setup metadata.
public LegacyXlsWorksheetIndex RowBlockIndex { get; set; } #Gets parsed row-block lookup metadata from the BIFF Index record, when present.
public Nullable<Boolean> AutomaticPageBreaksVisible { get; set; } #Gets whether automatic page breaks should be visible, when present.
public Nullable<Boolean> ApplyOutlineStyles { get; set; } #Gets whether outline styles should be applied automatically, when present.
public Nullable<Boolean> SummaryRowsBelow { get; set; } #Gets whether row summaries should appear below detail rows, when present.
public Nullable<Boolean> SummaryColumnsRightWhenLeftToRight { get; set; } #Gets whether column summaries should appear to the right in left-to-right sheets, when present.
public Nullable<Boolean> SynchronizedHorizontalScrolling { get; set; } #Gets whether horizontal scrolling should be synchronized with another sheet, when present.
public Nullable<Boolean> SynchronizedVerticalScrolling { get; set; } #Gets whether vertical scrolling should be synchronized with another sheet, when present.
public Nullable<Boolean> TransitionFormulaEvaluation { get; set; } #Gets whether transition formula evaluation is enabled, when present.
public Nullable<Boolean> TransitionFormulaEntry { get; set; } #Gets whether transition formula entry is enabled, when present.
public Nullable<Byte> RowOutlineLevel { get; set; } #Gets the maximum row outline level, when present.
public Nullable<Byte> ColumnOutlineLevel { get; set; } #Gets the maximum column outline level, when present.
public Nullable<Boolean> GridSet { get; set; } #Gets the legacy GridSet flag, when present.
public Nullable<Boolean> FullCalculationOnLoad { get; set; } #Gets whether formulas on this worksheet should be recalculated on load.
public Nullable<UInt32> ZoomScale { get; set; } #Gets the worksheet view zoom scale percentage, when present.
public Nullable<UInt32> ZoomScaleNormal { get; set; } #Gets the normal-view zoom scale percentage, when specified by the legacy window metadata.
public Nullable<Double> DefaultRowHeight { get; set; } #Gets the default row height in points, when specified by the legacy worksheet metadata.
public Nullable<Double> DefaultColumnWidth { get; set; } #Gets the default column width in character units, when specified by the legacy worksheet metadata.
public Nullable<Boolean> ShowGridLines { get; set; } #Gets whether worksheet view gridlines should be shown, when specified by the legacy window metadata.
public Nullable<Boolean> ShowFormulas { get; set; } #Gets whether cell formulas should be shown in the worksheet view, when specified by the legacy window metadata.
public Nullable<Boolean> ShowRowColumnHeadings { get; set; } #Gets whether worksheet row and column headings should be shown, when specified by the legacy window metadata.
public Nullable<Boolean> ShowZeroValues { get; set; } #Gets whether zero values should be shown in the worksheet view, when specified by the legacy window metadata.
public Nullable<Boolean> RightToLeft { get; set; } #Gets whether the worksheet view should be displayed from right to left, when specified by the legacy window metadata.
public Nullable<Boolean> DefaultGridColor { get; set; } #Gets whether the worksheet uses the default gridline color, when specified by the legacy window metadata.
public Nullable<UInt16> GridLineColorIndex { get; set; } #Gets the worksheet view gridline color index, when specified by the legacy window metadata.
public Nullable<Boolean> ShowOutlineSymbols { get; set; } #Gets whether outline symbols should be shown in the worksheet view, when specified by the legacy window metadata.
public Nullable<Boolean> TabSelected { get; set; } #Gets whether the worksheet tab is selected, when specified by the legacy window metadata.
public Nullable<Boolean> PageBreakPreview { get; set; } #Gets whether the worksheet is displayed in Page Break Preview view, when specified by the legacy window metadata.
public Nullable<Boolean> PageLayoutView { get; set; } #Gets whether the worksheet is displayed in Page Layout view, when specified by a PLV future record.
public Nullable<UInt32> PageLayoutZoomScale { get; set; } #Gets the Page Layout view zoom scale, when specified by a PLV future record.
public Nullable<UInt16> TabColorIndex { get; set; } #Gets the BIFF color index used for the worksheet tab color, when specified by a SheetExt record.
public Nullable<Int32> FirstVisibleRow { get; set; } #Gets the zero-based first visible row in the worksheet window, when specified by the legacy window metadata.
public Nullable<Int32> FirstVisibleColumn { get; set; } #Gets the zero-based first visible column in the worksheet window, when specified by the legacy window metadata.