Class ArrayRecord

Summary description for ArrayRecord.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ArrayRecord
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object, System.Object)
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
[CLSCompliant(false)]
[Biff(TBIFFRecord.Array)]
public class ArrayRecord : BiffRecordRaw, IBiffStorage, ISharedFormula, ICloneable, IFormulaRecord

Constructors

ArrayRecord()

Default Constructor.

Declaration
public ArrayRecord()

ArrayRecord(Int32)

Reserved for the record's internal data array.

Declaration
public ArrayRecord(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.

ArrayRecord(Stream, out Int32)

Read / initialize Constructor.

Declaration
public ArrayRecord(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

When stream is not specified.
System.ApplicationException

When stream does not support read or seek operations.

Properties

Expression

Token array of the shared formula.

Declaration
public byte[] Expression { get; set; }
Property Value
Type
System.Byte[]

ExpressionLen

Read-only. Size of the formula data.

Declaration
public ushort ExpressionLen { get; }
Property Value
Type
System.UInt16

FirstColumn

Index to first column of the array formula range. Zero-based.

Declaration
public int FirstColumn { get; set; }
Property Value
Type
System.Int32

FirstRow

Index to first row of the array formula range. Zero-based.

Declaration
public int FirstRow { get; set; }
Property Value
Type
System.Int32

Formula

Declaration
public Ptg[] Formula { get; set; }
Property Value
Type
Ptg[]

IsRecalculateAlways

Indicates whether formula value should be always recalculated.

Declaration
public bool IsRecalculateAlways { get; set; }
Property Value
Type
System.Boolean

IsRecalculateOnOpen

Indicates whether formula value should be recalculated when the file is opened.

Declaration
public bool IsRecalculateOnOpen { get; set; }
Property Value
Type
System.Boolean

LastColumn

Index to last column of the array formula range. Zero-based.

Declaration
public int LastColumn { get; set; }
Property Value
Type
System.Int32

LastRow

Index to last row of the array formula range. Zero-based.

Declaration
public int LastRow { get; set; }
Property Value
Type
System.Int32

MinimumRecordSize

Read-only. Returns minimum possible size of record's internal data array.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

Options

Option flags.

Declaration
public ushort Options { get; }
Property Value
Type
System.UInt16

Reserved

Read-only. Reserved.

Declaration
public int Reserved { get; }
Property Value
Type
System.Int32

Methods

Clone()

Declaration
public object Clone()
Returns
Type
System.Object

Equals(Object)

Determines whether the specified Object is equal to the current Object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The Object to compare with the current Object.
Returns
Type Description
System.Boolean

true if the specified Object is equal to the current Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A hash code for the current Object.
Overrides
System.Object.GetHashCode()

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)

ParseDimensions(ISharedFormula, DataProvider, Int32, ExcelVersion)

Serializes area that is covered by array formula.

Declaration
public static int ParseDimensions(ISharedFormula shared, DataProvider provider, int iOffset, ExcelVersion version)
Parameters
Type Name Description
ISharedFormula shared

Object that receives dimensions data.
DataProvider provider

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

Offset in the buffer.
ExcelVersion version

Excel version used for infill.
Returns
Type Description
System.Int32

Updated offset.

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Converts 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)

SerializeDimensions(ISharedFormula, DataProvider, Int32, ExcelVersion)

Serializes area that is covered by array formula.

Declaration
public static int SerializeDimensions(ISharedFormula shared, DataProvider provider, int iOffset, ExcelVersion version)
Parameters
Type Name Description
ISharedFormula shared

Object that contains dimensions data.
DataProvider provider

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

Offset in the buffer.
ExcelVersion version

Excel version used for infill.
Returns
Type Description
System.Int32

Updated offset.

Implements

System.ICloneable