API Reference
LegacyXlsDrawingTextObject
Describes the fixed header of a legacy BIFF TxO text-object record.
Inheritance
- Object
- LegacyXlsDrawingTextObject
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 LegacyXlsDrawingRecord.TextObject
Accepted by parameters
Constructors
public LegacyXlsDrawingTextObject(UInt16 rawOptions, UInt16 rotation, UInt16 textCharacterCount, UInt16 formattingRunByteCount, UInt16 emptyFontIndex, Int32 formulaByteCount, String text = null, IReadOnlyList<LegacyXlsCommentFormattingRun> formattingRuns = null) #Creates TxO text-object metadata.
Parameters
- rawOptions System.UInt16
- rotation System.UInt16
- textCharacterCount System.UInt16
- formattingRunByteCount System.UInt16
- emptyFontIndex System.UInt16
- formulaByteCount System.Int32
- text System.String = null
- formattingRuns System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsCommentFormattingRun} = null
Methods
WithDecodedText(System.String arg1, System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsCommentFormattingRun} arg2) #Creates a copy that includes decoded Continue-record text and formatting runs.
Parameters
- arg1 System.String
- arg2 System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsCommentFormattingRun}
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public UInt16 RawOptions { get; } #Gets the raw TxO option bitfield.
public UInt16 HorizontalAlignment { get; } #Gets the decoded horizontal alignment value.
public String HorizontalAlignmentName { get; } #Gets a stable display name for the horizontal alignment value.
public UInt16 VerticalAlignment { get; } #Gets the decoded vertical alignment value.
public String VerticalAlignmentName { get; } #Gets a stable display name for the vertical alignment value.
public Boolean LockedText { get; } #Gets whether the TxO text is locked.
public Boolean JustifyLastLine { get; } #Gets whether the last line is justified.
public Boolean SecretEdit { get; } #Gets whether secret edit mode is enabled.
public UInt16 Rotation { get; } #Gets the raw TxO rotation value.
public String RotationName { get; } #Gets a stable display name for the rotation value.
public UInt16 TextCharacterCount { get; } #Gets the declared character count of text stored in following Continue records.
public UInt16 FormattingRunByteCount { get; } #Gets the declared byte count of formatting runs stored in following Continue records.
public UInt16 EmptyFontIndex { get; } #Gets the font index used when the text is empty.
public Int32 FormulaByteCount { get; } #Gets the number of bytes available for the optional TxO formula field.
public String Text { get; } #Gets decoded TxO text from following Continue records when available.
public Boolean HasDecodedText { get; } #Gets a value indicating whether text from following Continue records was decoded.
public IReadOnlyList<LegacyXlsCommentFormattingRun> FormattingRuns { get; } #Gets decoded formatting runs from following Continue records when available.
public Boolean HasTextInContinueRecords { get; } #Gets whether this TxO declares text payload in following Continue records.
public Boolean HasFormattingRunsInContinueRecords { get; } #Gets whether this TxO declares formatting-run payload in following Continue records.