API Reference
LegacyXlsImportDiagnostic
Describes an import issue, unsupported feature, or compatibility note discovered in a legacy XLS file.
Inheritance
- Object
- LegacyXlsImportDiagnostic
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 ExcelDocument.LegacyXlsImportDiagnostics
- Property LegacyXlsLoadResult.Diagnostics
- Property LegacyXlsWorkbook.Diagnostics
Constructors
public LegacyXlsImportDiagnostic(LegacyXlsDiagnosticSeverity severity, String code, String message, String sheetName = null, Nullable<Int32> recordOffset = null, Nullable<UInt16> recordType = null, String detailCode = null, String formulaContext = null, Nullable<Byte> formulaToken = null, Nullable<Int32> formulaTokenOffset = null, String formulaTokenName = null) #Creates a diagnostic for a legacy XLS import issue or feature note.
Parameters
- severity OfficeIMO.Excel.LegacyXls.Diagnostics.LegacyXlsDiagnosticSeverity
- Diagnostic severity.
- code System.String
- Stable diagnostic code.
- message System.String
- Human-readable diagnostic message.
- sheetName System.String = null
- Optional worksheet name associated with the diagnostic.
- recordOffset System.Nullable{System.Int32} = null
- Optional byte offset of the related BIFF record.
- recordType System.Nullable{System.UInt16} = null
- Optional BIFF record type identifier.
- detailCode System.String = null
- Optional stable detail key for grouped import reports.
- formulaContext System.String = null
- Optional formula source context associated with formula-token diagnostics.
- formulaToken System.Nullable{System.Byte} = null
- Optional BIFF formula token byte associated with formula-token diagnostics.
- formulaTokenOffset System.Nullable{System.Int32} = null
- Optional zero-based parsed-expression token offset associated with formula-token diagnostics.
- formulaTokenName System.String = null
- Optional BIFF formula token name associated with formula-token diagnostics.
Methods
public override String ToString() #StringReturns a compact diagnostic string for logs and test output.
Inherited Methods
Properties
public LegacyXlsDiagnosticSeverity Severity { get; } #Gets the diagnostic severity.
public String Code { get; } #Gets the stable diagnostic code.
public String Message { get; } #Gets the human-readable diagnostic message.
public String SheetName { get; } #Gets the worksheet name associated with the diagnostic, when known.
public Nullable<Int32> RecordOffset { get; } #Gets the byte offset of the related BIFF record, when known.
public Nullable<UInt16> RecordType { get; } #Gets the BIFF record type identifier, when known.
public String DetailCode { get; } #Gets a stable detail key for report grouping, when available.
public String FormulaContext { get; } #Gets the formula source context associated with a formula-token diagnostic, when available.
public Nullable<Byte> FormulaToken { get; } #Gets the BIFF formula token byte associated with a formula-token diagnostic, when available.
public String FormulaTokenName { get; } #Gets the BIFF formula token name associated with a formula-token diagnostic, when available.
public Nullable<Int32> FormulaTokenOffset { get; } #Gets the zero-based offset of FormulaToken within the parsed-expression token stream, when available.