Class ChartAreaFormatRecord

This record describes the patterns and colors used in a filled area.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ChartAreaFormatRecord
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.ChartAreaFormat)]
[CLSCompliant(false)]
public class ChartAreaFormatRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ChartAreaFormatRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartAreaFormatRecord()

ChartAreaFormatRecord(Int32)

Reserved for record's internal data array.

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

ChartAreaFormatRecord(Stream, out Int32)

Read / initialize constructor.

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

DEF_RECORD_SIZE

Correct size of the record.

Declaration
public const int DEF_RECORD_SIZE = 16
Field Value
Type
System.Int32

Properties

BackgroundColor

Background color (RGB).

Declaration
public Color BackgroundColor { get; set; }
Property Value
Type
System.Drawing.Color

BackgroundColorIndex

Background color index.

Declaration
public ExcelKnownColors BackgroundColorIndex { get; set; }
Property Value
Type
ExcelKnownColors

ForegroundColor

Foreground color (RGB).

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

ForegroundColorIndex

Index of foreground color.

Declaration
public ExcelKnownColors ForegroundColorIndex { get; set; }
Property Value
Type
ExcelKnownColors

MaximumRecordSize

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

Declaration
public override int MaximumRecordSize { get; }
Property Value
Type
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
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

Options

Holder of record flags.

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

Pattern

Pattern.

Declaration
public ExcelPattern Pattern { get; set; }
Property Value
Type
ExcelPattern

SwapColorsOnNegative

Foreground and background are swapped when the data value is negative.

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

UseAutomaticFormat

Automatic format or not.

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

Methods

GetStoreSize(ExcelVersion)

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Convert 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
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Implements

System.ICloneable