Parent: Object
The Handle class represents a draggable handle belonging to a chart drawing object. Handles define points used by DrawingObjectBase-derived objects and can typically be moved by the user with the mouse.
Creates a new Handle associated with the DrawingObjectBase instance specified in parent. The Handle is visible and draggable by default.
Returns the BarHistory associated with the Handle's Parent drawing object.
Gets or sets the date/time coordinate of the Handle within its source historical data.
Gets or sets the BarHistory index associated with the Handle. The getter determines the index from DateTime and returns -1 if the BarHistory is empty, or if the Handle's DateTime falls outside the current BarHistory range. Assigning this property changes DateTime to the DateTime of the specified bar index. If Bars is null or the supplied index is beyond the end of the BarHistory, the assignment is ignored.
Controls whether the user can drag the Handle with the mouse. The default value is true.
Returns the DrawingObjectBase instance that this Handle belongs to.
Restores the Handle's persisted state from the string specified in s. The restored values include DateTime, Value, SnapToPrice, and Visible.
Returns a string containing the persisted state of the Handle, including DateTime, Value, SnapToPrice, and Visible.
Indicates whether the Handle should snap to an appropriate plotted value as the user moves it with the mouse. In the price pane, this typically means snapping to a nearby Open, High, Low, or Close value. Drawing objects plotted in other panes can use corresponding plotted TimeSeries values.
Gets or sets the y-axis value of the Handle.
Controls whether the Handle is displayed when WealthLab renders the drawing object's handles. The default value is true.