Omnis Function Reference

Omnis Software Ltd

May 2023 - Updated Oct 2023 Revision 35659

About This Manual

This manual contains a complete list of 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) under the Functions tab and arranged in functional groups. You can use the Search option to find functions that contain a given string, e.g. enter ‘text’ to find all the functions containing ‘text’; in this case, the list of function groups (on the left) is filtered showing only those groups that contain any functions matching the search.

image1

Function information

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; see also Client functions 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 Compression Date and Time
DNet External functions Field FileOps
Financial Font handling FontOps General
List Logarithmic Lookup Number
OIMAGE OJSON Omnis PDF Device OmnisICalendar
OmnisIcn Library ONOTIFY OW3 OXML
Picture PortProfile Random rcedit
RESTful String StringTable Trigonometric
Unicode

The following functions are for desktop apps only, not web or mobile apps.

Mouse

 

Client Functions

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

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

 

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.