Class ChartLegendItemStyle

Defines the style of a ChartLegendItem.

Inheritance

System.Object

ChartLegendItemStyle

Implements

System.ICloneable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Base.dll

Syntax

public class ChartLegendItemStyle : ICloneable

Constructors

ChartLegendItemStyle()

Initializes a new instance of the ChartLegendItemStyle class.

Declaration

public ChartLegendItemStyle()

Properties

BaseStyle

Gets or sets the base style.

Declaration

public ChartLegendItemStyle BaseStyle { get; set; }

Property Value

Type	Description
ChartLegendItemStyle	The base style.

Border

Gets or sets the border that is to be associated with this item's border.

Declaration

public ChartLineInfo Border { get; set; }

Property Value

Type
ChartLineInfo

BorderColor

Gets or sets the color of the border of the item.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
System.Drawing.Color

Default

Gets the default.

Declaration

public static ChartLegendItemStyle Default { get; }

Property Value

Type	Description
ChartLegendItemStyle	The default.

Font

Gets or sets the font of the text.

Declaration

public Font Font { get; set; }

Property Value

Type
System.Drawing.Font

IconAlignment

Gets or sets the icon alignment.

Declaration

public LeftRightAlignment IconAlignment { get; set; }

Property Value

Type	Description
System.Windows.Forms.LeftRightAlignment	The icon alignment.

ImageIndex

Gets or sets the image index value of the item in the item's image list.

Declaration

public int ImageIndex { get; set; }

Property Value

Type
System.Int32

ImageList

Gets or sets the ImageList associated with this item.

Declaration

public ChartImageCollection ImageList { get; set; }

Property Value

Type
ChartImageCollection

Interior

Gets or sets the interior for the rectangular area that represents a legend.

Declaration

public BrushInfo Interior { get; set; }

Property Value

Type
BrushInfo

IsEmpty

Gets a value indicating whether this style is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean	true if this style is empty; otherwise, false.

RepresentationSize

Gets or sets the size of the rectangle holding the representation of the item.

Declaration

public Size RepresentationSize { get; set; }

Property Value

Type
System.Drawing.Size

ShadowColor

Gets or sets the color of the shadow.

Declaration

public Color ShadowColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the shadow.

ShadowOffset

Gets or sets the shadow offset.

Declaration

public Size ShadowOffset { get; set; }

Property Value

Type	Description
System.Drawing.Size	The shadow offset.

ShowIcon

Gets or sets a value indicating whether [show icon].

Declaration

public bool ShowIcon { get; set; }

Property Value

Type	Description
System.Boolean	true if [show icon]; otherwise, false.

ShowShadow

Gets or sets a value indicating whether [show shadow].

Declaration

public bool ShowShadow { get; set; }

Property Value

Type	Description
System.Boolean	true if [show shadow]; otherwise, false.

ShowSymbol

Gets or sets a value indicating whether [show symbol].

Declaration

public bool ShowSymbol { get; set; }

Property Value

Type	Description
System.Boolean	true if [show symbol]; otherwise, false.

Spacing

Gets or sets the spacing of the item within the legend.

Declaration

public int Spacing { get; set; }

Property Value

Type
System.Int32

Symbol

Gets or sets the symbol that is to be associated with this item.

Declaration

public ChartSymbolInfo Symbol { get; set; }

Property Value

Type
ChartSymbolInfo

TextAlignment

Gets or sets the text alignment.

Declaration

public VerticalAlignment TextAlignment { get; set; }

Property Value

Type	Description
VerticalAlignment	The text alignment.

TextColor

Gets or sets the color of the text of the item.

Declaration

public Color TextColor { get; set; }

Property Value

Type
System.Drawing.Color

Type

Gets or sets the type of representation for the legend item.

Declaration

public ChartLegendItemType Type { get; set; }

Property Value

Type
ChartLegendItemType

Url

Gets or sets the Url that is to be associated with a ChartPoint. This Url will be applied to the point if EnableUrl and CalcRegion property is set to True.This property is applicable only for ChartWeb.

Declaration

public string Url { get; set; }

Property Value

Type
System.String

VisibleCheckBox

Gets or sets a value indicating whether [visible check box].

Declaration

public bool VisibleCheckBox { get; set; }

Property Value

Type	Description
System.Boolean	true if [visible check box]; otherwise, false.

Methods

Clear()

Clears the style values.

Declaration

public void Clear()

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

CreateDefault()

Creates the default style.

Declaration

public static ChartLegendItemStyle CreateDefault()

Returns

Type	Description
ChartLegendItemStyle	Returns ChartLegendItemStyle instance.

CreateDefaultSymbol()

Creates the default symbol info.

Declaration

public static ChartSymbolInfo CreateDefaultSymbol()

Returns

Type	Description
ChartSymbolInfo	Returns ChartSymbolInfo instance.

Dispose()

Method to dispose ChartLegendItemStyle object

Declaration

public void Dispose()

Reset(ChartLegendItemStyle.ChartLegendStyleKeys)

Resets style value by the specified key.

Declaration

public void Reset(ChartLegendItemStyle.ChartLegendStyleKeys key)

Parameters

Type	Name	Description
ChartLegendItemStyle.ChartLegendStyleKeys	key	The key.

SetToLowerLevel(ChartLegendItemStyle)

Sets the parent to the lower level.

Declaration

public void SetToLowerLevel(ChartLegendItemStyle style)

Parameters

Type	Name	Description
ChartLegendItemStyle	style	The style.

Implements

System.ICloneable