API Reference
LegacyXlsWorkbook
Neutral workbook model produced from a legacy BIFF `.xls` stream.
Inheritance
- Object
- LegacyXlsWorkbook
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 LegacyXlsLoadResult.Workbook
- Method LegacyXlsWorkbook.Load
Accepted by parameters
Methods
public LegacyXlsImportReport CreateImportReport() #LegacyXlsImportReportCreates a compact import report for corpus baselines and preflight checks.
public static LegacyXlsWorkbook Load(Byte[] bytes, LegacyXlsImportOptions options = null) #LegacyXlsWorkbookLoads a legacy `.xls` workbook from a file path.
Parameters
- path System.String
- options OfficeIMO.Excel.LegacyXls.LegacyXlsImportOptions = null
Load(System.IO.Stream stream, OfficeIMO.Excel.LegacyXls.LegacyXlsImportOptions options) #Loads a legacy `.xls` workbook from a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.LegacyXls.LegacyXlsImportOptions
Load(System.Byte[] bytes, OfficeIMO.Excel.LegacyXls.LegacyXlsImportOptions options) #Loads a legacy `.xls` workbook from a byte array.
Parameters
- bytes System.Byte[]
- options OfficeIMO.Excel.LegacyXls.LegacyXlsImportOptions
public ExcelDocument ToExcelDocument() #ExcelDocumentProjects this legacy workbook into a normal OfficeIMO Excel document.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IReadOnlyList<LegacyXlsWorksheet> Worksheets { get; } #Gets worksheets parsed from the legacy workbook stream.
public IReadOnlyList<LegacyXlsNumberFormat> NumberFormats { get; } #Gets custom number formats parsed from FORMAT records.
public IReadOnlyList<LegacyXlsFont> Fonts { get; } #Gets fonts parsed from Font records.
public IReadOnlyList<String> PaletteColors { get; } #Gets custom palette colors parsed from the Palette record as ARGB hex values.
public IReadOnlyList<LegacyXlsCellFormat> CellFormats { get; } #Gets cell formats parsed from XF records.
public IReadOnlyList<LegacyXlsCellStyle> CellStyles { get; } #Gets workbook cell styles parsed from Style records.
public IReadOnlyList<LegacyXlsCellStyleExtension> CellStyleExtensions { get; } #Gets preserve-only cell style extension records parsed from XFExt records.
public IReadOnlyList<LegacyXlsDefinedName> DefinedNames { get; } #Gets defined names parsed from Lbl records.
public IReadOnlyList<LegacyXlsExternalReference> ExternalReferences { get; } #Gets supporting links discovered from SupBook records.
public IReadOnlyList<LegacyXlsExternalQueryConnection> ExternalQueryConnections { get; } #Gets preserve-only DBQueryExt query connection metadata discovered during import.
public IReadOnlyList<LegacyXlsDataConsolidationReference> DataConsolidationReferences { get; } #Gets preserve-only DConRef source ranges discovered during import.
public IReadOnlyList<LegacyXlsDataConsolidationName> DataConsolidationNames { get; } #Gets DConName named consolidation sources discovered during import.
public IReadOnlyList<LegacyXlsPivotTableRecord> PivotTableRecords { get; } #Gets preserve-only PivotTable BIFF records discovered during import.
public IReadOnlyList<LegacyXlsChartRecord> ChartRecords { get; } #Gets preserve-only chart BIFF records discovered during import.
public IReadOnlyList<LegacyXlsDrawingRecord> DrawingRecords { get; } #Gets preserve-only drawing and object BIFF records discovered during import.
public IReadOnlyList<LegacyXlsThemeRecord> ThemeRecords { get; } #Gets preserve-only workbook Theme records discovered during import.
public IReadOnlyList<LegacyXlsDifferentialFormat> DifferentialFormats { get; } #Gets parsed differential formats used by conditional formatting extensions.
public IReadOnlyList<LegacyXlsTableStyleCollection> TableStyleCollections { get; } #Gets preserve-only workbook table style collection records discovered during import.
public IReadOnlyList<LegacyXlsTableStyle> TableStyles { get; } #Gets preserve-only user-defined table styles discovered during import.
public IReadOnlyList<LegacyXlsCompoundFeatureRecord> CompoundFeatureRecords { get; } #Gets preserve-only compound container features discovered during import.
public LegacyXlsCalculationSettings CalculationSettings { get; } #Gets calculation settings parsed from BIFF calculation records.
public IReadOnlyList<LegacyXlsUnsupportedSheet> UnsupportedSheets { get; } #Gets legacy sheet entries discovered but not imported as worksheets.
public IReadOnlyList<LegacyXlsUnsupportedFeature> UnsupportedFeatures { get; } #Gets unsupported or preserve-only features discovered during import.
public IReadOnlyList<LegacyXlsPreservedFeatureRecord> PreservedFeatureRecords { get; } #Gets preserve-only BIFF feature records discovered during import.
public IReadOnlyList<LegacyXlsWorkbookMetadataRecord> MetadataRecords { get; } #Gets workbook-level BIFF metadata records decoded during import.
public IReadOnlyList<LegacyXlsWorkbookFutureMetadataRecord> FutureMetadataRecords { get; } #Gets preserve-only extended workbook metadata records decoded during import.
public IReadOnlyList<LegacyXlsFormulaTokenRecord> FormulaTokenRecords { get; } #Gets BIFF parsed-formula token observations captured during import for corpus diagnostics.
public IReadOnlyList<LegacyXlsFutureFunctionAlias> FutureFunctionAliases { get; } #Gets Excel future-function aliases discovered from BIFF defined-name records.
public LegacyXlsSheetTabIdCollection SheetTabIds { get; set; } #Gets workbook sheet tab identifiers decoded from a TabId record.
public IReadOnlyList<LegacyXlsWorkbookWindow> Windows { get; } #Gets workbook windows decoded from Window1 records.
public IReadOnlyList<LegacyXlsImportDiagnostic> Diagnostics { get; } #Gets diagnostics produced while reading the legacy workbook.
public Boolean Uses1904DateSystem { get; set; } #Gets whether the workbook uses the Excel 1904 date system.
public Nullable<UInt16> CodePage { get; set; } #Gets the workbook text code page decoded from a CodePage record.
public String CodeName { get; set; } #Gets the workbook object name used by the VBA project, when specified.
public Nullable<UInt16> UserInterfaceCodePage { get; set; } #Gets the user interface code page decoded from an InterfaceHdr record.
public LegacyXlsCountryInfo Country { get; set; } #Gets country and region metadata decoded from a Country record.
public Nullable<Boolean> SaveBackup { get; set; } #Gets whether the workbook requested saving a backup copy.
public Nullable<Boolean> DoNotSaveExternalLinkValues { get; set; } #Gets whether external-link values should not be saved with the workbook.
public Nullable<Boolean> HasEnvelope { get; set; } #Gets whether the workbook has an envelope.
public Nullable<Boolean> EnvelopeVisible { get; set; } #Gets whether the workbook envelope is visible.
public Nullable<Boolean> EnvelopeInitialized { get; set; } #Gets whether the workbook envelope was initialized.
public Nullable<Byte> ExternalLinkUpdateMode { get; set; } #Gets the raw external-link update mode decoded from BookBool flags.
public Nullable<Boolean> HideBordersForInactiveTables { get; set; } #Gets whether borders are hidden for inactive tables.
public Nullable<UInt16> BuiltInFunctionGroupCount { get; set; } #Gets the number of built-in function categories decoded from a BuiltInFnGroupCount record.
public Nullable<Boolean> UsesNaturalLanguageFormulas { get; set; } #Gets whether the workbook supports natural language formulas.
public Boolean HasRefreshAllMarker { get; set; } #Gets whether the workbook stream contains a RefreshAll marker.
public Boolean HasVbaProjectMarker { get; set; } #Gets whether the workbook stream contains an ObProj marker for a VBA project.
public Boolean HasVbaProjectWithoutMacros { get; set; } #Gets whether the workbook stream declares a VBA project with no forms, modules, or class modules.
public Nullable<Boolean> WindowsLocked { get; set; } #Gets whether workbook windows are locked from moving or resizing.
public Nullable<Boolean> RevisionTrackingLocked { get; set; } #Gets whether workbook revision tracking is locked.
public Nullable<UInt16> RevisionTrackingPasswordHash { get; set; } #Gets the legacy password verifier for workbook revision-tracking protection.
public Nullable<UInt16> PrintSize { get; set; } #Gets the raw print size mode decoded from a PrintSize record.
public String LastWriteUserName { get; set; } #Gets the user name stored by the WriteAccess record, if present.
public LegacyXlsWriteReservation WriteReservation { get; set; } #Gets workbook write-reservation metadata parsed from a FileSharing record, if present.
public LegacyXlsWorkbookProtection Protection { get; set; } #Gets parsed workbook protection metadata.