API Reference
LegacyXlsFormulaTokenRecord
Describes one BIFF parsed-formula token observed while importing a legacy XLS workbook.
Inheritance
- Object
- LegacyXlsFormulaTokenRecord
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
Constructors
public LegacyXlsFormulaTokenRecord(String context, String sheetName, String cellReference, Int32 recordOffset, UInt16 recordType, Byte token, String tokenName, Int32 tokenOffset, Nullable<Int32> sequenceIndex = null, String tokenClassName = null, Nullable<Int32> operandByteCount = null, Nullable<UInt16> functionId = null, String functionName = null, Nullable<Byte> functionParameterCount = null, Nullable<Boolean> functionIsCetab = null, Nullable<Byte> attribute = null, String attributeName = null, String operandKind = null, String operandText = null) #Creates formula token metadata for corpus diagnostics and XLS import planning.
Parameters
- context System.String
- sheetName System.String
- cellReference System.String
- recordOffset System.Int32
- recordType System.UInt16
- token System.Byte
- tokenName System.String
- tokenOffset System.Int32
- sequenceIndex System.Nullable{System.Int32} = null
- tokenClassName System.String = null
- operandByteCount System.Nullable{System.Int32} = null
- functionId System.Nullable{System.UInt16} = null
- functionName System.String = null
- functionParameterCount System.Nullable{System.Byte} = null
- functionIsCetab System.Nullable{System.Boolean} = null
- attribute System.Nullable{System.Byte} = null
- attributeName System.String = null
- operandKind System.String = null
- operandText System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Context { get; } #Gets the formula source context, such as CellFormula, SharedFormula, or DefinedName.
public String SheetName { get; } #Gets the worksheet name associated with the token, when known.
public String CellReference { get; } #Gets the formula cell reference associated with the token, when known.
public Int32 RecordOffset { get; } #Gets the byte offset of the BIFF record that supplied the formula token stream.
public UInt16 RecordType { get; } #Gets the BIFF record type that supplied the formula token stream.
public Byte Token { get; } #Gets the raw BIFF parsed-formula token byte.
public String TokenName { get; } #Gets the stable BIFF parsed-formula token name.
public Int32 TokenOffset { get; } #Gets the zero-based token offset within the parsed-expression token stream.
public Nullable<Int32> SequenceIndex { get; } #Gets the zero-based token sequence index within the parsed-expression token stream, when captured.
public String TokenClassName { get; } #Gets the decoded BIFF token class, when applicable.
public Nullable<Int32> OperandByteCount { get; } #Gets the byte count of the token operand payload after the token byte, when captured.
public Nullable<UInt16> FunctionId { get; } #Gets the BIFF built-in function identifier for function tokens, when available.
public String FunctionName { get; } #Gets the function name resolved from FunctionId, when known.
public Nullable<Byte> FunctionParameterCount { get; } #Gets the argument count carried by a function token, when available.
public Nullable<Boolean> FunctionIsCetab { get; } #Gets whether a variable-function token targets the CETAB extension function table.
public Nullable<Byte> Attribute { get; } #Gets the PtgAttr attribute byte, when the token is an attribute token.
public String AttributeName { get; } #Gets the stable attribute name for PtgAttr records, when available.
public String OperandKind { get; } #Gets the decoded operand category for tokens with structured payloads, such as literals, references, functions, and attributes.
public String OperandText { get; } #Gets a compact decoded operand value for diagnostics, when it can be represented without resolving workbook context.