API Reference

Class

LegacyXlsDrawingRecord

Namespace OfficeIMO.Excel.LegacyXls.Model
Assembly OfficeIMO.Excel
Modifiers sealed

Describes a preserve-only drawing or object BIFF record discovered during legacy XLS import.

Inheritance

  • Object
  • LegacyXlsDrawingRecord

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 LegacyXlsDrawingRecord(LegacyXlsDrawingRecordKind kind, String recordName, String sheetName, Int32 recordOffset, UInt16 recordType, Int32 payloadLength, Nullable<UInt16> objectType = null, Nullable<UInt16> objectId = null, Nullable<UInt16> escherRecordType = null, Nullable<UInt16> escherRecordInstance = null, Nullable<Byte> escherRecordVersion = null, Nullable<UInt32> escherPayloadLength = null, Nullable<LegacyXlsDrawingObjectType> objectTypeKind = null, Nullable<LegacyXlsDrawingEscherRecordType> escherRecordTypeKind = null, Nullable<UInt16> objectFlags = null, IReadOnlyList<LegacyXlsDrawingBlipStoreEntry> blipStoreEntries = null, IReadOnlyList<LegacyXlsDrawingShape> shapeEntries = null, IReadOnlyList<LegacyXlsDrawingAnchor> anchorEntries = null, IReadOnlyList<LegacyXlsDrawingChildAnchor> childAnchorEntries = null, IReadOnlyList<LegacyXlsDrawingOfficeArtRecord> officeArtRecords = null, IReadOnlyList<LegacyXlsDrawingGroupBlock> drawingGroupBlocks = null, IReadOnlyList<LegacyXlsDrawingGroupInfo> drawingGroupInfos = null, IReadOnlyList<LegacyXlsDrawingShapeProperty> shapeProperties = null, IReadOnlyList<LegacyXlsDrawingObjectSubRecord> objectSubRecords = null, LegacyXlsDrawingFutureRecordHeader futureRecordHeader = null, LegacyXlsDrawingTextObject textObject = null) #

Creates drawing BIFF record metadata.

Parameters

kind OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingRecordKind requiredposition: 0
recordName System.String requiredposition: 1
sheetName System.String requiredposition: 2
recordOffset System.Int32 requiredposition: 3
recordType System.UInt16 requiredposition: 4
payloadLength System.Int32 requiredposition: 5
objectType System.Nullable{System.UInt16} = null optionalposition: 6
objectId System.Nullable{System.UInt16} = null optionalposition: 7
escherRecordType System.Nullable{System.UInt16} = null optionalposition: 8
escherRecordInstance System.Nullable{System.UInt16} = null optionalposition: 9
escherRecordVersion System.Nullable{System.Byte} = null optionalposition: 10
escherPayloadLength System.Nullable{System.UInt32} = null optionalposition: 11
objectTypeKind System.Nullable{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingObjectType} = null optionalposition: 12
escherRecordTypeKind System.Nullable{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingEscherRecordType} = null optionalposition: 13
objectFlags System.Nullable{System.UInt16} = null optionalposition: 14
blipStoreEntries System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingBlipStoreEntry} = null optionalposition: 15
shapeEntries System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingShape} = null optionalposition: 16
anchorEntries System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingAnchor} = null optionalposition: 17
childAnchorEntries System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingChildAnchor} = null optionalposition: 18
officeArtRecords System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingOfficeArtRecord} = null optionalposition: 19
drawingGroupBlocks System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingGroupBlock} = null optionalposition: 20
drawingGroupInfos System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingGroupInfo} = null optionalposition: 21
shapeProperties System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingShapeProperty} = null optionalposition: 22
objectSubRecords System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingObjectSubRecord} = null optionalposition: 23
futureRecordHeader OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingFutureRecordHeader = null optionalposition: 24
textObject OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDrawingTextObject = null optionalposition: 25

Properties

public LegacyXlsDrawingRecordKind Kind { get; } #

Gets the shallow drawing record category.

public String RecordName { get; } #

Gets the BIFF record name.

public String SheetName { get; } #

Gets the worksheet or chart sheet name associated with the record, when known.

public Int32 RecordOffset { get; } #

Gets the byte offset of the BIFF record.

public UInt16 RecordType { get; } #

Gets the BIFF record type identifier.

public Int32 PayloadLength { get; } #

Gets the BIFF record payload length in bytes.

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> ObjectId { get; } #

Gets the decoded OBJ object identifier, when present.

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 this OBJ record.

public IReadOnlyList<LegacyXlsDrawingObjectSubRecord> ObjectSubRecords { get; } #

Gets preserve-only subrecord metadata discovered inside this OBJ record.

