Class OBJRecord

The OBJ record contains a partial description of a drawing object and the MSODRAWING, MSODRAWINGGROUP, and MSODRAWINGSELECTION records contain the remaining drawing object data.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
OBJRecord
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.OBJ)]
[CLSCompliant(false)]
public class OBJRecord : BiffRecordRaw, IBiffStorage, ICloneable

Constructors

OBJRecord()

Default constructor fills all data with default values.

Declaration
public OBJRecord()

OBJRecord(Int32)

Reserved for record's internal data array.

Declaration
public OBJRecord(int iReserve)
Parameters
Type Name Description
System.Int32 iReserve

Amount of bytes for data array.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If amount of bytes requested is less than zero.

OBJRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public OBJRecord(Stream stream, out int itemSize)
Parameters
Type Name Description
System.IO.Stream stream

Stream from which record data should be read.
System.Int32 itemSize

Size of read item.
Exceptions
Type Condition
System.ArgumentNullException

If stream is not specified.
System.ApplicationException

If stream does not support read or seek operations.

Properties

NeedDataArray

Indicates whether this record needs a data array after parsing is complete. Read-only.

Declaration
public override bool NeedDataArray { get; }
Property Value
Type
System.Boolean
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.NeedDataArray

Records

Read-only. Returns array of subrecords.

Declaration
public ObjSubRecord[] Records { get; }
Property Value
Type
ObjSubRecord[]

RecordsList

Read-only. Returns array of subrecords.

Declaration
public List<ObjSubRecord> RecordsList { get; }
Property Value
Type
System.Collections.Generic.List<ObjSubRecord>

Methods

AddSubRecord(ObjSubRecord)

Adds new subrecord.

Declaration
public void AddSubRecord(ObjSubRecord record)
Parameters
Type Name Description
ObjSubRecord record

Record to add.

Clone()

Creates a new object that is a copy of the current instance.

Declaration
public object Clone()
Returns
Type Description
System.Object

A new object that is a copy of this instance.

FindSubRecord(TObjSubRecordType)

Searches for the subrecord of the specified type.

Declaration
public ObjSubRecord FindSubRecord(TObjSubRecordType recordType)
Parameters
Type Name Description
TObjSubRecordType recordType

Record type to search for.
Returns
Type Description
ObjSubRecord

Found subrecord or null if not found.

FindSubRecordIndex(TObjSubRecordType)

Searches for the index of the subrecord with the specified type.

Declaration
public int FindSubRecordIndex(TObjSubRecordType recordType)
Parameters
Type Name Description
TObjSubRecordType recordType

Record type to search for.
Returns
Type Description
System.Int32

Index of the found subrecord or -1 if not found.

GetStoreSize(ExcelVersion)

Size of the required storage space. Read-only.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

GetSubRecord(DataProvider, Int32, Int32, TObjType)

Get subrecord by its offset.

Declaration
protected ObjSubRecord GetSubRecord(DataProvider provider, int offset, int iStartOffset, TObjType objectType)
Parameters
Type Name Description
DataProvider provider

Object that provides access to the data.
System.Int32 offset

Offset to the subrecord.
System.Int32 iStartOffset

Start offset of the OBJRecord.
TObjType objectType
Returns
Type Description
ObjSubRecord

Parsed subrecord from internal data array.

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Convert Data buffer to special values according to record specification.

Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
Type Name Description
DataProvider provider

Object that provides access to the data.
System.Int32 iOffset

Offset to the record's data.
System.Int32 iLength

Length of the record's data.
ExcelVersion version

Excel version used for infill.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Implements

System.ICloneable