menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class LegendStyle - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class LegendStyle

    Represents the class to define the style for ChartLegend.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    StyleInfoBase
    StyleInfoSubObjectBase
    LegendStyle
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    IStyleInfoSubObject
    Inherited Members
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    StyleInfoBase.BeginInit()
    StyleInfoBase.BeginUpdate()
    StyleInfoBase.CacheValues
    StyleInfoBase.Changed
    StyleInfoBase.Changing
    StyleInfoBase.ClearCache()
    StyleInfoBase.CopyFrom(IStyleInfo)
    StyleInfoBase.Dispose()
    StyleInfoBase.EndInit()
    StyleInfoBase.EndUpdate()
    StyleInfoBase.Equals(Object)
    StyleInfoBase.EqualsObject(Object, Object)
    StyleInfoBase.GetDefaultStyleInfoStore(StyleInfoProperty)
    StyleInfoBase.GetDefaultValue(StyleInfoProperty)
    StyleInfoBase.GetHashCode()
    StyleInfoBase.GetShortValue(StyleInfoProperty)
    StyleInfoBase.GetValue(StyleInfoProperty)
    StyleInfoBase.HasValue(StyleInfoProperty)
    StyleInfoBase.IConvertible.GetTypeCode()
    StyleInfoBase.IConvertible.ToBoolean(IFormatProvider)
    StyleInfoBase.IConvertible.ToByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToChar(IFormatProvider)
    StyleInfoBase.IConvertible.ToDateTime(IFormatProvider)
    StyleInfoBase.IConvertible.ToDecimal(IFormatProvider)
    StyleInfoBase.IConvertible.ToDouble(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt32(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt64(IFormatProvider)
    StyleInfoBase.IConvertible.ToSByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToSingle(IFormatProvider)
    StyleInfoBase.IConvertible.ToString(IFormatProvider)
    StyleInfoBase.IConvertible.ToType(Type, IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt32(IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt64(IFormatProvider)
    StyleInfoBase.Identity
    StyleInfoBase.InheritStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.IsChanged
    StyleInfoBase.IsEmpty
    StyleInfoBase.IsSubset(IStyleInfo)
    StyleInfoBase.IsValueModified(StyleInfoProperty)
    StyleInfoBase.MergeStyle(IStyleInfo)
    StyleInfoBase.ModifyStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.OnStyleChanging(StyleInfoProperty)
    StyleInfoBase.ParseString(String)
    StyleInfoBase.ReadXml(XmlReader)
    StyleInfoBase.ResetValue(StyleInfoProperty)
    StyleInfoBase.SetStore(StyleInfoStore)
    StyleInfoBase.SetValue(StyleInfoProperty, Int16)
    StyleInfoBase.SetValue(StyleInfoProperty, Object)
    StyleInfoBase.ToString()
    StyleInfoBase.ToString(String)
    StyleInfoBase.ToString(String, IFormatProvider)
    StyleInfoBase.Updating
    StyleInfoBase.WeakReferenceChangedListeners
    StyleInfoBase.WriteXml(XmlWriter)
    StyleInfoSubObjectBase.Data
    StyleInfoSubObjectBase.Dispose(Boolean)
    StyleInfoSubObjectBase.IntGetDefaultStyleInfo(StyleInfoProperty)
    StyleInfoSubObjectBase.OnStyleChanged(StyleInfoProperty)
    StyleInfoSubObjectBase.Owner
    StyleInfoSubObjectBase.Sip
    StyleInfoSubObjectBase.SubObjectIdentity
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.WinForms.SmithChart
    Assembly: Syncfusion.SfSmithChart.WinForms.dll
    Syntax
    public class LegendStyle : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

    Constructors

    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

    to create an identity for LegendStyle.

    LegendStyle(StyleInfoSubObjectIdentity, SmithChartStyleInfoStore)

    Initializes a new instance of the LegendStyle class.

    Declaration
    public LegendStyle(StyleInfoSubObjectIdentity identity, SmithChartStyleInfoStore store)
    Parameters
    Type Name Description
    StyleInfoSubObjectIdentity identity

    to create an identity for LegendStyle.

    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
    StyleInfoBase.CreateSubObjectIdentity(StyleInfoProperty)

    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
    StyleInfoBase.GetDefaultStyle()

    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.

    Overrides
    StyleInfoSubObjectBase.MakeCopy(StyleInfoBase, StyleInfoProperty)

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    IStyleInfoSubObject
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved