Class ChartLegendRecord

The LEGEND record defines the location of the legend on the display and its overall size. The displayed legend contains all series on the chart.

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

Constructors

ChartLegendRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartLegendRecord()

ChartLegendRecord(Int32)

Reserved for record's internal data array.

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

ChartLegendRecord(Stream, out Int32)

Read / initialize constructor.

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

AutoPosition

Automatic positioning (True if legend is docked).

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

AutoPositionX

X positioning is automatic.

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

AutoPositionY

Y positioning is automatic.

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

AutoSeries

Automatic series distribution (True in Microsoft Excel 5.0).

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

ContainsDataTable

True if chart contains data table.

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

Height

Y-size.

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

IsVerticalLegend

True if vertical legend (a single column of entries); False if horizontal legend (multiple columns of entries). Manual-sized legends always have this bit set to False.

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

Position

Type: 0 = bottom 1 = corner 2 = top 3 = right 4 = left 7 = not docked or inside the plot area

Declaration
public ExcelLegendPosition Position { get; set; }
Property Value
Type Description
ExcelLegendPosition

Spacing

Spacing: 0 = close 1 = medium 2 = open

Declaration
public ExcelLegendSpacing Spacing { get; set; }
Property Value
Type Description
ExcelLegendSpacing

Width

X-size.

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

X

X-position of upper-left corner.

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

Y

Y-position of upper-left corner.

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

Methods

GetStoreSize(ExcelVersion)

Evaluates size of the required storage space.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type Description
System.Int32

Size of the required storage space.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

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

Implements

System.ICloneable