Class SharedFormulaRecord
This record stores the token array of a shared formula. Shared formulas are similar to array formulas in that they store a formula used in a range of cells. The SharedFormula record is not a real cell record but follows the first FORMULA record of the cell range.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.SharedFormula2)]
public class SharedFormulaRecord : BiffRecordRaw, ICloneable, IBiffStorage, ISharedFormula
Constructors
SharedFormulaRecord()
Default constructor fills all data with default values.
Declaration
public SharedFormulaRecord()
SharedFormulaRecord(Int32)
Reserved for record's internal data array.
Declaration
public SharedFormulaRecord(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. |
SharedFormulaRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public SharedFormulaRecord(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
Expression
Token array of the shared formula.
Declaration
public byte[] Expression { get; set; }
Property Value
Type | Description |
---|---|
System.Byte[] |
ExpressionLen
Read-only. Size of the formula data.
Declaration
public ushort ExpressionLen { get; }
Property Value
Type | Description |
---|---|
System.UInt16 |
FirstColumn
Index to first column of the shared formula range.
Declaration
public int FirstColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
FirstRow
Index to first row of the shared formula range.
Declaration
public int FirstRow { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Formula
Gets/sets formula into/from shared formula record.
Declaration
public Ptg[] Formula { get; set; }
Property Value
Type | Description |
---|---|
Ptg[] |
LastColumn
Index to last column of the shared formula range.
Declaration
public int LastColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
LastRow
Index to last row of the shared formula range.
Declaration
public int LastRow { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Overrides
Reserved
Read-only. Reserved.
Declaration
public ushort Reserved { get; }
Property Value
Type | Description |
---|---|
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 | Description |
---|---|
System.Int32 |
Overrides
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. |