Click or drag to resize

LegendBoxBase Class

LightningChart .NET Help
LegendBox shows the series names and line/point styles in a box.
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingMVVMChartNode
          Arction.Wpf.ChartingMVVMUserInteractiveObjectInt
            Arction.Wpf.ChartingMVVMUserInteractiveObject
              Arction.Wpf.ChartingMVVMHighlightingItemBase
                Arction.Wpf.ChartingMVVMDraggableObject
                  Arction.Wpf.ChartingMVVM.ViewsLegendBoxBase
                    Arction.Wpf.ChartingMVVM.Views.View3DLegendBox3DBase
                    Arction.Wpf.ChartingMVVM.Views.ViewRoundLegendBoxRound
                    Arction.Wpf.ChartingMVVM.Views.ViewXYLegendBoxXY

Namespace:  Arction.Wpf.ChartingMVVM.Views
Assembly:  Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.LightningChart.dll) Version: 10.3.1
Syntax
[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public class LegendBoxBase : DraggableObject

The LegendBoxBase type exposes the following members.

Constructors
  NameDescription
Public methodLegendBoxBase
Constructor.
Top
Properties
  NameDescription
Public propertyAllowDragging
Gets or sets if allow dragging by user. This is a dependency property.
(Inherited from DraggableObject.)
Public propertyAllowResize
Gets or sets whether the legend box can be resized by user interactive device. This is a dependency property.
Public propertyAllowUserInteraction
Gets or sets if user interaction is allowed. This is a dependency property.
(Inherited from UserInteractiveObject.)
Public propertyAutoSize
Gets or sets whether the legend box resizes itself. This is a dependency property.
Public propertyBorderColor
Gets or sets border color. This is a dependency property.
Public propertyBorderWidth
Gets or sets border width. This is a dependency property.
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyCheckBoxColor
Gets or sets checkbox color. This is a dependency property.
Public propertyCheckBoxSize
Gets of sets checkbox size in DPI
Public propertyCheckMarkColor
Gets or sets checkbox mark color. This is a dependency property.
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyFill
Gets or sets fill. This is a dependency property.
Public propertyHeight
Gets or sets the height of the legend box. This is a dependency property.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property.
(Inherited from HighlightingItemBase.)
Public propertyHighlightSeriesOnTitle
Gets or sets highlight series, if user interactive device is over it or title on legendbox. This is a dependency property.
Public propertyHighlightSeriesTitleColor
Gets or sets highlighted series title color on legend box. This is a dependency property.
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyLayout
Gets or sets layout. This is a dependency property.
Public propertyMoveFromSeriesTitle
Gets or sets if allow legendbox moving from series title, which prevents sending messages from the series title clicks. This is a dependency property.
Public propertyOffset
Gets or sets offset from location calculated by Position property. This is a dependency property.
Public propertyScrollBarVisibility
Scroll bar visibility setting. This is a Dependency property.
Public propertySeriesTitleColor
Gets or sets series title color. This is a dependency property.
Public propertySeriesTitleFont
Gets or sets series title font. This is a dependency property.
Public propertyShadow
Gets or sets shadow beneath the legend box. This is a dependency property.
Public propertyShowCheckboxes
Gets or sets if show checkboxes for selecting visibility of series. This is a dependency property.
Public propertyShowIcons
Gets or sets if show icons. This is a dependency property.
Public propertyUnitsColor
Gets or sets units text color. This is a dependency property.
Public propertyUnitsFont
Gets or sets units text font. This is a dependency property.
Public propertyUseSeriesTitlesColors
Gets or sets if use series title color. If false, uses Items color. This is a dependency property.
Public propertyValueLabelColor
Gets or sets series value color. This is a dependency property.
Public propertyValueLabelFont
Gets or sets series value text font. This is a dependency property.
Public propertyWidth
Gets or sets the width of the legend box. This is a dependency property.
Public propertyVisible
Gets or sets if legend box is visible. This is a dependency property.
Top
Methods
  NameDescription
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.
(Inherited from Freezable.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetCurrentValueAsFrozen
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetRenderedRect
Get rendered rectangle.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsPositionOver
Is mouse over item.
(Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean).)
Public methodStatic memberLayoutCoerceValue
New layout coerce value
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodResetLocation
Reset location, if moved by mouse.
(Inherited from DraggableObject.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetHighlight
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.)
Public methodSetProperCursor
Set cursor.
(Overrides DraggableObjectSetProperCursor.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Public methodToString
Convert class description to string.
(Overrides HighlightingItemBaseToString.)
Top
Events
  NameDescription
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventCheckBoxStateChanged
Occurs when the state of a series title check box has changed.
Public eventDraggedByUser
Dragged by user.
(Inherited from DraggableObject.)
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Public eventSeriesTitleMouseClick
Series title mouse click event handler.
Public eventSeriesTitleMouseDoubleClick
Series title mouse double click event handler.
Public eventSeriesTitleMouseDown
Series title mouse down event handler.
Public eventSeriesTitleMouseUp
Series title mouse up event handler.
Top
Fields
  NameDescription
Public fieldStatic memberAllowResizeProperty
Identifies the AllowResize dependency property.
Public fieldStatic memberAutoSizeProperty
Identifies the AutoSize dependency property.
Public fieldStatic memberBorderColorProperty
Identifies the BorderColor dependency property.
Public fieldStatic memberBorderWidthProperty
Identifies the BorderWidth dependency property.
Public fieldStatic memberCheckBoxColorProperty
Identifies the CheckBoxColor dependency property.
Public fieldStatic memberCheckBoxSizeProperty
Identifies the CheckBoxSize [DPI] dependency property.
Public fieldStatic memberCheckMarkColorProperty
Identifies the CheckMarkColor dependency property.
Public fieldStatic memberFillProperty
Identifies the Fill dependency property.
Public fieldStatic memberHeightProperty
Identifies the Height dependency property.
Public fieldStatic memberHighlightSeriesOnTitleProperty
Identifies the HighlightSeriesOnTitle dependency property.
Public fieldStatic memberHighlightSeriesTitleColorProperty
Identifies the HighlightSeriesTitleColor dependency property.
Public fieldStatic memberLayoutProperty
Identifies the Layout dependency property.
Public fieldStatic memberMoveFromSeriesTitleProperty
Identifies the MoveFromSeriesTitle dependency property.
Public fieldStatic memberOffsetProperty
Identifies the Offset dependency property.
Public fieldStatic memberScrollBarVisibilityProperty
Identifies the ScrollBarVisibility dependency property.
Public fieldStatic memberSeriesTitleColorProperty
Identifies the SeriesTitleColor dependency property.
Public fieldStatic memberSeriesTitleFontProperty
Identifies the SeriesTitleFont dependency property.
Public fieldStatic memberSeriesTitleMouseClickEvent
Occurs when a user interactive device button is clicked on a series title.
Public fieldStatic memberSeriesTitleMouseDoubleClickEvent
Occurs when a mouse button is double-clicked on a series title.
Public fieldStatic memberSeriesTitleMouseDownEvent
Occurs when a user interactive device is pressed down on a series title.
Public fieldStatic memberSeriesTitleMouseUpEvent
Occurs when a user interactive device button is released over a series title.
Public fieldStatic memberShadowProperty
Identifies the Shadow dependency property.
Public fieldStatic memberShowCheckboxesProperty
Identifies the ShowCheckboxes dependency property.
Public fieldStatic memberShowIconsProperty
Identifies the ShowIcons dependency property.
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Public fieldStatic memberUnitsColorProperty
Identifies the UnitsColor dependency property.
Public fieldStatic memberUnitsFontProperty
Identifies the UnitsFont dependency property.
Public fieldStatic memberUseSeriesTitlesColorsProperty
Identifies the UseSeriesTitlesColors dependency property.
Public fieldStatic memberValueLabelColorProperty
Identifies the ValueLabelColor dependency property.
Public fieldStatic memberValueLabelFontProperty
Identifies the ValueLabelFont dependency property.
Public fieldStatic memberWidthProperty
Identifies the Width dependency property.
Public fieldStatic memberVisibleProperty
Identifies the Visible dependency property.
Top
See Also