FunctionKeys Collection
The FunctionKeys collection is a collection whose elements represent each Function Key in a Form.
Client support
Newlook Smartclient
Newlook Server
Use
Function Keys are created dynamically by the recognition engine when a screen is received from the host. Attempting to delete a host-generated function key will set its Visible property to False.
Custom function keys can also be added to, or removed from a form at Design-time or dynamically via the Add or Remove methods of the FunctionKeys collection.
The FunctionKeys collection uses the Count property to return the number of FunctionKeys in the collection.
TIP!
It is not possible to delete the OK function key from the function keys collection. If you do not want this key to appear on the screen then set it's visibility to false.
Common Function Key Tasks
Add a custom function key at design-time
- Position your mouse cursor in the function key bar at the bottom of the screen
- Right mouse-click and select Add a Function Key from the context menu.
- Specify the string that will display in function key via the Text property.
- Specify the key that will be sent to the host when this button is clicked via the OutputKey property. If you do not want a key to be sent to the host then uncheck the SendKey property.
- Specify any macro or script to be run when this function key is clicked via the OnClick property.
Referencing individual function keys
You can reference an individual item within any Newlook collection by using its Index. All indexes in Newlook are zero-based therefore, if you want to return the text of the third item in the function key collection you would use the following syntax:
App.ActiveForm.FunctionKeys(2).Text
Properties
Available in Newlook Smartclient Available in Newlook Server 
Deprecated.
|
Property |
Client |
Description |
|
|
Returns the number of objects in a collection. |
Each individual function key has its own properties and methods. Refer to the FunctionKey object topic for further information.
Applies To
See Also
© 2004-2021 looksoftware. All rights reserved.