Omnis Function Reference

Omnis Software Ltd
August 2017

 

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 Ltd.
© 1999-2017 The Apache Software Foundation. All rights reserved.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
OMNIS® and Omnis Studio® are registered trademarks of Omnis Software Ltd.
Microsoft, MS, MS-DOS, Visual Basic, Windows, Windows 95, Win32, Win32s are registered trademarks, and Windows NT, Visual C++ are trademarks of Microsoft Corporation in the US and other countries.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world.
IBM, DB2, and INFORMIX are registered trademarks of International Business Machines Corporation.
UNIX is a registered trademark in the US and other countries exclusively licensed by X/Open Company Ltd.
Sun, Sun Microsystems, the Sun Logo, Solaris, Java, and Catalyst are trademarks or registered trademarks of Sun Microsystems Inc.
MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries (www.mysql.com).
ORACLE is a registered trademark and SQL*NET is a trademark of Oracle Corporation.
SYBASE, Net-Library, Open Client, DB-Library and CT-Library are registered trademarks of Sybase Inc.
Acrobat is a trademark of Adobe Systems, Inc.
Apple, the Apple logo, AppleTalk, and Macintosh are registered trademarks and MacOS, Power Macintosh and PowerPC are trademarks of Apple Computer, Inc.
HP-UX is a trademark of Hewlett Packard.
OSF/Motif is a trademark of the Open Software Foundation.
CodeWarrior is a trademark of Metrowerks, Inc.
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.

Functions

This manual lists all the functions available in Omnis Studio. The functions are in alphabetical order, but note that the external functions are prefixed with their respective package name, e.g. Fileops, OJSON, OXML, StringTable, etc. You can find a complete list of functions in Omnis in the Catalog (press F9) arranged in functional groups.

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

Function group Execute on Client Platform(s)
The group within the Omnis Catalog (F9). Whether or not (YES/NO) the function can be executed in a client method in the JavaScript Client Which platform the function is available on, including: Windows, macOS, Linux; All indicates the command is available on all platforms

Function Groups

Binary Field Class Client String Table Compression
Date and Time DNet External functions Field
FileOps Financial Font handling FontOps
General JavaObjs Library List Logarithmic
Lookup Mouse Number OJSON
Omnis PDF Device OmnisIcn Library OWEB OXML
Picture PortProfile Random RESTful
String StringTable Trigonometric Unicode

Client Functions

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

abs() acos() alt() asin()
atan() atan2() br() callprivate()
cap() cmd() con() cos()
ctrl() dadd() dat() dim()
dtcy() dtd() dtm() dtw()
dty() errcode() errtext() exp()
flag() fmtdatetime() fmtshortdate() fmtshorttime()
getdatetime() getticks() int() isclear()
isnull() isunicode() jst() left()
len() list() ln() locale()
log() low() max() mid()
min() mod() msgcancelled() not()
pick() pos() pwr() replace()
replaceall() rgb() right() rnd()
row() rpos() shift() sin()
sqr() stgettext() style() styledtohtml()
tan() tracelog() trim() unichr()
unicode() upp() useradians()