LegendBoxBase Class

LightningChart .NET Help

LegendBox shows the series names and line/point styles in a box.

Inheritance Hierarchy

SystemObject
  Arction.WinForms.ChartingChartNode
    Arction.WinForms.ChartingUserInteractiveObjectInt
      Arction.WinForms.ChartingUserInteractiveObject
        Arction.WinForms.ChartingHighlightingItemBase
          Arction.WinForms.ChartingDraggableObject
            Arction.WinForms.Charting.ViewsLegendBoxBase
              Arction.WinForms.Charting.Views.View3DLegendBox3DBase
              Arction.WinForms.Charting.Views.ViewRoundLegendBoxRound
              Arction.WinForms.Charting.Views.ViewXYLegendBoxXY

Namespace: Arction.WinForms.Charting.Views
Assembly: Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public class LegendBoxBase : DraggableObject

<SerializableAttribute>
<TypeConverterAttribute(GetType(GeneralTypeConverter))>
Public Class LegendBoxBase
	Inherits DraggableObject

[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public ref class LegendBoxBase : public DraggableObject

The LegendBoxBase type exposes the following members.

Constructors

	Name	Description
	LegendBoxBase	Constructor.

Top

Properties

	Name	Description
	AllowDragging	Gets or sets whether dragging by user is allowed. (Inherited from DraggableObject.)
	AllowResize	Allow resize by user interactive device.
	AllowUserInteraction	Gets or sets whether allow user interaction. (Inherited from UserInteractiveObject.)
	AutoSize	Automatic sizing based on contents.
	BorderColor	Border color.
	BorderWidth	Border width.
	CheckBoxColor	Checkbox color.
	CheckBoxSize	LegendBox checkbox size in DPI.
	CheckMarkColor	Checkbox mark color.
	Fill	Fill.
	Height	Height. Applies when AutoSize is not used.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. (Inherited from HighlightingItemBase.)
	HighlightSeriesOnTitle	Highlight series, if user interactive device is over it or title on legend box.
	HighlightSeriesTitleColor	Highlighted series title color on legend box.
	Layout	LegendBox layout.
	MoveFromSeriesTitle	Allow LegendBox moving from series title, which prevents sending messages from the series title clicks.
	Offset	Offset from location calculated by Position property.
	ScrollBarVisibility	LegendBox scroll bar visibility setting.
	SeriesTitleColor	Series title color.
	SeriesTitleFont	Series title font.
	Shadow	Shadow beneath the LegendBox.
	ShowCheckboxes	Show checkboxes for selecting visibility of series.
	ShowIcons	Show icons.
	UnitsColor	Units text color.
	UnitsFont	Units text font.
	UseSeriesTitlesColors	Use series title color. If false, uses Items color.
	ValueLabelColor	Series value label color.
	ValueLabelFont	Series value text font.
	Width	Width. Applies when AutoSize is not used.
	Visible	Is LegendBox visible.

Top

Methods

	Name	Description
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRenderedRect	Get rendered rectangle.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsPositionOver	Is mouse over item. (Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean).)
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	ResetLocation	Reset location, if moved by mouse. (Inherited from DraggableObject.)
	SetHighlight	Highlights the object. This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. (Inherited from HighlightingItemBase.)
	SetProperCursor	Set cursor. (Overrides DraggableObjectSetProperCursor.)
	ToString	Convert class description to string. (Overrides HighlightingItemBaseToString.)

Top

Events

	Name	Description
	CheckBoxStateChanged	Occurs when the state of a series title check box has changed.
	DraggedByUser	Dragged by user. (Inherited from DraggableObject.)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase.)
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	SeriesTitleMouseClick	Occurs when a user interactive device button is clicked on a series title.
	SeriesTitleMouseDoubleClick	Occurs when a mouse button is double-clicked on a series title.
	SeriesTitleMouseDown	Occurs when a user interactive device is pressed down on a series title.
	SeriesTitleMouseUp	Occurs when a user interactive device button is released over a series title.

Top

Fields

	Name	Description
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt.)

Top

Reference

Arction.WinForms.Charting.Views Namespace