Class ChartLegendEntryImpl

Class used for Chart Legend entries implementation.

Inheritance
System.Object
CommonObject
ChartLegendEntryImpl
Implements
System.IDisposable
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.Implementation.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class ChartLegendEntryImpl : CommonObject, IParentApplication, IDisposable, IChartLegendEntry

Constructors

ChartLegendEntryImpl(IApplication, Object, Int32)

Creates new instance of legend entry.

Declaration
public ChartLegendEntryImpl(IApplication application, object parent, int iIndex)
Parameters
Type Name Description
IApplication application

Application object.
System.Object parent

Parent object.
System.Int32 iIndex

Represents index in collection

ChartLegendEntryImpl(IApplication, Object, Int32, IList<BiffRecordRaw>, ref Int32)

Creates new instance of legend entry by parsing from stream.

Declaration
public ChartLegendEntryImpl(IApplication application, object parent, int iIndex, IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type Name Description
IApplication application

Application object.
System.Object parent

Parent object.
System.Int32 iIndex

Represents index in collection.
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

Represents record holder.
System.Int32 iPos

Represents position in stream.

Properties

Index

Represents index in collection.

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

IsDeleted

True if this entry is deleted. otherwise False.

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

IsFormatted

True if the legend entry is formatted. otherwise False.

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

LegendEntityIndex

Legend-entry index.

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

TextArea

Gets the text area of the legend entry. Read-only.

Declaration
public IChartTextArea TextArea { get; }
Property Value
Type Description
IChartTextArea

Methods

Clear()

Clears the legend entry.

Declaration
public void Clear()

Clone(Object, Dictionary<Int32, Int32>, Dictionary<String, String>)

Clones current object.

Declaration
public ChartLegendEntryImpl Clone(object parent, Dictionary<int, int> dicIndexes, Dictionary<string, string> dicNewSheetNames)
Parameters
Type Name Description
System.Object parent

Parent object.
System.Collections.Generic.Dictionary<System.Int32, System.Int32> dicIndexes

Dictionary with new font indexes.
System.Collections.Generic.Dictionary<System.String, System.String> dicNewSheetNames

Dictionary with new worksheet names.
Returns
Type Description
ChartLegendEntryImpl

Returns cloned object.

Delete()

Deletes the legend entry.

Declaration
public void Delete()

Parse(IList<BiffRecordRaw>, ref Int32)

Parses legend entry.

Declaration
public void Parse(IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type Name Description
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

Record storage.
System.Int32 iPos

Position in storage.

Serialize(IList<IBiffStorage>)

Serialize legend entry object.

Declaration
[CLSCompliant(false)]
public void Serialize(IList<IBiffStorage> records)
Parameters
Type Name Description
System.Collections.Generic.IList<IBiffStorage> records

Record storage.

SetParents()

Finds parent object for collection.

Declaration
public void SetParents()

Implements

System.IDisposable