ChartMouseEventArgs.ShiftKey

property · ChartMouseEventArgs · cAlgo.API

DesktopCLICloud

Defines whether the Shift key is pressed during the mouse event.

Environment behaviour

CLI — not supported. Never raised in the CLI: the events that pass it never fire there (ChartArea.MouseDown, ChartArea.MouseEnter, ChartArea.MouseLeave and more).

Cloud — not supported. Never raised in the cloud: the events that pass it never fire there (ChartArea.MouseDown, ChartArea.MouseEnter, ChartArea.MouseLeave and more).

Definition

C#Python

public bool ShiftKey {get;}

chartMouseEventArgs.ShiftKey: bool

Returns bool

Examples

C#Python

protected override void OnStart()
{
    Chart.MouseDown += OnChartMouseDown;
}

private void OnChartMouseDown(ChartMouseEventArgs args)
{
    if (args.ShiftKey)
        Chart.DrawIcon("shiftClick", ChartIconType.Star, args.TimeValue, args.YValue, Color.Gold);
}

def on_start(self):
    api.Chart.MouseDown += self.on_chart_mouse_down

def on_chart_mouse_down(self, args):
    if args.ShiftKey:
        api.Chart.DrawIcon("shiftClick", ChartIconType.Star, args.TimeValue, args.YValue, Color.Gold)