public Boolean HasObjectSubRecords { get; } #

Gets whether this OBJ record contains discovered subrecords.

public LegacyXlsDrawingFutureRecordHeader FutureRecordHeader { get; } #

Gets the decoded future-record stream header, when this drawing record uses that wrapper.

public Boolean HasFutureRecordHeader { get; } #

Gets whether this drawing record has a decoded future-record stream header.

public LegacyXlsDrawingTextObject TextObject { get; } #

Gets decoded TxO text-object header metadata, when this record is a TxO record.

public Boolean HasTextObject { get; } #

Gets whether this record has decoded TxO text-object header metadata.

public Boolean IsObjectLocked { get; } #

Gets whether the object is locked.

public Boolean UsesDefaultObjectSize { get; } #

Gets whether the application is expected to choose the object size.

public Boolean IsObjectPublished { get; } #

Gets whether this chart object is expected to be published with the sheet.

public Boolean IsObjectPrintable { get; } #

Gets whether the object is intended to be printed.

public Boolean IsObjectDisabled { get; } #

Gets whether the object is disabled.

public Boolean IsUiObject { get; } #

Gets whether this is an application-inserted UI object.

public Boolean RecalculatesObjectOnLoad { get; } #

Gets whether the object is expected to recalculate from its linked range on load.

public Boolean AlwaysRecalculatesObject { get; } #

Gets whether the object is expected to recalculate whenever its linked range changes.

public Nullable<UInt16> EscherRecordType { get; } #

Gets the top-level Escher record type from MsoDrawing payloads, when present.

public Nullable<LegacyXlsDrawingEscherRecordType> EscherRecordTypeKind { get; } #

Gets the top-level Escher OfficeArt record type, when the identifier is known.

public String EscherRecordTypeName { get; } #

Gets a stable display name for the top-level Escher record type, or a hexadecimal fallback for unknown types.

public Nullable<UInt16> EscherRecordInstance { get; } #

Gets the top-level Escher record instance from MsoDrawing payloads, when present.

public Nullable<Byte> EscherRecordVersion { get; } #

Gets the top-level Escher record version from MsoDrawing payloads, when present.

public Nullable<UInt32> EscherPayloadLength { get; } #

Gets the declared top-level Escher payload length from MsoDrawing payloads, when present.

public IReadOnlyList<LegacyXlsDrawingBlipStoreEntry> BlipStoreEntries { get; } #

Gets preserve-only OfficeArt FBSE image-store entries discovered under this drawing record.

public Boolean HasBlipStoreEntries { get; } #

Gets whether this drawing record contains any discovered image-store entries.

public IReadOnlyList<LegacyXlsDrawingShape> ShapeEntries { get; } #

Gets preserve-only OfficeArt shape entries discovered under this drawing record.

public Boolean HasShapeEntries { get; } #

Gets whether this drawing record contains any discovered shape entries.

public IReadOnlyList<LegacyXlsDrawingAnchor> AnchorEntries { get; } #

Gets preserve-only OfficeArt client anchors discovered under this drawing record.

public Boolean HasAnchorEntries { get; } #

Gets whether this drawing record contains any discovered client anchors.

public IReadOnlyList<LegacyXlsDrawingChildAnchor> ChildAnchorEntries { get; } #

Gets preserve-only OfficeArt child anchors discovered under this drawing record.

public Boolean HasChildAnchorEntries { get; } #

Gets whether this drawing record contains any discovered child anchors.

public IReadOnlyList<LegacyXlsDrawingOfficeArtRecord> OfficeArtRecords { get; } #

Gets preserve-only OfficeArt record headers discovered while traversing this drawing record.

public Boolean HasOfficeArtRecords { get; } #

Gets whether this drawing record contains discovered OfficeArt record headers.

public IReadOnlyList<LegacyXlsDrawingGroupBlock> DrawingGroupBlocks { get; } #

Gets preserve-only document-wide OfficeArtFDGGBlock drawing metadata discovered under this record.

public Boolean HasDrawingGroupBlocks { get; } #

Gets whether this drawing record contains document-wide OfficeArtFDGGBlock metadata.

public IReadOnlyList<LegacyXlsDrawingGroupInfo> DrawingGroupInfos { get; } #

Gets preserve-only per-drawing OfficeArtFDG metadata discovered under this record.

public Boolean HasDrawingGroupInfos { get; } #

Gets whether this drawing record contains per-drawing OfficeArtFDG metadata.

public IReadOnlyList<LegacyXlsDrawingShapeProperty> ShapeProperties { get; } #

Gets preserve-only OfficeArtFOPT shape properties discovered under this drawing record.

public Boolean HasShapeProperties { get; } #

Gets whether this drawing record contains discovered OfficeArtFOPT shape properties.