Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Key Repeat? Event (Not in Base Package)

LabVIEW 8.5 Help
August 2007

NI Part Number:
371361D-01

»View Product Info

Event for Control.

Generated when the user presses and holds a key in a front panel control. The Key Repeat? event is a filter event.

For a filter event, if you do not wire an element in the Event Filter Node that appears on the right-hand side of the event case, the default value of the element is the value output by the corresponding element in the Event Data Node on the left-hand side of the event case.

Note  LabVIEW only generates events for the Cluster»All Elements source when the cluster has keyboard focus, not when an individual element inside the cluster has keyboard focus.

Event Data Fields

NameDescription
SourceSource of the event.
0LabVIEW UI
1ActiveX
2.NET
25User Event
nOther
TypeType of event that occurred, such as Mouse Down, Value Change, Timeout, and so on.
TimeValue of the millisecond timer when the event occurred.
CtlRefReference to the control on which the event occurred.
CharASCII value that corresponds to the key pressed on the keyboard, or zero if the character is not an ASCII character. You also can modify the data returned by this event data field.
VKeyEnumerated type indicating the virtual key code of the key pressed. Values include ASCII, Shift, NumLock, F1, and so on. You also can modify the data received from this event data field.
Note  VKey has separate values for the <Enter> key on the alphanumeric keyboard and <Enter> key on the numeric keypad.
ScanCodeScan code unique for each key on the keyboard. The values are unique for each physical key, and allow you to match Key Up and Key Down events.
ModsCluster of Booleans that contain platform-independent modifiers. LabVIEW returns all platform-dependent modifiers in the PlatMods event data field. For key events, this event returns a Boolean indicating if the event occurred on the numeric keypad. For mouse events, this event returns a Boolean indicating if the event was a double-click. For both events, a Boolean is returned if the platform-independent menu key, such as <Ctrl> on Windows or <Command> on Mac OS, was pressed when the event occurred. For filter events, you can modify the data returned by this event data field.
PlatModsCluster of Booleans that contain platform-dependent modifiers. Specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can be both a Mod and PlatMod. For example, <Ctrl> is the platform-independent menu key on Windows, but you also can use it in platform-dependent programming.
FocusObjA reference to the object that has keyboard focus. When the event is for a control, it might be a sub-component, like a scale, label, and so on, rather than the control itself. You also can modify the data returned by this event data field. You cannot generate any Key events on a control inside a cluster.
Discard?Allows you to prevent LabVIEW from processing the event, bypassing the behavior normally triggered by that event. The default is FALSE.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit