Class ChartLegendxnRecord

This record specifies information about a legend entry which has been changed from the default legend-entry settings.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ChartLegendxnRecord
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.ChartLegendxn)]
public class ChartLegendxnRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ChartLegendxnRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartLegendxnRecord()

ChartLegendxnRecord(Int32)

Reserved for record's internal data array.

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

ChartLegendxnRecord(Stream, out Int32)

Read / initialize constructor.

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

IsDeleted

True if the legend entry has been deleted.

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

IsFormatted

True if the legend entry has been formatted.

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

LegendEntityIndex

Legend-entry index.

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

Options

Options bit flags holder.

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

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