Class OleSizeRecord
This record stores the size of an embedded OLE object (when Microsoft Excel is a server).
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.OleSize)]
public class OleSizeRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
OleSizeRecord()
Default constructor, sets all fields' default values.
Declaration
public OleSizeRecord()
OleSizeRecord(Int32)
Reserved for record's internal data array.
Declaration
public OleSizeRecord(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. |
OleSizeRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public OleSizeRecord(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
FirstColumn
First column of the object.
Declaration
public byte FirstColumn { get; set; }
Property Value
Type |
---|
System.Byte |
FirstRow
First row of the object.
Declaration
public ushort FirstRow { get; set; }
Property Value
Type |
---|
System.UInt16 |
LastColumn
Last column of the object.
Declaration
public byte LastColumn { get; set; }
Property Value
Type |
---|
System.Byte |
LastRow
Last row of the object.
Declaration
public ushort LastRow { get; set; }
Property Value
Type |
---|
System.UInt16 |
MaximumRecordSize
Read-only. Returns maximum possible size of the record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
MinimumRecordSize
Read-only. Return minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Reserved
Read-only. Get reserved field value.
Declaration
public ushort Reserved { get; }
Property Value
Type |
---|
System.UInt16 |
Methods
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
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. |