Class CFRecord
The begin record defines the start of a block of records for a (Graphing) data object. This record is matched with a corresponding EndRecord.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class CFRecord : BiffRecordRaw, IBiffStorage, ICloneable
Constructors
CFRecord()
Default constructor
Declaration
public CFRecord()
CFRecord(Int32)
Reserves for record's internal data array iReserve bytes.
Declaration
public CFRecord(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. |
CFRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public CFRecord(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. |
Fields
DefaultColorIndex
Default color index.
Declaration
public const uint DefaultColorIndex = 4294967295U
Field Value
Type |
---|
System.UInt32 |
Properties
BottomBorderColorIndex
Color index for bottom line.
Declaration
public uint BottomBorderColorIndex { get; set; }
Property Value
Type |
---|
System.UInt32 |
BottomBorderStyle
Bottom border line style.
Declaration
public ExcelLineStyle BottomBorderStyle { get; set; }
Property Value
Type |
---|
ExcelLineStyle |
ComparisonOperator
Comparison operator: 00H = No comparison (only valid for formula type, see above) 01H = Between 02H = Not between 04H = Not equal 05H = Greater than 06H = Less than 03H = Equal 07H = Greater or equal 08H = Less or equal
Declaration
public ExcelComparisonOperator ComparisonOperator { get; set; }
Property Value
Type |
---|
ExcelComparisonOperator |
FirstFormulaBytes
Returns bytes of the first formula. Read-only.
Declaration
public byte[] FirstFormulaBytes { get; }
Property Value
Type |
---|
System.Byte[] |
FirstFormulaPtgs
Parsed first formula string.
Declaration
public Ptg[] FirstFormulaPtgs { get; set; }
Property Value
Type |
---|
Ptg[] |
FirstFormulaSize
Size of the formula data for first value or formula. Read-only.
Declaration
public ushort FirstFormulaSize { get; }
Property Value
Type |
---|
System.UInt16 |
FontCancellation
Cancellation: 0 = Off; 1 = On
Declaration
public bool FontCancellation { get; set; }
Property Value
Type |
---|
System.Boolean |
FontColorIndex
Font color index; or FFFFFFFFH to preserve the cell font color.
Declaration
public uint FontColorIndex { get; set; }
Property Value
Type |
---|
System.UInt32 |
FontEscapment
Escapement type.
Declaration
public ExcelFontVertialAlignment FontEscapment { get; set; }
Property Value
Type |
---|
ExcelFontVertialAlignment |
FontHeight
Font height (in twips = 1/20 of a point); or FFFFFFFFH to preserve the cell font height.
Declaration
public uint FontHeight { get; set; }
Property Value
Type |
---|
System.UInt32 |
FontPosture
Posture: 0 = Normal; 1 = Italic
Declaration
public bool FontPosture { get; set; }
Property Value
Type |
---|
System.Boolean |
FontUnderline
Underline type.
Declaration
public ExcelUnderline FontUnderline { get; set; }
Property Value
Type |
---|
ExcelUnderline |
FontWeight
Font weight (400 - Normal text, 700 - Bold text).
Declaration
public ushort FontWeight { get; set; }
Property Value
Type |
---|
System.UInt16 |
FormatType
Type of the conditional formatting:
01H = Compare with current cell value (the comparison specified below is used)
02H = Evaluate a formula (condition is met if formula evaluates to a value not equal to 0)
Declaration
public ExcelCFType FormatType { get; set; }
Property Value
Type |
---|
ExcelCFType |
IsBorderFormatPresent
True if record contains border formatting block.
Declaration
public bool IsBorderFormatPresent { get; set; }
Property Value
Type |
---|
System.Boolean |
IsBottomBorderModified
True if bottom border style and color are modified.
Declaration
public bool IsBottomBorderModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsFontCancellationModified
Indicates whether font cancellation was modified.
Declaration
public bool IsFontCancellationModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsFontEscapmentModified
Indicates whether font escapment was modified.
Declaration
public bool IsFontEscapmentModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsFontFormatPresent
True if record contains font formatting block.
Declaration
public bool IsFontFormatPresent { get; set; }
Property Value
Type |
---|
System.Boolean |
IsFontStyleModified
Indicates whether font style (posture or boldness) was modified.
Declaration
public bool IsFontStyleModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsFontUnderlineModified
Indicates whether font underline was modified.
Declaration
public bool IsFontUnderlineModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsLeftBorderModified
True if left border style and color are modified.
Declaration
public bool IsLeftBorderModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNumberFormatModified
False if Number format is modified.
Declaration
public bool IsNumberFormatModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNumberFormatPresent
True if record contains Number format.
Declaration
public bool IsNumberFormatPresent { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNumberFormatUserDefined
True if number format is user defined.
Declaration
public bool IsNumberFormatUserDefined { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPatternBackColorModified
False if pattern background color is modified.
Declaration
public bool IsPatternBackColorModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPatternColorModified
True if pattern color is modified.
Declaration
public bool IsPatternColorModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPatternFormatPresent
True if record contains pattern formatting block.
Declaration
public bool IsPatternFormatPresent { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPatternStyleModified
True if pattern style is modified.
Declaration
public bool IsPatternStyleModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsRightBorderModified
True if right border style and color modified.
Declaration
public bool IsRightBorderModified { get; set; }
Property Value
Type |
---|
System.Boolean |
IsTopBorderModified
True if top border style and color are modified.
Declaration
public bool IsTopBorderModified { get; set; }
Property Value
Type |
---|
System.Boolean |
LeftBorderColorIndex
Color index for left line.
Declaration
public uint LeftBorderColorIndex { get; set; }
Property Value
Type |
---|
System.UInt32 |
LeftBorderStyle
Left border line style.
Declaration
public ExcelLineStyle LeftBorderStyle { get; set; }
Property Value
Type |
---|
ExcelLineStyle |
MinimumRecordSize
Read-only. Maximum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
NumberFormatIndex
Declaration
public ushort NumberFormatIndex { get; set; }
Property Value
Type |
---|
System.UInt16 |
Options
Option flags.
Declaration
public uint Options { get; }
Property Value
Type |
---|
System.UInt32 |
PatternBackColor
Color index for pattern background.
Declaration
public ushort PatternBackColor { get; set; }
Property Value
Type |
---|
System.UInt16 |
PatternColorIndex
Color index for pattern.
Declaration
public ushort PatternColorIndex { get; set; }
Property Value
Type |
---|
System.UInt16 |
PatternStyle
Fill pattern style.
Declaration
public ExcelPattern PatternStyle { get; set; }
Property Value
Type |
---|
ExcelPattern |
Reserved
Not used.
Declaration
public ushort Reserved { get; }
Property Value
Type |
---|
System.UInt16 |
RightBorderColorIndex
Color index for right line.
Declaration
public uint RightBorderColorIndex { get; set; }
Property Value
Type |
---|
System.UInt32 |
RightBorderStyle
Right border line style.
Declaration
public ExcelLineStyle RightBorderStyle { get; set; }
Property Value
Type |
---|
ExcelLineStyle |
SecondFormulaBytes
Returns bytes of the second formula. Read-only.
Declaration
public byte[] SecondFormulaBytes { get; }
Property Value
Type |
---|
System.Byte[] |
SecondFormulaPtgs
Parsed second formula string.
Declaration
public Ptg[] SecondFormulaPtgs { get; set; }
Property Value
Type |
---|
Ptg[] |
SecondFormulaSize
Size of the formula data for second value or formula (sz2, used for second part of "Between" and "Not between" comparison, this field is 0 for other comparisons). Read-only.
Declaration
public ushort SecondFormulaSize { get; }
Property Value
Type |
---|
System.UInt16 |
TopBorderColorIndex
Color index for top line.
Declaration
public uint TopBorderColorIndex { get; set; }
Property Value
Type |
---|
System.UInt32 |
TopBorderStyle
Top border line style.
Declaration
public ExcelLineStyle TopBorderStyle { get; set; }
Property Value
Type |
---|
ExcelLineStyle |
Methods
Clone()
Clones current instance.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | Returns new instance. |
Overrides
Equals(Object)
A hash code for the current Object without taking cell list into account.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | The Object to compare with the current Object. |
Returns
Type |
---|
System.Boolean |
GetHashCode()
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | A hash code for the current Object. |
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
ParseBorderBlock(DataProvider, ref Int32)
Parses border block if it is present in the conditional format.
Declaration
public int ParseBorderBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset to the border block data in the internal data array. |
Returns
Type |
---|
System.Int32 |
ParseFontBlock(DataProvider, ref Int32)
Parses font block if it is present in the conditional format.
Declaration
public int ParseFontBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset to the font block data in the internal data array. |
Returns
Type |
---|
System.Int32 |
ParseNumberFormatBlock(DataProvider, ref Int32)
Parses number format block if it is present in the conditional format.
Declaration
public int ParseNumberFormatBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset to the number format block data in the internal data array. |
Returns
Type |
---|
System.Int32 |
ParsePatternBlock(DataProvider, ref Int32)
Parses pattern block if it is present in the conditional format.
Declaration
public int ParsePatternBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset to the pattern block data in the internal data array. |
Returns
Type |
---|
System.Int32 |
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
SerializeBorderBlock(DataProvider, ref Int32)
Writes border block into internal data array if it is present in the conditional format.
Declaration
public int SerializeBorderBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset where border block should be written. |
Returns
Type |
---|
System.Int32 |
SerializeFontBlock(DataProvider, ref Int32)
Writes font block into internal data array if it is present in the conditional format.
Declaration
public int SerializeFontBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset where font block should be written. |
Returns
Type |
---|
System.Int32 |
SerializeNumberFormatBlock(DataProvider, ref Int32)
Writes number format block into internal data array if it is present in the conditional format.
Declaration
public int SerializeNumberFormatBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset where number format block should be written. |
Returns
Type |
---|
System.Int32 |
SerializePatternBlock(DataProvider, ref Int32)
Writes pattern block into internal data array if it is present in the conditional format.
Declaration
public int SerializePatternBlock(DataProvider provider, ref int iOffset)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Object that provides access to the data. |
System.Int32 | iOffset | Offset where pattern block should be written. |
Returns
Type |
---|
System.Int32 |