Interface IHighlightingItem
- Namespace
- LightningChartLib.WinForms.Charting
- Assembly
- LightningChart.WinForms.Charting.NET4.dll
Interface of objects that can be highlighted.
Allows user to highlight the object and define how the object should be highlighted. The objects also report to users when they are highlighted.
public interface IHighlightingItemProperties
Highlight
Setter highlighting style.
Highlight Highlight { get; set; }Property Value
Remarks
Note that forced highlighting does not necessarily follow this. See SetHighlight for more information.
Methods
IsHighlighted()
returns true if the object is highlighted.
bool IsHighlighted()Returns
- bool
True if the object is highlighted.
Remarks
Note that this value reflects the state of the object before it's drawn on screen, so if mouse is moved, this is set, and then a new frame is drawn. Prior version 8.0.1 returned value reflected the currently visible state, meaning that the state changed only after the new frame, and thus right after mouse hovering the state was kind of wrong.
RemoveHighlight()
Removes forced highlighting.
void RemoveHighlight()Remarks
Note that this does not prevent the highlighting caused by mouse hovering.
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.
void SetHighlight()Events
HighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
event HighlightedStateEventHandler HighlightedStateChanged