Get(ActiveModifierKeys) function

Contents > Functions reference (alphabetical list) > Get functions > Get(ActiveModifierKeys) function

Get(ActiveModifierKeys) function

Format


Get(ActiveModifierKeys)

Parameter

None

Data type returned

number

Description

Returns a number representing the keyboard modifier keys (for example, Control+Shift) that are being pressed. The number is calculated by summing numbers representing each modifier key being pressed. The values assigned to the keys are:

Shift = 1

Caps Lock = 2

Ctrl (Windows) and Control (Mac OS) = 4

Alt (Windows) and Option (Mac OS) = 8

⌘ (Mac OS) = 16

Note See Solving calculations on a host machine for information about running scripts in client/server and peer-to-peer environments.

Example

Returns the number 9 when Shift+Alt is pressed on a computer running Windows.

You could use this function in a script that includes a custom dialog box script step (with an OK and Cancel button) to perform some special action if the user presses the Alt (or Option) key while clicking OK.

Related topics

Functions reference (category list)

Functions reference (alphabetical list)

About formulas

About functions

Defining calculation fields

Using operators in formulas

Contents > Functions reference (alphabetical list) > Get functions > Get(ActiveModifierKeys) function