Class ChartLineFormatRecord

This record defines the appearance of a line, such as an axis line or border.

Inheritance

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

ChartLineFormatRecord

Implements

System.ICloneable

IBiffStorage

Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

[Biff]
public class ChartLineFormatRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ChartLineFormatRecord()

Default constructor, initializes all fields with default values.

Declaration

public ChartLineFormatRecord()

ChartLineFormatRecord(Int32)

Reserved for record's internal data array.

Declaration

public ChartLineFormatRecord(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.

ChartLineFormatRecord(Stream, out Int32)

Read / initialize constructor.

Declaration

public ChartLineFormatRecord(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 = 12

Field Value

Type
System.Int32

Properties

AutoFormat

If true - default format; otherwise custom.

Declaration

public bool AutoFormat { get; set; }

Property Value

Type
System.Boolean

ColorIndex

Line color index..

Declaration

public ushort ColorIndex { get; set; }

Property Value

Type
System.UInt16

DrawTickLabels

True to draw tick labels on this axis.

Declaration

public bool DrawTickLabels { get; set; }

Property Value

Type
System.Boolean

IsAutoLineColor

Custom format for line color.

Declaration

public bool IsAutoLineColor { get; set; }

Property Value

Type
System.Boolean

LineColor

Color of line; RGB value high byte must be set to zero.

Declaration

public int LineColor { get; set; }

Property Value

Type
System.Int32

LinePattern

Line pattern.

Declaration

public ExcelChartLinePattern LinePattern { get; set; }

Property Value

Type
ExcelChartLinePattern

LineWeight

Weight of line.

Declaration

public ExcelChartLineWeight LineWeight { get; set; }

Property Value

Type
ExcelChartLineWeight

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

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

IBiffStorage