Class CFExRecord

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
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
CondFMTRecord
CFExRecord
Implements
System.ICloneable
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class CFExRecord : CondFMTRecord, IBiffStorage, ICloneable

Constructors

CFExRecord()

Default constructor

Declaration
public CFExRecord()

CFExRecord(Int32)

Reserves for record's internal data array iReserve bytes.

Declaration
public CFExRecord(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.

CFExRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public CFExRecord(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

CF12RecordIfExtends

Gets/Sets CF12 record.

Declaration
public CF12Record CF12RecordIfExtends { get; set; }
Property Value
Type
CF12Record

CFIndex

An integer that specifies a zero based index of CF Record.

Declaration
public ushort CFIndex { get; set; }
Property Value
Type
System.UInt16

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

CondFmtIndex

An integer that specifies which CondFmt record is being extended.

Declaration
public ushort CondFmtIndex { get; set; }
Property Value
Type
System.UInt16

EncloseRange

Cell range address of the range enclosing all conditionally formatted ranges.

Declaration
public TAddr EncloseRange { get; set; }
Property Value
Type
TAddr

HasDXF

A Boolean that specifies whether cell formatting data is part of this record extension.

Declaration
public byte HasDXF { get; set; }
Property Value
Type
System.Byte

IsCF12Extends

A boolean that specifies the type of rule this record extends.

Declaration
public byte IsCF12Extends { get; set; }
Property Value
Type
System.Byte

IsCFExParsed

Check whether the rule is parsed or not.

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

MinimumRecordSize

Read-only. Maximum possible size of the record.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type
System.Int32
Overrides

Priority

An integer that specifies the priority of the rule.

Declaration
public ushort Priority { get; set; }
Property Value
Type
System.UInt16

Properties

Set of properties applied to the XF format.

Declaration
public List<ExtendedProperty> Properties { get; set; }
Property Value
Type
System.Collections.Generic.List<ExtendedProperty>

PropertyCount

Properties count.

Declaration
public ushort PropertyCount { get; set; }
Property Value
Type
System.UInt16

SizeOfDXF

An integer that specifies the size of the structure in bytes.

Declaration
public ushort SizeOfDXF { get; set; }
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

Clone()

Clone current Record.

Declaration
public override object Clone()
Returns
Type Description
System.Object

Returns memberwise clone on current object.
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

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

Implements

System.ICloneable