Class RKRecord
Represents a cell that contains an RK value (encoded integer or floating-point value).
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
[Biff(TBIFFRecord.RK)]
[CLSCompliant(false)]
public class RKRecord : CellPositionBase, ICloneable, IBiffStorage, ICellPositionFormat, IDoubleValue, IValueHolder
Constructors
RKRecord()
Default constructor
Declaration
public RKRecord()
Fields
DEF_RK_MASK
Represents rk mask.
Declaration
public const uint DEF_RK_MASK = 4294967292
Field Value
| Type |
|---|
| uint |
Properties
DoubleValue
Returns double value. Read-only.
Declaration
public double DoubleValue { get; }
Property Value
| Type |
|---|
| double |
IsNotFloat
True if this is not a floating point value.
Declaration
public bool IsNotFloat { get; set; }
Property Value
| Type |
|---|
| bool |
IsValueChanged
True if value was multiplied by 100.
Declaration
public bool IsValueChanged { get; set; }
Property Value
| Type |
|---|
| bool |
MaximumMemorySize
Declaration
public override int MaximumMemorySize { get; }
Property Value
| Type |
|---|
| int |
Overrides
MaximumRecordSize
Read-only. Returns maximum possible size of record's internal data array.
Declaration
public override int MaximumRecordSize { get; }
Property Value
| Type |
|---|
| int |
Overrides
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
| Type |
|---|
| int |
Overrides
RKNumber
RK value converted to double.
Declaration
public double RKNumber { get; set; }
Property Value
| Type |
|---|
| double |
RKNumberInt
Read-only. RK value.
Declaration
public int RKNumberInt { get; set; }
Property Value
| Type |
|---|
| int |
Value
Value of the record.
Declaration
public object Value { get; set; }
Property Value
| Type |
|---|
| object |
Methods
ConvertToDouble(int)
Converts Rk number to double.
Declaration
public static double ConvertToDouble(int rkNumber)
Parameters
| Type | Name | Description |
|---|---|---|
| int | rkNumber | Rk number to convert. |
Returns
| Type | Description |
|---|---|
| double | Converted double value. |
ConvertToRKNumber(double)
Converts double to RK number.
Declaration
public static int ConvertToRKNumber(double value)
Parameters
| Type | Name | Description |
|---|---|---|
| double | value | Value to convert. |
Returns
| Type | Description |
|---|---|
| int | Converted RK number. If returns int.MaxValue - cannot parse RK number. |
ConvertToRKNumber(string)
Converts string to RK number.
Declaration
public static int ConvertToRKNumber(string value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | value | String to parse. |
Returns
| Type | Description |
|---|---|
| int | Parsed RK number. If returns int.MaxValue - cannot parse RK number. |
EncodeRK(int)
Encodes rk number.
Declaration
public static double EncodeRK(int value)
Parameters
| Type | Name | Description |
|---|---|---|
| int | value | Represents value to encode. |
Returns
| Type | Description |
|---|---|
| double | Returns encoded value. |
GetAsRkRec()
Converts RKRecord into MulRKRecord.RkRec.
Declaration
public MulRKRecord.RkRec GetAsRkRec()
Returns
| Type | Description |
|---|---|
| MulRKRecord.RkRec | Converted record. |
GetStoreSize(ExcelVersion)
Returns size of the required storage space.
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version | Excel version. |
Returns
| Type | Description |
|---|---|
| int | Size of the required storage space. |
Overrides
InfillCellData(DataProvider, int, ExcelVersion)
In this method, class must pack all of its properties into an internal data array, m_data. This method is called by FillStream, when the record must be serialized into a stream.
Declaration
protected override void InfillCellData(DataProvider provider, int iOffset, ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| int | iOffset | Offset to the record's data. |
| ExcelVersion | version | Excel version used to fill data. |
Overrides
ParseCellData(DataProvider, int, ExcelVersion)
Parse structure of record. Convert Data buffer to special values according to record specification.
Declaration
protected override void ParseCellData(DataProvider provider, int iOffset, ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| int | iOffset | Offset to the record's data. |
| ExcelVersion | version | Excel version used to fill data. |
Overrides
ReadValue(DataProvider, int, ExcelVersion)
Reads record's value from the data provider.
Declaration
public static int ReadValue(DataProvider provider, int recordStart, ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Provider to read data from. |
| int | recordStart | Offset to the record's start. |
| ExcelVersion | version | Excel version that was used to infill. |
Returns
| Type | Description |
|---|---|
| int | Record's value. |
SetConvertedNumber(int)
Sets integer value to the specified value.
Declaration
public void SetConvertedNumber(int rkNumber)
Parameters
| Type | Name | Description |
|---|---|---|
| int | rkNumber | Value to set. |
SetRKNumber(double)
Sets RkNumber to the specified value.
Declaration
public void SetRKNumber(double value)
Parameters
| Type | Name | Description |
|---|---|---|
| double | value | Double value to set. |
SetRKNumber(string)
Converts string to the Rk number.
Declaration
public void SetRKNumber(string value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | value | String to convert. |
SetRKRecord(RkRec)
Sets RkRecord values from MulRKRecord.RkRec
Declaration
public void SetRKRecord(MulRKRecord.RkRec rc)
Parameters
| Type | Name | Description |
|---|---|---|
| MulRKRecord.RkRec | rc | MulRKRecord.RkRec with needed values. |