Show / Hide Table of Contents

Property MouseTriggers.this(+ 3 overloads)


Overload

Adds a mouse click trigger.

public Action<MouseTriggerArgs> this[TMClick button, string modKeys = null, TMFlags flags = 0, string f_ = null, int l_ = 0] { set; }
Parameters
button  (TMClick)
modKeys  (string)

Modifier keys, like with the keys.send function. Examples: "Ctrl", "Ctrl+Shift+Alt+Win". To ignore modifiers: "?". Then the trigger works with any combination of modifiers. To ignore a modifier: "Ctrl?". Then the trigger works with or without the modifier. More examples: "Ctrl?+Shift?", "Ctrl+Shift?".

flags  (TMFlags)
f_  (string)

Caller info parameter

l_  (int)

Caller info parameter

Exceptions
ArgumentException

Invalid modKeys string or flags.

InvalidOperationException

Cannot add triggers after ActionTriggers.Run was called, until it returns.

Property Value
Action<MouseTriggerArgs>

Examples

See ActionTriggers.


Overload(next)

Adds a mouse wheel trigger.

public Action<MouseTriggerArgs> this[TMWheel direction, string modKeys = null, TMFlags flags = 0, string f_ = null, int l_ = 0] { set; }
Parameters
direction  (TMWheel)
modKeys  (string)

Modifier keys, like with the keys.send function. Examples: "Ctrl", "Ctrl+Shift+Alt+Win". To ignore modifiers: "?". Then the trigger works with any combination of modifiers. To ignore a modifier: "Ctrl?". Then the trigger works with or without the modifier. More examples: "Ctrl?+Shift?", "Ctrl+Shift?".

flags  (TMFlags)
f_  (string)

Caller info parameter

l_  (int)

Caller info parameter

Exceptions
ArgumentException

Invalid modKeys string or flags.

InvalidOperationException

Cannot add triggers after ActionTriggers.Run was called, until it returns.

Property Value
Action<MouseTriggerArgs>

Examples

See ActionTriggers.


Overload(next)

Adds a mouse screen edge trigger.

public Action<MouseTriggerArgs> this[TMEdge edge, string modKeys = null, TMFlags flags = 0, screen screen = default, string f_ = null, int l_ = 0, string a1_ = null] { set; }
Parameters
edge  (TMEdge)
modKeys  (string)

Modifier keys, like with the keys.send function. Examples: "Ctrl", "Ctrl+Shift+Alt+Win". To ignore modifiers: "?". Then the trigger works with any combination of modifiers. To ignore a modifier: "Ctrl?". Then the trigger works with or without the modifier. More examples: "Ctrl?+Shift?", "Ctrl+Shift?".

flags  (TMFlags)
screen  (screen)

The trigger will work in this screen (display monitor). Default: the primary screen. Should be lazy or default; else the function calls print.warning. Examples: screen.at.left(true), screen.index(1, true). If screen.ofMouse, the trigger will work in any screen.

f_  (string)

Caller info parameter

l_  (int)

Caller info parameter

a1_  (string)

Caller info parameter

Exceptions
ArgumentException

Invalid modKeys string or flags.

InvalidOperationException

Cannot add triggers after ActionTriggers.Run was called, until it returns.

Property Value
Action<MouseTriggerArgs>

Examples

See ActionTriggers.


Overload(top)

Adds a mouse move trigger.

public Action<MouseTriggerArgs> this[TMMove move, string modKeys = null, TMFlags flags = 0, screen screen = default, string f_ = null, int l_ = 0, string a1_ = null] { set; }
Parameters
move  (TMMove)
modKeys  (string)

Modifier keys, like with the keys.send function. Examples: "Ctrl", "Ctrl+Shift+Alt+Win". To ignore modifiers: "?". Then the trigger works with any combination of modifiers. To ignore a modifier: "Ctrl?". Then the trigger works with or without the modifier. More examples: "Ctrl?+Shift?", "Ctrl+Shift?".

flags  (TMFlags)
screen  (screen)

The trigger will work in this screen (display monitor). Default: the primary screen. Should be lazy or default; else the function calls print.warning. Examples: screen.at.left(true), screen.index(1, true). If screen.ofMouse, the trigger will work in any screen.

f_  (string)

Caller info parameter

l_  (int)

Caller info parameter

a1_  (string)

Caller info parameter

Exceptions
ArgumentException

Invalid modKeys string or flags.

InvalidOperationException

Cannot add triggers after ActionTriggers.Run was called, until it returns.

Property Value
Action<MouseTriggerArgs>

Examples

See ActionTriggers.