Class CF12Record
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 CF12Record : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
CF12Record()
Default constructor
Declaration
public CF12Record()
Properties
ColorScaleCF12
CF12 Color Scale class.
Declaration
public ColorScale ColorScaleCF12 { get; set; }
Property Value
Type |
---|
ColorScale |
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 |
Criteria
Color Scale implementation class.
Declaration
public IColorScale Criteria { get; set; }
Property Value
Type |
---|
IColorScale |
DataBarCF12
CF12 Data bar class.
Declaration
public DataBar DataBarCF12 { get; set; }
Property Value
Type |
---|
DataBar |
DataBarImpl
Data var.
Declaration
public IDataBar DataBarImpl { get; set; }
Property Value
Type |
---|
IDataBar |
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 |
FormatType
An integer that specifies the template from which the rule was created.
Declaration
public ExcelCFType FormatType { get; set; }
Property Value
Type |
---|
ExcelCFType |
FormulaBytes
Returns bytes of the formula. Read-only.
Declaration
public byte[] FormulaBytes { get; }
Property Value
Type |
---|
System.Byte[] |
FormulaPtgs
Parsed formula string.
Declaration
public Ptg[] FormulaPtgs { get; set; }
Property Value
Type |
---|
Ptg[] |
IconSetCF12
CF12 Icon set class.
Declaration
public CFIconSet IconSetCF12 { get; set; }
Property Value
Type |
---|
CFIconSet |
IconSetImpl
Icon set.
Declaration
public IIconSet IconSetImpl { get; set; }
Property Value
Type |
---|
IIconSet |
IsParsed
True if the record parsed.
Declaration
public bool IsParsed { get; set; }
Property Value
Type |
---|
System.Boolean |
Priority
An integer that specifies the priority of the rule.
Declaration
public ushort Priority { get; set; }
Property Value
Type |
---|
System.UInt16 |
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 |
StopIfTrue
A bit that specifies whether, when a cell fulfills the condition corresponding to this rule, the lower priority conditional formatting rules that apply to this cell are evaluated.
Declaration
public bool StopIfTrue { get; set; }
Property Value
Type |
---|
System.Boolean |
Template
An integer that specifies the template from which the rule was created. 0x0000 Cell value 0x0001 Formula 0x0002 Color scale formatting 0x0003 Data bar formatting 0x0004 Icon set formatting 0x0005 Filter 0x0007 Unique values 0x0008 Contains text 0x0009 Contains blanks 0x000A Contains no blanks 0x000B Contains errors 0x000C Contains no errors 0x000F Today 0x0010 Tomorrow 0x0011 Yesterday 0x0012 Last 7 days 0x0013 Last month 0x0014 Next month 0x0015 This week 0x0016 Next week 0x0017 Last week 0x0018 This month 0x0019 Above average 0x001A Below Average 0x001B Duplicate values 0x001D Above or equal to average 0x001E Below or equal to average
Declaration
public ConditionalFormatTemplate Template { get; set; }
Property Value
Type |
---|
ConditionalFormatTemplate |
Methods
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
ParseCFExTemplateParameter(DataProvider, Int32, ExcelVersion)
Parse structure of template parameter. Converts data buffer to special values according to record specification.
Declaration
public int ParseCFExTemplateParameter(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 for infill. |
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
SerializeCFExTemplateParameter(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
public int SerializeCFExTemplateParameter(DataProvider provider, int iOffset, ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
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 |
---|
System.Int32 |