Class RKRecord

Represents a cell that contains an RK value (encoded integer or floating-point value).

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
CellPositionBase
RKRecord
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.RK)]
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 = 4294967292U
Field Value
Type Description
System.UInt32

Properties

DoubleValue

Returns double value. Read-only.

Declaration
public double DoubleValue { get; }
Property Value
Type Description
System.Double

IsNotFloat

True if this is not a floating point value.

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

IsValueChanged

True if value was multiplied by 100.

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

MaximumMemorySize

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

MaximumRecordSize

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

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

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
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

RKNumber

RK value converted to double.

Declaration
public double RKNumber { get; set; }
Property Value
Type Description
System.Double

RKNumberInt

Read-only. RK value.

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

Value

Value of the record.

Declaration
public object Value { get; set; }
Property Value
Type Description
System.Object

Methods

ConvertToDouble(Int32)

Converts Rk number to double.

Declaration
public static double ConvertToDouble(int rkNumber)
Parameters
Type Name Description
System.Int32 rkNumber

Rk number to convert.
Returns
Type Description
System.Double

Converted double value.

ConvertToRKNumber(Double)

Converts double to RK number.

Declaration
public static int ConvertToRKNumber(double value)
Parameters
Type Name Description
System.Double value

Value to convert.
Returns
Type Description
System.Int32

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
System.String value

String to parse.
Returns
Type Description
System.Int32

Parsed RK number. If returns int.MaxValue - cannot parse RK number.

EncodeRK(Int32)

Encodes rk number.

Declaration
public static double EncodeRK(int value)
Parameters
Type Name Description
System.Int32 value

Represents value to encode.
Returns
Type Description
System.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
System.Int32

Size of the required storage space.
Overrides

InfillCellData(DataProvider, Int32, 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.
System.Int32 iOffset

Offset to the record's data.
ExcelVersion version

Excel version used to fill data.
Overrides

ParseCellData(DataProvider, Int32, 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.
System.Int32 iOffset

Offset to the record's data.
ExcelVersion version

Excel version used to fill data.
Overrides

ReadValue(DataProvider, Int32, 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.
System.Int32 recordStart

Offset to the record's start.
ExcelVersion version

Excel version that was used to infill.
Returns
Type Description
System.Int32

Record's value.

SetConvertedNumber(Int32)

Sets integer value to the specified value.

Declaration
public void SetConvertedNumber(int rkNumber)
Parameters
Type Name Description
System.Int32 rkNumber

Value to set.

SetRKNumber(Double)

Sets RkNumber to the specified value.

Declaration
public void SetRKNumber(double value)
Parameters
Type Name Description
System.Double value

Double value to set.

SetRKNumber(String)

Converts string to the Rk number.

Declaration
public void SetRKNumber(string value)
Parameters
Type Name Description
System.String value

String to convert.

SetRKRecord(MulRKRecord.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.

Implements

System.ICloneable