Class LegendStyle
Represents the class to define the style for ChartLegend.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.WinForms.SmithChart
Assembly: Syncfusion.SfSmithChart.WinForms.dll
Syntax
public class LegendStyle : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObjectConstructors
LegendStyle()
Initializes a new instance of the LegendStyle class.
Declaration
public LegendStyle()LegendStyle(StyleInfoSubObjectIdentity)
Initializes a new instance of the LegendStyle class.
Declaration
public LegendStyle(StyleInfoSubObjectIdentity identity)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoSubObjectIdentity | identity |
LegendStyle(StyleInfoSubObjectIdentity, SmithChartStyleInfoStore)
Initializes a new instance of the LegendStyle class.
Declaration
public LegendStyle(StyleInfoSubObjectIdentity identity, SmithChartStyleInfoStore store)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoSubObjectIdentity | identity | |
| SmithChartStyleInfoStore | store | A SmithChartStyleInfoStore that holds data for this LegendStyle. All changes in this style object will be saved in the SmithChartStyleInfoStore object. |
LegendStyle(LegendStyle)
Initializes a new instance of the LegendStyle class.
Declaration
public LegendStyle(LegendStyle style)Parameters
| Type | Name | Description |
|---|---|---|
| LegendStyle | style | The style object that contains the original data. |
LegendStyle(SmithChartStyleInfoStore)
Initializes a new instance of the LegendStyle class.
Declaration
public LegendStyle(SmithChartStyleInfoStore store)Parameters
| Type | Name | Description |
|---|---|---|
| SmithChartStyleInfoStore | store | A SmithChartStyleInfoStore that holds data for this LegendStyle. All changes in this style object will be saved in the SmithChartStyleInfoStore object. |
Properties
BackColor
Gets or sets a value that represents the back color for the ChartLegend.
Declaration
public Color BackColor { get; set; }Property Value
| Type |
|---|
| System.Drawing.Color |
BorderColor
Gets or sets a value that represents the border color for the legend.
Declaration
public Color BorderColor { get; set; }Property Value
| Type |
|---|
| System.Drawing.Color |
BorderWidth
Gets or sets the width for the legend border.
Declaration
public int BorderWidth { get; set; }Property Value
| Type |
|---|
| System.Int32 |
DefaultStyle
Gets the default style value for the ChartLegend.
Declaration
public static LegendStyle DefaultStyle { get; }Property Value
| Type |
|---|
| LegendStyle |
ForeColor
Gets or sets the fore color value of the ChartLegend.
Declaration
public Color ForeColor { get; set; }Property Value
| Type |
|---|
| System.Drawing.Color |
LabelFont
Gets or sets the font for legend label.
Declaration
public Font LabelFont { get; set; }Property Value
| Type |
|---|
| System.Drawing.Font |
Store
Gets the SmithChartStyleInfoStore object that holds all the data for this style object.
Declaration
public SmithChartStyleInfoStore Store { get; }Property Value
| Type |
|---|
| SmithChartStyleInfoStore |
Methods
CreateSubObjectIdentity(StyleInfoProperty)
Overridden to create a product-specific identity object for the sub object.
Declaration
public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoProperty | sip | StyleInfoProperty descriptor for this sub object. |
Returns
| Type | Description |
|---|---|
| StyleInfoSubObjectIdentity | Identity for the sub object. |
Overrides
GetDefaultStyle()
Gets the default style value of the LegendStyle class.
Declaration
protected override StyleInfoBase GetDefaultStyle()Returns
| Type | Description |
|---|---|
| StyleInfoBase | Returns the default style value. |
Overrides
MakeCopy(StyleInfoBase, StyleInfoProperty)
Makes an exact copy of the current object.
Declaration
public override IStyleInfoSubObject MakeCopy(StyleInfoBase newOwner, StyleInfoProperty sip)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoBase | newOwner | The new owner style object for the copied object. |
| StyleInfoProperty | sip | The identifier for this object. |
Returns
| Type | Description |
|---|---|
| IStyleInfoSubObject | A copy of the current object registered with the new owner style object. |