Omnis Command Reference

Omnis Software Ltd

May 2023 - Updated Oct 2023 Revision 35659

About this Manual

This manual contains a complete list of 4GL commands available in Omnis Studio, arranged in alphabetical order. See the Omnis Programming manual for further information about using the Omnis commands.

Command information

Each command has the following information, as well as the syntax, description, and an Omnis code example.

Command group Flag affected Reversible Execute on Client Platform(s)
Functional group,
e.g. "Constructs"
Whether or not (YES/NO) the command sets the flag when it executes; if the command executes successfully the flag is set to True, if it fails the flag is set to False. Whether or not (YES/NO) the command is reversed when it is executed within a reversible block; see Begin reversible block command. Whether or not (YES/NO) the command can be executed in a client method in the JavaScript Client; see also Client commands Which platform the command is available on, including: Windows, Linux, macOS; All indicates the command is available on all platforms

Command Groups

In versions of Omnis Studio prior to version 10.x the commands were arranged in groups in the Method Editor, but the command groups no longer appear in the Code Editor. The commands are listed here in the same functional groups for your convenience only.

Calculations Classes Constructs Debugger
Error handlers Events External commands Externals
Libraries Message boxes Methods Operating system
Parameters and variables Reports and Printing SQL Object Commands Text
Threads

The following commands apply to desktop apps only, and should not be used in web or mobile apps.

Changing data Clipboard Data files Data management
Enter data Exchanging data Fields Files
Finding data Importing and Exporting List lines Lists
Menus Omnis environment Report destinations Report parameters
Searches Sort fields Tasks Toolbars
Windows

 

Client Commands

The following commands can be executed in a client method in the JavaScript Client.

Command
# Comment
Begin text block
Break to end of switch
Breakpoint
Calculate
Case
Default
Do
Do inherited
Do method
Else
Else If calculation
Else If flag false
Else If flag true
End For
End If
End Switch
End text block
End While
For field value
Get text block
If calculation
If flag false
If flag true
JavaScript:
Jump to start of loop
OK message
On
On default
Quit event handler
Quit method
Repeat
Send to trace log
Set reference
Sound bell
Switch
Text:
Until calculation
Until flag false
Until flag true
While calculation
While flag false
While flag true

Error Codes

FileOps Error Codes Web Error Codes                      

Obsolete Commands

There were several commands or command groups marked as ‘Obsolete’ in versions of Omnis Studio prior to Studio 10.0 and these have been removed from Omnis Studio and will be commented out in converted libraries: for the benefit of existing users, the obsolete commands are listed here: Obsolete Commands

Command Filters

The commands in Omnis perform many different functions, including many legacy features that are no longer required for creating web and mobile apps using the JavaScript Client. There is a filter mechanism in the Method Editor to filter the list of commands that are displayed in the Code Assistant help list, primarily to remove any old commands, including those for managing Omnis datafiles.

Note you can still use the excluded commands in your code, and methods in converted libraries using these commands will continue to work – the filters just hide the commands from the Code Assistant help list.

The command filter is set under the Filter Commands submenu in the Modify menu in the Method Editor: note this is only visible when the cursor is in Code Editor, while editing a line of code. The Exclude Old Commands filter is enabled by default, which excludes over 200 old commands, plus there are other filters available that exclude smaller subsets of commands. You can disable the current filter using the No Filter option, in which case all the commands available in Omnis will be shown in the Code Assistant help list.

 

 

The software this document describes is furnished under a license agreement. The software may be used or copied only in accordance with the terms of the agreement. Names of persons, corporations, or products used in the tutorials and examples of this manual are fictitious. No part of this publication may be reproduced, transmitted, stored in a retrieval system or translated into any language in any form by any means without the written permission of Omnis Software.

© Omnis Software, and its licensors 2023. All rights reserved.
Portions © Copyright Microsoft Corporation.
Regular expressions Copyright (c) 1986,1993,1995 University of Toronto.
© 1999-2023 The Apache Software Foundation. All rights reserved.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
Specifically, this product uses Json-smart published under Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
© 2001-2023 Python Software Foundation; All Rights Reserved.
The iOS application wrapper uses UICKeyChainStore created by http://kishikawakatsumi.com and governed by the MIT license.
Omnis® and Omnis Studio® are registered trademarks of Omnis Software.
Microsoft, MS, MS-DOS, Visual Basic, Windows, Windows Vista, Windows Mobile, Win32, Win32s are registered trademarks, and Windows NT, Visual C++ are trademarks of Microsoft Corporation in the US and other countries.
Apple, the Apple logo, Mac OS, Macintosh, iPhone, and iPod touch are registered trademarks and iPad is a trademark of Apple, Inc.
IBM, DB2, and INFORMIX are registered trademarks of International Business Machines Corporation.
ICU is Copyright © 1995-2023 International Business Machines Corporation and others.
UNIX is a registered trademark in the US and other countries exclusively licensed by X/Open Company Ltd.
Portions Copyright (c) 1996-2023, The PostgreSQL Global Development Group
Portions Copyright (c) 1994, The Regents of the University of California
Oracle, Java, and MySQL are registered trademarks of Oracle Corporation and/or its affiliates
SYBASE, Net-Library, Open Client, DB-Library and CT-Library are registered trademarks of Sybase Inc.
Acrobat is a registered trademark of Adobe Systems, Inc.
CodeWarrior is a trademark of Metrowerks, Inc.
This software is based in part on ChartDirector, copyright Advanced Software Engineering (www.advsofteng.com).
This software is based in part on the work of the Independent JPEG Group.
This software is based in part of the work of the FreeType Team.
Other products mentioned are trademarks or registered trademarks of their corporations.