Remove Method - Function Keys
Removes the specified function key from the FunctionKeys collection.
Client support
Newlook Smartclient
Newlook Server
Syntax
App.ActiveForm.FunctionKeys.Remove(Fnckey)
Parameters
Fnckey – (Object, Required)
The function key to be removed. It is possible to reference a function key by either its name or its index in the collection.
Returns
Returns a Boolean indicating the success or failure of the action.
Use
TIP!
The Remove method cannot be used to remove function keys that are generated by the host application, only inserted function keys, created in Designer or via the Add method. If you wish to hide a function key on a form at runtime you will need to add logic that sets its Visible property to False and assign it to the OnReceive and OnRefresh events of the form.
Examples
The following example will remove an inserted function key called 'fncPrompt' from the form.
JSCRIPT
function RemoveFunctionKeyByName()
{
removeSuccess = App.ActiveForm.FunctionKeys.Remove(fncPrompt);
}
VB SCRIPT
Sub RemovePromptKey
'Remove prompt function key from the form.
removeSucess = App.ActiveForm.FunctionKeys.Remove (FncPrompt)
End Sub
See Also
Add Method - Function Keys| Remove Method - Controls | Remove Method - Items | Remove Method - Nodes | Remove Method - Columns Headers
Applies To
© 2004-2021 looksoftware. All rights reserved.