Class CondFMTRecord
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 CondFMTRecord : BiffRecordRaw, IBiffStorage, ICloneableConstructors
CondFMTRecord()
Default constructor
Declaration
public CondFMTRecord()CondFMTRecord(Int32)
Reserves for record's internal data array iReserve bytes.
Declaration
public CondFMTRecord(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. |
CondFMTRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public CondFMTRecord(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
CellList
Returns list with all conditionally formatted ranges. Read-only.
Declaration
public List<Rectangle> CellList { get; }Property Value
| Type |
|---|
| System.Collections.Generic.List<Rectangle> |
CellsCount
Number of conditionally formatted cells. Read-only.
Declaration
public ushort CellsCount { get; set; }Property Value
| Type |
|---|
| System.UInt16 |
CFNumber
Number of following CF records.
Declaration
public ushort CFNumber { 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 |
Index
Index of this record.
Declaration
public ushort Index { get; set; }Property Value
| Type |
|---|
| System.UInt16 |
IsParsed
Check whether the rule is parsed or not.
Declaration
public bool IsParsed { get; set; }Property Value
| Type |
|---|
| System.Boolean |
MinimumRecordSize
Read-only. Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }Property Value
| Type |
|---|
| System.Int32 |
Overrides
NeedRecalc
1 = Conditionally formatted cells need recalculation or redraw.
Declaration
public bool NeedRecalc { get; set; }Property Value
| Type |
|---|
| System.Boolean |
Methods
AddCell(Rectangle)
Adds cell to the cells list.
Declaration
public void AddCell(Rectangle addr)Parameters
| Type | Name | Description |
|---|---|---|
| Rectangle | addr | Cell to add to the list. |
Clone()
Clone current record.
Declaration
public override object Clone()Returns
| Type | Description |
|---|---|
| System.Object | Returns clone of the current object. |
Overrides
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
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. |