Interface IChartLegend

Specifies the default properties of legend.

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Base.dll

Syntax

public interface IChartLegend

Properties

Alignment

Gets or sets the alignment.

Declaration

ChartAlignment Alignment { get; set; }

Property Value

Type	Description
ChartAlignment	The alignment.

BackColor

Gets or sets the background color of the legend.

Declaration

Color BackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

ColumnsCount

Gets or sets the columns count.

Declaration

int ColumnsCount { get; set; }

Property Value

Type	Description
System.Int32	The columns count.

FloatingAutoSize

Gets or sets a value indicating whether [floating auto size].

Declaration

bool FloatingAutoSize { get; set; }

Property Value

Type	Description
System.Boolean	true if [floating auto size]; otherwise, false.

Font

Gets or sets the font.

Declaration

Font Font { get; set; }

Property Value

Type	Description
System.Drawing.Font	The font.

ForeColor

Gets or sets the foreground color of the legend.

Declaration

Color ForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

ItemsAlignment

Gets or sets the items alignment.

Declaration

StringAlignment ItemsAlignment { get; set; }

Property Value

Type	Description
System.Drawing.StringAlignment	The items alignment.

ItemsShadowColor

Gets or sets the color of the items shadow.

Declaration

Color ItemsShadowColor { get; set; }

Property Value

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

ItemsShadowOffset

Gets or sets the items shadow offset.

Declaration

Size ItemsShadowOffset { get; set; }

Property Value

Type	Description
System.Drawing.Size	The items shadow offset.

ItemsSize

Gets or sets the size of the items.

Declaration

Size ItemsSize { get; set; }

Property Value

Type	Description
System.Drawing.Size	The size of the items.

ItemsTextAligment

Gets or sets the items text aligment.

Declaration

VerticalAlignment ItemsTextAligment { get; set; }

Property Value

Type	Description
VerticalAlignment	The items text aligment.

Name

Gets or sets the name.

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String

OnlyColumnsForFloating

Gets or sets a value indicating whether [only columns for floating].

Declaration

bool OnlyColumnsForFloating { get; set; }

Property Value

Type	Description
System.Boolean	true if [only columns for floating]; otherwise, false.

Orientation

Gets or sets the orientation.

Declaration

ChartOrientation Orientation { get; set; }

Property Value

Type	Description
ChartOrientation	The orientation.

Position

Gets or sets the position.

Declaration

ChartDock Position { get; set; }

Property Value

Type	Description
ChartDock	The position.

RepresentationType

Gets or sets the type of the representation.

Declaration

ChartLegendRepresentationType RepresentationType { get; set; }

Property Value

Type	Description
ChartLegendRepresentationType	The type of the representation.

RowsCount

Gets or sets the rows count.

Declaration

int RowsCount { get; set; }

Property Value

Type	Description
System.Int32	The rows count.

SetDefSizeForCustom

Gets or sets a value indicating whether [set def size for custom].

Declaration

bool SetDefSizeForCustom { get; set; }

Property Value

Type	Description
System.Boolean	true if [set def size for custom]; otherwise, false.

ShowItemsShadow

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

Declaration

bool ShowItemsShadow { get; set; }

Property Value

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

ShowSymbol

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

Declaration

bool ShowSymbol { get; set; }

Property Value

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

Spacing

Gets or sets the spacing.

Declaration

int Spacing { get; set; }

Property Value

Type	Description
System.Int32	The spacing.

VisibleCheckBox

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

Declaration

bool VisibleCheckBox { get; set; }

Property Value

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

Events

FilterItems

Fired when the legend items need to be filtered. Handle this event to change the collection of ChartLegendItems that the legend contains.

Declaration

event LegendFilterItemsEventHandler FilterItems

Event Type

Type	Description
LegendFilterItemsEventHandler