API Reference
LegacyXlsComment
Represents a legacy XLS cell comment parsed from NOTE/OBJ/TXO records.
Inheritance
- Object
- LegacyXlsComment
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 LegacyXlsWorksheet.Comments
Constructors
public LegacyXlsComment(Int32 row, Int32 column, String text, String author, UInt16 objectId, Boolean visible, IReadOnlyList<LegacyXlsCommentFormattingRun> formattingRuns = null, Nullable<UInt16> objectType = null, Nullable<UInt16> objectFlags = null, LegacyXlsDrawingAnchor anchor = null) #Creates parsed legacy XLS comment metadata.
Parameters
- row System.Int32
- column System.Int32
- text System.String
- author System.String
- objectId System.UInt16
- visible System.Boolean
- formattingRuns System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsCommentFormattingRun} = null
- objectType System.Nullable{System.UInt16} = null
- objectFlags System.Nullable{System.UInt16} = null
- anchor OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingAnchor = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Int32 Row { get; } #Gets the 1-based row containing the comment.
public Int32 Column { get; } #Gets the 1-based column containing the comment.
public String Text { get; } #Gets the plain comment text.
public String Author { get; } #Gets the comment author.
public UInt16 ObjectId { get; } #Gets the BIFF object id associated with the comment.
public Boolean Visible { get; } #Gets whether the source comment was configured as always visible.
public IReadOnlyList<LegacyXlsCommentFormattingRun> FormattingRuns { get; } #Gets rich text run boundaries and font indexes from the source TxO records.
public Nullable<UInt16> ObjectType { get; } #Gets the decoded OBJ common-object type identifier, when present.
public Nullable<LegacyXlsDrawingObjectType> ObjectTypeKind { get; } #Gets the decoded OBJ common-object type, when the identifier is known.
public String ObjectTypeName { get; } #Gets a stable display name for the decoded OBJ common-object type, or a hexadecimal fallback for unknown types.
public Nullable<UInt16> ObjectFlags { get; } #Gets the decoded OBJ common-object flag bitfield, when present.
public IReadOnlyList<String> ObjectFlagNames { get; } #Gets stable names for the defined common-object flags set on the comment OBJ record.
public LegacyXlsDrawingAnchor Anchor { get; } #Gets the OfficeArt client anchor associated with the comment object, when present.
public Boolean HasAnchor { get; } #Gets whether the comment has preserved OfficeArt client-anchor geometry.
public Boolean IsObjectLocked { get; } #Gets whether the comment object is locked.
public Boolean IsObjectPrintable { get; } #Gets whether the comment object is intended to be printed.