Class ChartLegendImpl
Represents ChartLegend.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartLegendImpl : CommonObject, IParentApplication, IDisposable, IChartLegend
Constructors
ChartLegendImpl(IApplication, Object)
Creates new instance.
Declaration
public ChartLegendImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Current application. |
System.Object | parent | Parent object. |
Properties
AttachedLabelLayout
Return attached label layout record. Read-only
Declaration
public ChartAttachedLabelLayoutRecord AttachedLabelLayout { get; }
Property Value
Type |
---|
ChartAttachedLabelLayoutRecord |
AutoPosition
Automatic positioning (True if legend is docked).
Declaration
public bool AutoPosition { get; set; }
Property Value
Type |
---|
System.Boolean |
AutoPositionX
X positioning is automatic.
Declaration
public bool AutoPositionX { get; set; }
Property Value
Type |
---|
System.Boolean |
AutoPositionY
Y positioning is automatic.
Declaration
public bool AutoPositionY { get; set; }
Property Value
Type |
---|
System.Boolean |
AutoSeries
Automatic series distribution (True in Microsoft Excel 5.0).
Declaration
public bool AutoSeries { get; set; }
Property Value
Type |
---|
System.Boolean |
ContainsDataTable
True if chart contains data table.
Declaration
public bool ContainsDataTable { get; set; }
Property Value
Type |
---|
System.Boolean |
FrameFormat
Represents IChartFrameFormat object for the legend.
Declaration
public IChartFrameFormat FrameFormat { get; }
Property Value
Type |
---|
IChartFrameFormat |
Height
Y-size.
Declaration
public int Height { get; set; }
Property Value
Type |
---|
System.Int32 |
IncludeInLayout
True to show legend without overlapping the chart. otherwise False. The default is True.
Declaration
public bool IncludeInLayout { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
Not applicable to Binary files
IsVerticalLegend
True if the legend is vertical. False if the legend is horizontal.
Declaration
public bool IsVerticalLegend { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
Manual-sized legends always have this bit set to False.
Layout
Gets or sets the layout options of the legend.
Declaration
public IChartLayout Layout { get; set; }
Property Value
Type |
---|
IChartLayout |
LegendEntries
Gets the collection of legend entries. Read-only.
Declaration
public IChartLegendEntries LegendEntries { get; }
Property Value
Type |
---|
IChartLegendEntries |
ParagraphType
Represents the Legend Paragraph
Declaration
public ChartParagraphType ParagraphType { get; set; }
Property Value
Type |
---|
ChartParagraphType |
Position
Gets or sets the position of legend on the chart.
Declaration
public ExcelLegendPosition Position { get; set; }
Property Value
Type |
---|
ExcelLegendPosition |
Spacing
Spacing: 0 = close 1 = medium 2 = open
Declaration
public ExcelLegendSpacing Spacing { get; set; }
Property Value
Type |
---|
ExcelLegendSpacing |
TextArea
Gets the text area of the legend. Read-only.
Declaration
public IChartTextArea TextArea { get; }
Property Value
Type |
---|
IChartTextArea |
Width
X-size.
Declaration
public int Width { get; set; }
Property Value
Type |
---|
System.Int32 |
X
X-position of upper-left corner. 1/4000 of chart plot.
Declaration
public int X { get; set; }
Property Value
Type |
---|
System.Int32 |
Y
Gets the Y co-ordinate of upper-left corner of the legend. 1/4000 of chart plot.
Declaration
public int Y { get; set; }
Property Value
Type |
---|
System.Int32 |
Methods
Clear()
Clears the chart legend.
Declaration
public void Clear()
Clone(Object, Dictionary<Int32, Int32>, Dictionary<String, String>)
Clones current object.
Declaration
public ChartLegendImpl Clone(object parent, Dictionary<int, int> dicFontIndexes, Dictionary<string, string> dicNewSheetNames)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent object. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Array with new font indexes. |
System.Collections.Generic.Dictionary<System.String, System.String> | dicNewSheetNames | Dictionary with new worksheet names. |
Returns
Type | Description |
---|---|
ChartLegendImpl | Returns cloned object. |
Delete()
Deletes the chart legend.
Declaration
public void Delete()
Parse(IList<BiffRecordRaw>, ref Int32)
Parsing current object.
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 | Records offset. |
System.Int32 | iPos | Position in offset. |
Serialize(OffsetArrayList)
Serialize current object.
Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | Represents record to serialize |
SerializeRecord(IList<IBiffStorage>, BiffRecordRaw)
Saves single record into list of biff records.
Declaration
protected virtual void SerializeRecord(IList<IBiffStorage> records, BiffRecordRaw record)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<IBiffStorage> | records | OffsetArrayList that will receive necessary records. |
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | record | Record to serialize. |