Creating Web & Mobile Apps
Creating Web & Mobile Apps
Using Omnis JavaScript Client
Omnis Software Ltd
About This Manual
If you are new to Omnis Studio
When you start Omnis Studio
Copyright info
Chapter 1—Tutorial
What will you learn?
Download & install the Files
Tutorial Libraries
Mouse and Keyboard Usage
Context Menus
Starting Omnis
Studio Browser
Creating a New Library
Creating a Web Form using a wizard
Creating a Database Session
Opening a Database Session
Viewing your Tables
Viewing your Data
Making a Schema
Editing a Schema
Creating a Desktop Form using a wizard
Editing a Desktop Form
Adding some code
Testing a Desktop Form
Inserting some data
Creating a Web Form from scratch
Adding Fields to a Web Form
Adding Code and Further Fields to a Form
Adding a Picture and a Button to a Form
Adjusting the form for a Mobile Device
Testing your Web Form
Inserting some data
Test HTML page
Viewing a different layout
Viewing your form on a mobile device
Changing the form theme
Summary
Chapter 2—JavaScript Remote Forms
Creating JavaScript Remote Forms
Creating a Remote Form using a Wizard
Creating a Blank Remote Form
Remote Form Name
JavaScript Client
Client Browser Support
JavaScript Components
Remote Form Design
Remote Tasks
Creating Remote Task Classes using Wizards
Plain Remote Task Wizard
Monitor Remote Task Wizard
Remote Task Instances
Construct Row Variable
Sending Data to the Form construct
Class Cache Logging
Changing Forms
Multiple Forms
Client Access Properties
Managing Timeouts in Remote Tasks
Secure Sockets
Remote Task Events
Push Connections
Remote Objects
Creating Remote Objects
Omnis Language
Creating Instances
Code Generation
Running remote object code on the server
Remote Form Properties
Responsive Forms
Remote Form Migration
Screen Type Layout (kLayoutTypeScreen)
Component Transitions
Initial Field and Tabbing Order
Responding to OK and Cancel Keys
Form and Component Transparency
Gradients
Remote Form Instances and Methods
Remote Form Instance Properties
Remote Form Methods
Adding Objects to JavaScript Forms
Remote Form Instance Group
Remote Form Events
Event Parameters
Enabling Form Events
Form Orientation
Event Methods
Testing JavaScript Remote forms
HTTP Server
Default Web Browser
Test Web Page
Template HTML File
Debugging Remote Forms
Client Caching
Testing your Remote Form on a Mobile Device
Client Script Version Reporting
Troubleshooting Remote Forms and Tasks
Client Methods
Enabling Client methods
Auto Client Executed
$init method
Event Specific Client Methods
Debugging Client methods
Calling Custom Methods
Data Types for Client methods
Variable References in Client Methods
Execution and Method Calls
Return Methods
Object and Library names
Client Methods Example
Client Objects and Inheritance
New Page Browser Prompt
Client Commands
Message Dialogs
JavaScript Message Boxes
Using a Promise
Playing Sounds
Date Format
Client Preferences
Locking the User Interface
Custom Loading Indicator
Subform Sets
Subform Palettes
PDF Printing
Push Connections
Dragging and Dropping files
Push Notifications
Toast Messages
Locale Commands
Theme Command
Remote Menus
Creating Remote Menu Classes
Menu Line Icons
Icon Colors
Text Alignment
Context Menus
Context Menu Events
Control Menus
Subform Sets
Stacking Order List
Creating Dynamic Subforms
Subform Client Commands
Subform Dialogs
Using the Stacking Order Variable (ordervar)
Load Finished Method
Trapping the Close event
Scroll Position
Subform Styles
Subform Titles
Subform References
Subform Panels
Subform Set Example
Using Subform Palettes
Showing a Subform Palette
Closing a Subform Palette
Running JavaScript in the Client
Styled Text
Animations
Time Zones and Dates
Time Zone Functions
Local Time
Date and Time Conversion in SQLite
PDF Printing
Supporting Files
PDF Print Destination
PDF Folder
Printing PDF Using Code
PDF Device Functions
Icons and Vertical Text
PDF Printing in the JavaScript Client
PDF Path Names
PDF Version and Encryption
PDF/A support
Linking to PDFs
Setting PDF Folders
Print PDF Example
Toast Messages
Chapter 3—JavaScript Components
Example Apps and Code
JavaScript Components
Favorites
Creating JavaScript Components
Layout breakpoints
Adding a new JavaScript component
Remote Form Object Limit
Copying Components
Component Properties
Dataname for JavaScript Controls
Naming JavaScript Controls
Using $edgefloat and Component Resizing
Date and Time Formatting
Number Formatting
Autoscrolling
Component Borders
Control Classnames
Custom CSS Styles
Component Transparency
Form Errors
Field List
Component Events
Enabling Events
Editing Event Methods
Standard Field Events
Buttons and Lists
evAfter event queue
Drag Border Event
Component Icons
Selecting an icon
Icon sets
Icon Search Order
SVG Icons
Material SVG icon set
Using SVG Icons
Creating SVG Icons
SVG icon file names
Multi-state SVG Icons
Fixed and Custom Icon Sizes
Icons for Lists
Icon Caching
Assigning a URL for images
Image handling for tree lists
Exporting Icons from an Icon Datafile
Icons Folder Name
PNG Icons
Icon Badges
Component Fonts
Drag and Drop Data
Example Library
Dragging Data
Dropping Data
Events
Drag Values
Dragging and Dropping Files
Drag and Drop for Thick Client
Copying data
Side Panels
Tab Order
Remove from Tab Order
Design tab order
Next Tab Object
Accessibility
ARIA Properties
Image Based Controls
Page Panes and Landmarks
Label controls
Control text
Content tips
Keyboard Accessibility
Accessibility and tabbing order
JS Themes
Selecting Colors
Theme Editor
Creating a new theme
Themed Icons
HTML Template & Client theme setting
The current theme: $construct
Changing the Theme
Active and Enabled Properties
Default Inactive Appearance
Default Disabled Appearance
Context Menus
Creating Customized JavaScript Components
Opening the Component Library
Adding your own form and components
JavaScript Component Templates
Position Assistance
Position and Size coordinates
Positioning & Aligning Objects
Distribution
Alignment
Positioning for Paged Panes (Container fields)
Position for dropping objects
Group Selection & Object Properties
Design Guides
Activity Control
Custom Link
Background Shape
Background Images
Animations and Changing Attributes
Bar Chart Control
List data structure
Main and Axis Titles
Bar & Segment Color
Events
Button Control
Text Position
Flat Button Style
Disabled Appearance
HTML Button Text
Events
Example
Camera Control
Camera Actions
Camera UI
Camera Permission and Testing
Image Aspect Ratio
Capture Size
Image Type & Quality
Events
Chart Control
Chart Data
Properties
Events
Mixing Chart Types
Check Box Control
Example
Color Picker
Properties
Events
Predefined Color Swatches
Combo Box Control
Content Tips
Auto correction and capitalization
Example
Complex Grid
Dataname for Grid Controls
Events
List Pager
Tabbing inside a grid
Scrolling
Scrollable footer
Row divider line style and Field Styles
Extra space
Dropping data onto a grid
Exceptions
Complex Grid Restrictions
Example
Data Grid Control
Setting up a Data Grid
Events
Sorting Grid Columns
Enter Key Behavior
Column Width
Footer row
Cell Formatting
Data Grid Filter
Row Formatting
Header Formatting
List Pager
Pick List
Row Styles
Horizontal Padding
Grid Line Visibility
Formatting cells
Column Data Type Formatting
Highlighting Cells
Grid Scrolling
Tabbing through cells
Auto Correction and Capitalization
Validating data
Initial Row Values
Inserting Dates as null values
Using the Date Picker
Entering Dates Manually
Fixed Columns
Column Header Justification
Color Picker
Number Columns
Hiding a column
Data Grid Example
Date Picker Control
Date Picker Style
Mode & Popup Style
Calendar Style Picker
Start and End dates
Week Number
Disabling Dates
Custom Date Style
Selecting a Date Range
Events
Example
Date Picker Localization
Device Control
Running the Device Control and Compatibility
Testing Hardware Features
Properties
Device Action Properties
Events
Beep Device Action
Get Barcode Device Action
Vibrate Device Action
Get GPS Device Action
Take Photo / Get Image Device Action
Get Contacts Device Action
Make a Call Device Action
Send an SMS or Email Device Action
Getting the Unique ID Action
Running Device Actions in the Browser
Droplist Control
Droplist Style
Horizontal Padding & Extra space
Selected Line
Events
Example
Entry Field
Dataname: $dataname
Single or Multi-line Fields
Text Properties and Field Styles
Dynamic Labels
Content Tips
Password Fields
Borders
Horizontal and Vertical Padding
Events
Soft Keypad Input Type
Input Masks
Date Picker
Custom Date Formats
Numeric Data Entry Validation
Negative Numbers and Uppercase
Zero Values
Multiline Edit Scrolling
Shortcut Keys
Auto Correction, Capitalization, Completion
Content Selection
Dictation Text Entry
Tooltips and Carriage Return
File Control
Mobile limitations or issues
Uploading Files
Dropping Files
Downloading Files
evDownloadSent Event
Example
Floating Action Button
Defining the FAB data list
Properties
Events
Gauge Control
Properties
Events
Customizing the Scale and Range
Html Link
External Links
Internal Links
Link Colors
Events
Html Object
HTML Preview
Custom JavaScript Controls (Deprecated)
HTML Examples
Building an HTML block
Events
Style and Attribute Placeholders
HTML object in Paged Panes and Subforms
Hyperlink Control
Example
Label Object
List Control
List data variable
Selected Line Color
List Events
Lists and Client Methods
List Scrolling
Changing Current Line from the Keyboard
Linked Lists
List Pager
Map Control
Activation and API Key
Map Location and Zoom Level
Map Type and Controls
Map Markers
Polygon Objects
Events
Markdown Object
Markdown Syntax Support
Building the Markdown Block
Properties
Events
Native List
About the Native Controls
Creating a Native List
Defining the data for a Native list
Custom Accessories
Menu Accessory
Creating a Grouped list
Vertical Scrolling
Row Display Style
Date and Number Formatting
Reordering Rows
Advanced Customization
Native Slider
Native Switch
Navigation Bar Control
Navigation Stack
Events
Example
Navigation Menu Object
Menu List Content
Menu Types
Menu Properties
Menu Events
Scrolling
Navigation Menu Example
Page Selector
Paged Pane
Events
Rounded Corners
Using $dataname
Page Panes in Complex grids
Group Boxes
Animated Transitions
Page Styling
Picture Control
Image Alignment and Scaling
Example
Pie Chart Control
Main and Legend Titles
Popup Menu Control
Menu Line Height
Progress Bar Control
System Appearance
Example
Radio Button Group
Events
Example
Rich Text Editor
Dynamically Loaded Resources
Properties
Setting Text Properties
Data Format
Inserting Data
Getting Html
Code Blocks
Drag and Drop
Localizing the Rich Text Editor
Printing the Text Contents
Scroll Box
Subform Sets
Group Box
Segmented Bar
Properties
Events
Slider Control
Properties
Events
Split Button
Properties
Events
Example
Subform Control
$construct and Subforms
$init and Subforms
Multiple Subforms and Caching
Referencing Subform Instances
Subform Promise
Events
Example
Subformset Panel
Creating a Subformset Panel
General Properties
Panel Properties
Colors and Icons
Passing Parameters
Events
Methods
Switch Control
Example
Tab Bar Control
Tab Icons
Reordering Tabs
Tab Pane
Linking Tabs to Panes
Tab Menus
Events
Example
Tile Grid
Properties
Configuring the grid layout
Setting the tile width
Defining the data list
Events
Timer Control
Example
Timer Worker Object
Toolbar Control
Example
Properties
Disabling Items
Defining the Side Menu list
Events
Trans Button Control
Hover Action
Icons
HTML Button Text
Tree List Control
Properties
Tree List Format
Tree Events
Scrolling in long lists
Dynamic Tree Lists
Video Player
YouTube
HTML5
Events
External Components
iCalendar
Chapter 4—JSON Components
JSON Control Editor
JSON Control Definition
JSON Control Object
name
flags
standardproperties
properties
multivalueproperties
constants
events
methods
html
customtabname
JavaScript
Chapter 5—Ultra-thin Omnis
HTML Forms and Remote Tasks
Secure Sockets
Using Task Methods to Process Requests
Returning Content to the Client
Quit method <url>
Quit method <data>
Quit method <error>
Turning off the pragma:nocache header
Cookie and Referer Headers
Persistent Remote Tasks
evPost events
Multipart Form Data
Direct Client Connections
Chapter 6—Localization
Localization for the JavaScript Client
String Table Format
Localizing Remote Forms
Localizing Built-in Strings
Chapter 7—Deploying your Web & Mobile Apps
Server Installation and Licensing
Licensing Mechanism
Omnis Web Architecture
Editing Your HTML Pages
The JavaScript Client Object
CSS styles and JavaScript folders
Icon Sets
Fav icon
Customizing the JavaScript Working Message
Setting up the Omnis App Server
Server Configuration
Server Logging
Setting the Omnis App Server Port Number
Server Multi-threading
Using the Multi-threaded Server
Database Access
Omnis App Server Commands
SQL Session Pools
Server Load Sharing
Socket Binding
Managing Server Timeouts
Setting Up Your Web Server
Installing the Web Server Plug-in
ISP Web Hosting
Secure Sockets (SSL)
Web Server Plug-in Custom Configuration
Creating Standalone Mobile Apps
Wrapper Application Source Files
Configuring the Wrapper Application
Access Permission Requests
Testing Remote Forms in a Wrapper App
Serverless Client
How does it work?
Serverless Client Methods
Serverless Client Application File (SCAF)
Database Support
JavaScript Client Wrapper Application
Push Notifications
Setting up Push Notifications
Omnis App Manager
Creating an App Configuration
Headless Omnis Server
Console Commands
Functions
Java
Class Notation
Restrictions
Printing JPGs
Logging External Errors
Installing the Headless Server (Linux)
Headless Server Admin Tool
MultiProcess Server
Configuration
Libraries
Classes
Commands
sys() functions
Process init method ($processinit)
Database Connections
Remote Task Methods
Omnis Data Files
Execution
Licensing
Load Sharing
Remote Debugging
Using the Same Child Process
Logging
Command Line
External Components
Omnis Programming
Omnis Programming
Omnis Software Ltd
About This Manual
If you are new to Omnis
Copyright info
Chapter 1—The Omnis Environment
Studio Browser
Search Filter
Developer Hub
Project Libraries in the Studio Browser
Library Conversion
Recent Libraries or Classes
Library Folders
Hiding and Showing Classes
Diacritical Character input in the IDE
Using Multiple Screens on macOS
Color Themes and Appearance
Exporting & Importing Custom Themes
Window Frame Themes
Appearance Property
Appearance and Theme Files
Changing Appearance at Runtime
Appearance File Contents & Help
Dark Mode
User Defined Colors
IDE Window Colors (Windows only)
Platform Specific Notes
Window Frame Appearance on Windows
Omnis Preferences
Preferences in config.json
Environment Font Size
Single Instance preference
Omnis Configuration
Configuration File Editor
User Configuration File
Configuration Editor Visibility
Windows Configuration
IDE Animation
Configuration File Methods
Dock Key Events (macOS)
Keystroke Receiving Prompt (macOS)
Studio Toolbars and Menus
Windows OS
macOS
Standard toolbar
View toolbar
Tools toolbar
Desktop toolbar
Omnis Menu Bar
Multi- Undo and Redo
Tools menu
Context Menus
Save Window Setup
Class Context Menu
Variable Context menus
Find and Replace
Classes tab
Settings tab
Match Case and Whole Words
Regular Expressions
Selected Log lines and Errors
Searching Selected Methods
Checked Out Classes
Code Syntax Colors in Find Log
Find Log sorting & searching
Find and Replace Method
Renaming Objects
Spell Checking
Configuration
Window Class Controls
Code Editor
Remote Debugger
Component Store
Searching for a component
Adding a Component to a form
Changing the Appearance
Two Column mode
Favorites
Further Options
Configuration
Editing the Component Store Library
Property Manager
Advanced Property Option
Searching the Property Manager
Save Window Setup
Property and Method Descriptions
Copying Properties and Values
Show Property Context Menu
Dragging methods from the Property Manager
Setting Location and Size Properties
Selecting Integer Values
Changing Boolean Properties
Tab and Focus Selection
Method Editor
Interface Manager
Dragging methods from the Interface Manager
Searching the Interface Manager
Notation Inspector
Using the Notation Inspector
Dragging notation from the Notation Inspector
Finding the notation for an object
Catalog
Searching the Catalog
Catalog Context Menu
Variable Context Menu
Dragging items from the Catalog
SQL Browser
Creating and Editing a Session
Opening a session and accessing your data
Importing Data into a Session
SQL Browser Options
SQL Query Builder
SQL Query Builder window
Creating a Query
Running a Query
Saving a Query
Deleting a Query
Query Reports
Query Info
Query Builder Manager
Options
Creating a Query Class
Creating a Table class
Creating a DB View
Exporting Data
Creating a Statement Block
SQL Query Builder App
Version Control System
Auto Updates
Update Feedback
Example
External Class Editor
Omnis Help
Custom URL Schemes
Creating a custom URL
Opening a custom link
System Notifications
Notification Object
Notification Functions
Specifying Images
Specifying Actions
Handling Notification Clicks
Removing Notifications
Badges
Enabling Notifications
Power Management Notifications
Power Management Methods
Disabling idle sleep
Chapter 2—Libraries and Classes
Omnis Libraries
Creating a New Library
Library Name
Opening a Library
Closing a Library
Closing All Libraries
Deleting a Library
Restoring Open Libraries & Classes
Library Properties
Library Preferences
Library Default name
Multi-library Projects
Library APIs
Omnis VCS
Comparing Classes
Shared Access to Libraries on macOS
Starting Omnis with a file
Opening Initial File As Library error
Library Conversion
Default Classes
Startup Task
Remote Tasks
System Classes
Overriding System Class Tables
Class Types
Creating New Classes
Class Names
Class Wizards
Data Classes and Wizards
Accessing SQL databases
Data type mapping
Omnis Datafiles
Omnis Data Types
Character
National
Number
Boolean
Date time
Sequence
Picture
List
Row
Object
Object reference
Binary
Item Reference
Field reference
Nulls and empty values
Formatting strings and input masks
Current Record Buffer
Schema Classes
Creating a schema class automatically
Query Classes
Table Classes
Exporting Libraries to JSON
Exporting Libraries
Importing Libraries
Directory and JSON File Structure
Library Dependencies
External File classes & Tokenization
Export & Import JSON Notation
Export & Import JSON Preferences
Error Messages
Chapter 3—Omnis Programming
Variables
Declaration and Scope
Parameter Variables
Local Variables
Instance Variables
Class Variables
Task Variables
Hash Variables
Adding a Variable
Adding Local and Parameter Variables
Item Reference Classes
Creating Unrecognized Variables
Deleting Unused Variables
Adding Task Variables
Variable Initial Values
Variable Context Menu
Variable Tooltips
Variable panel
Viewing Variables in the Catalog
Auto Fill Variable Option
Custom Variable Types
Comparing Variables
Methods
Notation
Item References
Current Objects
The Flag (#F)
Functions
Commands
Custom Methods and Properties
Do Command and Executing Methods
NULL values in Calculations
Calculate Command and Evaluating Expressions
Calling Methods
Quitting Methods
Flow Control Commands
Reversible Blocks
Error Handling
Redrawing Objects
Message Boxes
Events
Event Handling Methods
Mouse Events
Discarding Events
Window Events
Key events
Control Methods and Passing Events
Container Fields and Events
Queuing Events
User Constants
Creating User Constants
Method Editor and Code Assistant
Notation
Using Tasks
Default and Startup Tasks
Handling Application Focus Events
Main Window Resize Message (Windows only)
Creating Task Classes
Opening Tasks
Current and Active Tasks
Closing Tasks
Task Variables
Private Instances
Private Libraries
Multiple Tasks
Preferences on macOS
External Component Notation
Chapter 4—Debugging Methods
Method Editor
Opening the Method Editor
Inserting and Editing Methods
Inserting a Method
Maximum Number of Methods
Line Numbers
Showing Inherited Methods First
Showing Built-in Methods
Find Possible Calls
Method Search
Adding Blank Method Lines
Adding Method Lines
Method Notes
Code Editor
Tokenization
Fonts
Ctrl-space
Multi Undo and Redo
Read-only Mode
Copying Methods or Code Lines
Printing Methods
Entering Commands
Code Folding
Word Wrapping
Setting Breakpoints
Menus and Keyboard Shortcuts
Keyboard Shortcuts
Word Selection
Commenting / Uncommenting Lines
Language Syntax
Library Conversion
Method Editor Coloring
Syntax Coloring
JavaScript: Editor
Trace Log
Error Processing
Dynamic Methods & Objects
Code Assistant
Shortcut Keys and Help
Code Assistant Configuration
What Help does the Code Assistant Provide?
Omnis Help
Debugging Methods
The Go Point
Execution Errors
Stepping through a Method
Tracing a Method
Private Methods
Method History
Inspecting Variable Values
Variable Menu
Variable and Event Tips
Variable Panel
The Values List
Displaying Control Characters
Watching Variable Values
Breakpoints
Breaking on Variable Change
Breaking on Calculation
The Method Stack
Method stack list
Method stack limit
Debugger Options
Debugger Commands
Using the Trace Log
Debugging Variables
Checking Methods
Interpreting Errors and Warnings
Method Performance
Collecting Performance Data
Sequence Logging
Remote Debugger
Connectivity
Preparing Code For Remote Debugging
Opening a Session
Browsing Libraries
The Remote Debug Window
Remote Debugger Toolbar
Variable panel
Keeping the Client in Step with the Server
Execution
Chapter 5—Object Oriented Programming
Inheritance
Why should I use inheritance?
Making a Subclass
Overloading Properties, Methods, and Variables
Inheritance Tree
Showing Superclasses in the Studio Browser
Inheritance Notation
Object Classes
Using Object Classes
Libraryname prefix for object variables
Dynamic Object Instances
Self-contained Object Instances
Object References
Constructing new objects
Listing instances created using an Object reference
Destructing objects
Testing an object reference for validity
Copying an object reference
External Objects
Using External Objects
External Object Events
External Object Notation
Chapter 6—List Programming
Declaring List or Row Variables
Lists in the JavaScript Client
Defining List or Row Variables
Defining Lists from Variables
Defining Lists and Rows from SQL Classes
Defining Lists using SQL Workers
Defining Lists from File classes
List/Row subtypes
Adding columns
Legacy List Commands
Building List Variables
Building a List from SQL Data
Viewing the contents of a list variable
List Variable Values
List and Row functions
The
list()
Function
The
row()
Function
Accessing List Columns and Rows
List Column Calculations
List line commands
List Variable Notation
List Properties and Methods
Properties and Methods of a List Column
Properties and Methods of a List Row
Properties of a List Cell
Manipulating Lists
Dynamic List Redefinition
Clearing List Data
Searching Lists
Selecting List Lines
Merging Lists
Sorting Lists
Removing Duplicate Values
Smart Lists
Smart Lists and the JavaScript Client
Enabling Smart List Behavior
The History List
Properties of the History List
Properties of Rows in the History List
Tracking the Changes
Change Tracking Methods
Filtering
Sorting smart lists
Committing Changes to the Server
List Commands and Smart Lists
Chapter 7—SQL Programming
Overview
Setting up a Database Connection
Clientware
64-bit DAMs
INI files under macOS
Connecting to your Database
Creating a Session Object
Logging on to a Session Object
Logging Off from a Session Object
Interacting with your Server
Creating a Statement Object
Mapping the Data
Sending SQL to the Server
Fetching Results
Describing Results
Substituting Variables into SQL Commands
Bind Variables
Constructing SQL Queries from Row Variables
Table and Column names
SQL Errors
Data Type Mapping
Clearing Statements and Sessions
Listing Database Objects
Listing Tables and Views
Listing Columns
Listing Indexes
Building Schema Classes
Defining Lists from Server Tables
Remote Procedures
Listing Remote Procedures
Listing Remote Procedure Parameters
Calling a Remote Procedure
Transactions
Transaction Modes
Cursor Results Sets
Non-Unicode Compatibility
Switching to 8-bit compatibility mode
Handling Extended Characters
Interpreting 8-bit Data
Server Specific Programming
Stripping Spaces
Treatment of Date Values
Large Objects
Blob Size
Chunking Large Objects
Session Pools
Creating a Session Pool
Obtaining a Session Instance From a Pool
Session Pool Notation
Destroying a Session Pool
Diagnosing Problems
Session and Statement Properties and Methods
SQL Multi-tasking and SQL Workers
Overview
SQL Worker Object Methods
SQL Worker Object Properties
Creating SQL Worker Objects
How SQL Worker Objects work
Additional Notifications
SQL Worker Lists
Using a Worker in a SQL List or Row
Selecting & Fetching Data
Inserts, Updates and Deletes
Smart List Methods
Completion Row
Chapter 8—SQL Classes and Notation
Schema Classes
Schema Class Notation
List/Row Subtypes
Making a Schema from a Server Table
Query Classes
Calculated Columns
Query Class Notation
Table Classes
Table Class Notation
Table Instances
Passing Parameters to a Table instance
Adding Columns to a SQL List
Table Instance Notation
Table Instance Methods
SQL Classes and Sessions
Table Class Methods and Sessions
Chapter 9—Server-Specific Programming
Server and Clientware Compatibility
64-bit DAMs
PostgreSQL
PostgreSQL Client Libraries
Properties and Methods
Logging on to PostgreSQL
Metadata Functions
Transactions
Remote Procedure Calls
Notification Channels
Handling Dates
UUID, ENUM and XML Column Types
Large Object Support
JSON Column Types
PostgreSQL Data Type Mapping
PostgreSQL Troubleshooting
SQLite
Server-specific Programming
SQLite Encryption
Session Properties
Session Methods
Data Type Mapping
Troubleshooting
Oracle
Properties and Methods
Connecting to your Database
Mixing Unicode and Non-Unicode Data Types
Insertion/Update of CHAR and VARCHAR2 data
Insertion/Update of CLOB data
Fetching Very Large Objects
Insertion/Update of LONG data
PL/SQL
$rpc() Support
Positioned Updates and Deletes
Oracle 8 Data types
Oracle 9i Data types
Retrieving XML and URI data
Inserting XML and URI data
Updating XML and URI data
Oracle Data Type Mapping
Oracle Troubleshooting
Sybase
Properties and Methods
Connecting to your Database
Multiple Select Tables
Program Name
Error Handling
Large Objects (LOBs)
Remote Procedure Calls
Multiple Cursors
Meta-Data Queries
Logon Problems using the SYBASEDAM
Sybase Troubleshooting
Sybase Data Type Mapping
DB2
Properties and Methods
Connecting to your Database
Transactions
Dates
Boolean Type
BLOB Type
Meta-Data Queries
DB2 Troubleshooting
DB2 Data Type Mapping
MySQL
Properties and Methods
Logging on to MySQL
Transactions
Using LOAD DATA
MySQL Data Type Mapping
MySQL Troubleshooting
ODBC
Properties and Methods
Connecting to your Database
Transactions
Dates
Multiple cursors
SQL Server 2000 Data Types
ODBC Administration
ODBC Troubleshooting
ODBC Data Type Mapping
MongoDB
Constants
Session Properties
Session Methods
Cursor Properties
Cursor Methods
Command Options
Find and Modify Options
Client Session Options
Read Concern
Write Concern
Read Preferences
Listing Objects
Indexes
Database Admin
Collections
Session Commands
Session Transactions
Generating Results
Cursor Commands
Bulk Operations
Table Instances and Smart Lists
Application Performance Monitoring
Amazon SimpleDB
Dependencies
Logging on to SimpleDB
Meta Data
SimpleDB Attributes and Multi-Values
Creating a Domain
Inserting Data
Deleting Data
Replacing Data
Fetching Data
Machine Utilization
Read Consistency
Conditional Puts and Deletes
Session Properties
Session Methods
Statement Properties
Statement Methods
Implementation Notes
OmnisSQL DAM
Server-specific Programming
Omnis SQL Language Definition
JDBC
Minimum Requirements
Properties and Methods
Connecting to your Database
Transactions
Dates
Multiple cursors
JDBC Data Type Mapping
Chapter 10—Report Programming
Report Fields and Sections
Report Object Limit
Report Field Types
Report Entry Fields
Wrapping Lists and Data Grids
HTML Link Objects
JPEG Report Control
Picture Report Control
Rtf Viewer Control
Report Labels
Report Shapes
Report Wizard
Report Tools
Zoom In/Out
Report Sections
Page Headers and Footers
Printing Sections as Record Sections
Borders and shading
Watermarks
Section Positioning
Page Mode
Start Mode
Record Spacing
Position Sections
Section Print Height
Section Calculations
Custom Sections
Hiding Sections in design mode
Sorting and Subtotaling
Subtotal Sections
Numeric Hash Variables in Subtotals
Calculated Fields
PDF Accessibility
PDF/UA Support
Object Reading Order
Previewing Object Order
Printing Reports
Report Destination Dialog
Page Preview Destination
Printer Report Destination
Disk Report Destination
Clipboard Report Destination
Port Destination
File Report Destination
RTF Report Destination
HTML Report Destination
PDF Report Destination
Memory Report Device
DDE/Publisher Device (Obsolete)
Screen Report Destination (Obsolete)
Printing Errors
Tabs in Reports
Using style() in Reports
Report and Field Methods
Report Data Grid Column Parameters
Print Devices and the Current Device
Print Devices
Global Printing Preferences
Report Instances
Page Setup Report instance properties
Printing a report from a list
Screen Report Fields
Report Field and Section Methods
Report Object Positioning
Page layout
Inheriting Sections
Report Fonts
Windows Fonts
Monaco font (macOS)
Unknown macOS Fonts
Port Profiles
Port Profile Management
Port Profiles at Runtime
Printer Escapes
Labels
HTML Report Device
Setting the HTML Device Parameters
Sending Text or Data
HTML Report Objects
Chapter 11—Window Components
Example Apps and Code
Window Class Components
Loading External Components
Window Class Object Limit
Object Properties
Object Names
Object datanames
Component Icons
Themed SVG Icons
Vertically Centered Text
Font Scaling for Fields
Event & Control Methods
$sendevent method
Alpha Colors & Transparency
Container Fields
$container
$objlink
Object Animation
Moving Objects
Rounded Borders
Object Transparency
Tooltips
HTML Components for Desktop Applications
Using HTTP for controls
Third-party HTML controls
JavaScript Client Bridge
Creating Omnis HTML Controls
Adding HTML controls to your window
Markdown Object
Ports
Events
Menu Classes
Menu wizards
Menu lines and methods
Menu Icons
Menu Shortcut Keys
Menu Shortcuts (macOS)
Hierarchical menus
Window menus
Popup menus
Context menus
Security and menu access
Status bar help for menus
Toolbar Classes
Toolbar Wizards
Toolbar Controls
Radio Button Groups
Toolbar Separators
Toolbar Icons
Tooltips
Toolbar Methods
Installing Toolbars
Docking Areas
Toolbar Docking Area Height
Window Toolbars
Accordion Control
Populating the Accordion
Expand mode and Animation
Accordion Events
Breadcrumb Control
Properties
Events
Example
Button Area
Calendar Control
Modern UI Style
Calendar Events
Calendar Example
Check Box
Horizontal Mode
Round Check Boxes
Check List
Clock Control
Color Palette
Combo Box
Disabling the Automatic Search
Setting the focus
Background theme on macOS
Complex Grid
Grid row focus alpha
Objects in a Complex Grid
Resizing Rows
Events for Complex Grids
Grid Field Exceptions
Sliding Columns
Data Grid
Droplist
Background Theme
FishEye Control
Populating the FishEye
Position and Expand direction
Magnification and Stepping
Text Labels
FishEye Events
Graph2 Control
Group Box and Scroll box
Headed List Box
Entering the Calculation
Setting Column Widths
Text Alignment
Progress Bar
Displaying Ellipses
Tooltips
Headed List events
Mouse Events
Editable text
Dynamic Column Headers
Footer Row
HelpMethods
Hyperlink Control
Separator Line
Icon Array
Programming Icon Arrays
JPEG Control
Methods
Example
Labeled Fields
List Box
Queue Click
Searching Lists
List Line Colors
Selected List Line Colors
Line Background Colors
Background theme on macOS
List Row Buttons
Markdown Object
Marquee Control
Masked Entry Field
Modify Report Field
Multibutton Control
Specifying Icons
Multi Line Entry Field
Limiting Line count
Navigation Menu
OBrowser
Setting web pages
Methods
Events
Drag and Drop in oBrowser
OBrowser Configuration
CEF Switches
Debugging code in OBrowser
Chromium Safe Storage Prompt (macOS only)
Setting Locale
Certificate Errors
Browser Console Errors
$disablepluginsmacos property (macOS)
localStorage on macOS
Cookies
Video in OBrowser
HTTP headers
OmnisIcn Control
Paged Pane
Paged Pane Buttons
Listing the objects on panes
Page names
Side Panels
Picture Control
Events
Icon ID and Color
Image Interpolation
Popup List
Popup Menu
Progress Bar
Pushbuttons and Button Areas
Styled Text
Button Mode
Button Style
Button Timer
Click behavior on macOS
Radio Groups and Buttons
Round Button
Screen Report Field
Printing the report to PDF
Scroll Box
Shape Field
Sidebar Control
Single Line Entry Field
Entry Field Properties
$dataname for Windows Controls
Password Entry Fields
Local Fields
Entry and Display Field Calculations
Display and Inactive Fields
Disabled Field Appearance
Floating Edges and Positioning
Copying Text from Disabled Fields
Control Characters
Strip Spaces
Strip Thousand Separators
Content Tips
Content Padding
Show Ellipsis
Field Border Icons
Emoji and Symbols in Edit Fields (macOS)
Dictation for Edit Fields (macOS)
Diacritical Characters
Slider Control
Split Button
String and Data Grids
String Grids
Data Grids
Programming Data and String Grids
Subwindows
Floating Fields
Subwindow Events
Drag and drop
Nesting Subwindows
Subwindow instance notation
Changing the class for a subwindow
Subwindow Examples
Switch Control
Tab Pane
Styled Text
Listing the objects on panes
Getting and Setting the Tab labels
Tab style on macOS
Tab Strip
Events
Tab Animation
Close Boxes on Tabs
Animated Line and Dot Modes
Adding Tabs
Tab Strip Groups
Token Entry Field
Using a Token Entry Field
Properties
Events
Methods
Trans Button Control
Transform Control
How does it work?
Adding a Transform Object
Creating Transform States
Wait Statements
Invoking Transformation
Transform Object Methods
Transform Object Properties
Tree List
Tree List Node Icons
Tree List Hot Tracking
Populating a Tree List
Tree Node Properties
Tree List Animation
Tree List Methods
Node Methods
Tree List Events
Formatting Text in Tree Lists
Video Player
WAV Player
Background Objects
Background Images
Background Object Names
Using Non-TrueType fonts
Corner Radius
Label and Text Objects
Aligning Text
String Labels
Deprecated Components
Color DropList Control
Fade Picture Control
File DropList and File List Controls
Filter List Control
Formroll Control
Hot Picture Control
Html Object
Icon DropList Control
Line DropList Control
Pattern DropList Control
Picture List Control
Rtf Viewer
Tab Bar Control
Timer Control
Tray Icon
Zoom Control
Chapter 12—Window Programming
Window Design Task
Window Methods
Window Animations
Field Styles
Field Style Properties
Creating Field Styles
Printing styles
Defining Field Styles
Custom Styles
Applying a Style to an object
Field Styles Notation
Using the style() function
Format Strings and Input Masks
Character Format Strings
Number Format Strings
Date Format Strings
Boolean Format Strings
Input Masks
Format String Notation
Remote masked entry fields
Drag and Drop
Drag and Drop Events
Using Drag and Drop
Operating System Files
Toast Messages
Toast Properties and UI
Showing Toast Messages
Notification Clicks
Toast Message Colors
Example
Window Messages
HWND Notation
Screen Size
Using HWND
Enter Data Mode
Floating Edges for Windows and Fields
Window Minimum Size
Creating a right floating window
Window Fonts
Window and Font Scaling
Menu and Toolbar Fonts (Windows)
Background Themes
Theme Fonts
Window Style
Window Title Colors (macOS)
Drawer Windows (macOS)
Sheet Windows (macOS)
Simple Style Windows
Palette Windows
Window Transparency
Disabling the Focus on Fields
Lookup Windows
Timer Methods and Splash Screens
Pictures
Window Status Bars
Progress Bars
True Color Shared Pictures
Chapter 13—Unicode
What is Unicode?
DAMs
Switching to 8-bit compatibility mode
Character Mapping
Interpreting 8-bit Data
Fetching Data to a File
Server Specific Programming
Character Normalization
Comparing Text
Drawing Text
Entering Text
Character Translation
Unicode Clients
Locale Identifier
Unicode Data Handling
Formfile
Fileops
Mixing Char & Binary data
Import/Export and Report File Encoding
Omnis Data File Conversion
Testing Data File Conversion
Data File Commands
Chapter 14—Localization
Right to Left Data Entry
Localizing Your Libraries
Using String Labels
Editing String Tables
String Table Functions
Programming String Tables
Localizing Remote Forms
Remote Menu Lines
Tooltips
Decimal point character
Localizing Omnis
Localizing Built-in Client Resources
Local Language
Changing the System Menu Options in macOS
Localizing the Omnis Runtime
Storage of Localization Data
The Localization Data
The natcmp() function
User Interface
Setting the Locale
Notation
Chapter 15—Version Control
Converting pre-Studio 10 VCS repositories
Pre-Studio 5 VCS Repositories
Project Branching
Overview
Setting up a Project
Sybase Repositories
Creating a session
Time Settings
Signing in to the VCS for the first time
Adding and Removing Users
Checking in Components
Creating a New Project
Checking in Omnis Libraries and Classes
Checking in non-Omnis Components
Viewing the Contents of a Project
Project Folders
Assigning Component Privileges
Using the VCS
Signing in to the VCS
Checking Out or Copying Out Components
Showing Checked Out Classes in the Studio Browser
Checking in or Unlocking Components
Showing Checked Out Classes
Building Projects
Scheduled Builds
Labels
Server Connections
Finding Classes
Updating local libraries from the VCS
Read-only classes
Managing Components
Granting User Privileges for Components
Sharing Components between Projects
Managing Revisions
Method Inspector
Orphan Components
Component Services
Comparing Classes
VCS Options
Display Options
Check Out Options
Check In Options
Build Options
Method Inspector Options
Branches Options
Reports
VCS API
Tokens
Logon
Logoff
Get Token Info
List Projects
List Classes
List Class Revisions
Class Status
Checked Out Classes
Is Class Current
Check Out
Check In
Label Project
Build Project
Chapter 16—Omnis Data File Migration
Converting Omnis Data Files
SQL Identifiers
Connected Files
Enabling DML Emulation
Step 1 – Set $mapdmltodam
Step 2 – Set $dmlemulation
Emulated Commands
Changes to Library Code
Multiple Users and Concurrency
Semaphores
Using the SQL Browser
Logon Config Files
Logging on to SQLite using a Config File
Logging on to PostgreSQL
Adding Comments
DML Command Logging
Caveats
Single file find
Load from list
Limitations with Search Calculations
Check Data and Repair
New OmnisSQL DAM
Logging on to SQLite
Chapter 17—Deployment
Deployment Tool
Windows
macOS
Code Signing and Notarizing (macOS)
Deployment Tool API
Code Signing Omnis
Firstruninstall and Application Support folders
Updating Components
Deployment
Patching a signed tree
Omnis data folder
Update Manifest Files
Update on macOS
Windows Resource Editor
Setting the application manifest
Setting a resource string
Setting the product version
Setting the Omnis icon
Setting the program version string
Setting the program file version
Extending Omnis
Extending Omnis
Omnis Software Ltd
About This Manual
Copyright info
Chapter 1—Web Services
What is REST?
Example Library
Queueing RESTful requests & Licensing
Creating a Web Services Client
Properties
Methods
Callbacks
CA Certificates
Creating your own Web Services
Omnis RESTful APIs
Web Services in the Omnis IDE
Creating an Omnis RESTful API
URIs
HTTP methods
Simple Types
Method Editor
Server Properties and URLs
ORA Properties and Methods
Swagger Definitions
OpenAPI Definitions
Managing Return Values
Date and Date-time values
Web Services Functions
Cross Origin Resource Sharing
Logging
Authentication
Web Server Configuration for Authentication
Manipulating Resources
Chapter 2—OJSON
Data Structure and Addressing
JSON Arrays
Static Methods
OJSON.$jsontolistorrow()
OJSON.$listorrowtojson()
OJSON.$couldbearray()
OJSON.$couldbeobject()
OJSON.$formatjson()
OJSON.$listtoobjectarray()
OJSON.$objectarraytolist()
OJSON.$listtoarrayarray()
OJSON.$arrayarraytolist()
JSON External Component Object
$getjson([cMember,iEncoding=kUniTypeUTF8])
$setjson(cMember,vData)
$getlasterror([&cErrorText])
$runtimeerrors(bGenerate)
$listmemberids()
$isobject(cMember)
$getobject(cMember)
$setobject(cMember,wRow)
$addmember(cMember,cNewMemberName,vValue)
$removemember(cMember,cMemberName)
$hasmember(cMember,cMemberName)
$listmembers(cMember)
$isarray(cMember)
$getarray(cMember)
$getarraylength(cMember)
$setarray(cMember,vListOrRow)
$push(cMember,vValue)
$pop(cMember)
$isstring(cMember)
$getstring(cMember)
$setstring(cMember,cString)
$isbool(cMember)
$getbool(cMember)
$setbool(cMember,bBool)
$isinteger(cMember)
$getinteger(cMember)
$setinteger(cMember,iInt)
$isfloat(cMember)
$getfloat(cMember)
$setfloat(cMember,nNum)
$isnull(cMember)
$setnull(cMember)
Chapter 3—Java Objects
Setting Up
Software Requirements
Java Example Library
Environment Variables
Memory Allocation
The Java Class Cache
Creating Java Objects
Defining Java Objects
Constructing Java Objects
Subclassing Java Objects
Using Java Objects
Parameter Data Types
Passing Parameters
Passing Simple Parameter Types
Passing Complex Parameter Types
Returning Values From Java Methods
Data type mapping and performance
Getting Values From Java Objects
Adding Java Classes at Runtime
Error Handling
Development Tips
Method Overloading and Pattern Matching
Pattern Matching
Overloaded Data Types
Char and Byte Pattern Matching
Calling Overloaded Methods Directly
Nested Object Arrays
Modifying The System Package List
Adding Extra System Packages
Removing System Packages
Overloaded Types
The Omnis Character Type
The Omnis Binary Type
The Omnis Number Long Integer Type
The Omnis Number Floating dp Type
Frequently Asked Questions
Chapter 4—Omnis .NET Objects
Introduction
Why use .NET
Software Requirements
Omnis Studio
Microsoft .NET Framework
Setting up
Registering the component
Deployment
The .NET Example Library
Creating .NET Objects
Defining .NET Objects
Constructing .NET Objects
Subclassing .NET Objects
Using .NET Objects
Parameter Data Types
Passing Parameters
Passing Simple Parameter Types
Passing Complex Parameter Types
Returning Values From .NET Methods
Obtaining constant (or Enum) values
Adding .NET Classes
Error Handling
.NET Objects example library
The RSS feed component
The RSS feed library
Method Method Overloading and Pattern Matching
Pattern Matching
Overloaded Data Types
Char and Byte Pattern Matching
Calling Overloaded Methods Directly
Nested Object Arrays
Overloaded Types
Omnis Character types
Omnis Binary types
Omnis Number Long Integer types
Omnis Number Floating dp types
Chapter 5—oXML
About oXML
oXML Availability
What is XML?
What are the Benefits of using XML?
Elements
Attributes
Entities
DTDs
Schemas
Using Schema Files for Validation
XML Parser
Displaying XML Documents
What is the DOM?
Documents and Nodes
Creating a Document Object
Creating an Object Variable
Inspecting an Object Variable
Document Objects in oXML
Manipulating XML Documents
Loading an XML Document
Getting the Document Root Element
Getting the Attributes of an Element
Adding Children to a Node
Saving a Document
Using Lists with XML
Using Tree Lists with XML
Document Templates
Character Sets and Unicode
Creating XML documents
Creating an XML Document
Saving the XML File
Chapter 6—oProcess
About oProcess
Properties
Methods
$init()
$run()
$start()
$cancel()
$completed()
$cancelled()
$started()
$isrunning()
$stdout()
$stderr()
$write()
$readlines()
$readtail()
Using oProcess
Chapter 7—OW3 Worker Objects
Example Apps
Using the OW3 Workers
HTTP/2 support
Base Worker Properties
Request Completion
Base Worker Constants
Protocol Logging
Base Worker Methods
Normal methods
Callback methods
OAUTH2 Worker Object
Why use OAUTH2
Obtaining Authorization
OAUTH2 Properties
HTTP and General Properties
OAUTH2 Standard Methods
OAUTH2 Callback Methods
HTTP and General Methods
HTTP Callback Methods
HTTP, IMAP, POP3, and SMTP Workers
OAUTH2 Example
HTTP Worker Object
Properties
Constants
Methods
Normal methods
Callback methods
WebSocket Client Support
Receiving Data
Server close
SMTP Worker Object
Properties
Constants
Methods
Normal methods
Callback methods
FTP Worker Object
Properties
Constants
Methods
Normal methods
Callback methods
Secure FTP (SFTP)
IMAP Worker Object
Properties
Constants
Methods
Normal methods
Callback methods
JavaScript Worker Object
NPM
NPM
Enabling JavaScript Methods
Auto Loading modules
Creating Modules
Creating the worker
Properties
Methods
Called Methods
Callback Methods
Example: Adding ZIP support
POP3 Worker Object
Methods
Properties
CRYPTO Worker Object
Methods
Properties
HASH Worker Object
HMACs
Results
LDAP Worker Object
Properties
Methods
Python Worker Object
Installation
Setting up a Python worker
Calling Python methods
Error handling
Java Worker Object
Installation
Methods
Properties
Main module file structure
User module file structure
Building Java Modules
Web Worker Objects
SMTP Client Workers
External Commands
Multi-threading
MailSplit
Email Headers
SSL Security
SSL Packages
Certificate Authority Certificates
Web Command Error Codes
Chapter 8—Omnis Graphs
About Graph2
Chart Types
XY Charts
Pie Charts
Polar Charts
The Graph2 Example Library
Common Graph Properties
Setting the major and minor type
Common Graph Methods
XY Charts
XY chart properties
XY chart methods
List data structure for XY charts
Data presentation in XY charts
Pie Charts
Pie chart properties
Pie chart methods
List data structure for Pie charts
Polar Charts
Polar chart properties
Polar chart methods
List data structure for Polar charts
Meter Charts
Meter chart properties
Changing the minor type for Meter charts
Meter chart methods
List data structure for Meter charts
Adding Pointers
Adding Rings
Graph Layers and the Prelayout Event
Adding layers to charts
Graph Clicks and Drilldown
Changing the Color of Graph elements
Adding Colored Zones
Parameter Substitution and Formatting
Parameters for Pie charts
Parameters for all XY Chart Layers
Additional Parameters for HLOC and CandleStick Layers
Additional Parameters for Box Whisker Layers
Additional Parameters for Trend Layers
Parameters for Polar Charts
Parameters for Axis
Number Formatting
Date/Time Formatting
Further formatting options
Labels
Adding Text to a Chart
Using Graphs in Reports
Using Graphs in the Web client
Drilldown in Web Client graphs
Chapter 9—Remote Studio Applet
How does it work?
Object Interfaces
Server Object methods & properties
Variable Object methods
Studio Remote Tasks
Remote Studio Examples
Studio server remote task format
Use of the Server applet in Visual Basic
Use of the complex variables and Server applet in Omnis Studio
Use of the Server applet in PHP
Chapter 10—Automation
OLE2 Menu Options
Instantiating an Automation Server
Automation Server Functionality
Built-in Methods
Lifetime of an Automation Server Instance
Terminating Processes
Automation Event Handling
Automation to Omnis Variable Conversion
Automation Errors and Limitations
Automation Examples
XML
DAO
Outlook 2000
Chapter 11—Apple Events
Apple Events Object
Apple Event Methods
Chapter 12—Omnis ODBC Driver
Enable ODBC Access
Select Tables
Select Users
Download and Install the Driver
Configure ODBC DSNs
Testing the DSN
Using Omnis Studio
Using Excel
Other Apps
Using SQL
Chapter 13—Blowfish Encryption
About Blowfish
Padding
Binary Encryption
String Encoding
Omnis Command Reference
Omnis Command Reference
Omnis Software Ltd
About this Manual
Command information
Command Groups
Client Commands
Error Codes
Obsolete Commands
Command Filters
Copyright info
Commands A-Z
# Comment
Accept advise requests
Accept commands
Accept field requests
Accept field values
Add line to list
Advise on find/next/previous
Advise on OK
Advise on redraw
AND selected and saved
Begin critical block
Begin print job
Begin reversible block
Begin statement
Begin text block
Break to end of loop
Break to end of switch
Breakpoint
Bring window instance to front
Build export format list
Build externals list
Build field names list
Build file list
Build indexes
Build installed menu list
Build list columns list
Build list from file
Build menu list
Build open window list
Build report list
Build search list
Build window list
Calculate
Call DLL
Call external routine
Cancel advises
Cancel async method
Cancel prepare for update
Case
CGIDecode
CGIEncode
Change user password
Change working directory
Check data
Check menu line
Clear all files
Clear check data log
Clear class variables
Clear data
Clear DDE channel item names
Clear find table
Clear line in list
Clear list
Clear main & connected
Clear main file
Clear method stack
Clear range of fields
Clear search class
Clear selected files
Clear sort fields
Clear timer method
Clear trace log
Close all designs
Close all windows
Close check data log
Close data file
Close DDE channel
Close design
Close file
Close import file
Close library
Close lookup file
Close other windows
Close port
Close print or export file
Close task instance
Close top window
Close trace log
Close window instance
Close working message
Context help
Copy file
Copy list definition
Copy to clipboard
Create data file
Create directory
Create file
Create library
Cut to clipboard
Default
Define list
Define list from SQL class
Delete
Delete class
Delete data
Delete file
Delete line in list
Delete selected lines
Delete with confirmation
Deselect list line(s)
Disable all menus and toolbars
Disable cancel test at loops
Disable enter & escape keys
Disable fields
Disable menu line
Disable relational finds
Do
Do async method
Do code method
Do default
Do inherited
Do method
Do not flush data
Do not wait for semaphores
Do redirect
Does file exist
Drop indexes
Duplicate class
Else
Else If calculation
Else If flag false
Else If flag true
Enable all menus and toolbars
Enable cancel test at loops
Enable enter & escape keys
Enable fields
Enable menu line
Enable relational finds
Enclose exported text in quotes
End critical block
End export
End For
End If
End import
End print
End print job
End reversible block
End statement
End Switch
End text block
End While
Enter data
Export data
Export fields
FileOps error codes
Find
Find first
Find last
Floating default data file
Flush data
Flush data now
For each line in list
For field value
FTPChmod
FTPConnect
FTPCwd
FTPDelete
FTPDisconnect
FTPGet
FTPGetBinary
FTPGetLastStatus
FTPList
FTPMkdir
FTPPut
FTPPutBinary
FTPPwd
FTPReceiveCommandReplyLine
FTPRename
FTPSendCommand
FTPSetConfig
FTPSite
FTPType
Get file info
Get file name
Get file read-only attribute
Get files
Get folders
Get statement
Get text block
Get working directory
Go to next selected line
Hide docking area
Hide fields
HTTPClose
HTTPGet
HTTPHeader
HTTPMethod
HTTPOpen
HTTPPage
HTTPParse
HTTPPost
HTTPRead
HTTPSend
HTTPServer
HTTPSetAuthentication
HTTPSetProxyServer
HTTPSplitHTML
HTTPSplitURL
If calculation
If canceled
If flag false
If flag true
IMAPCheck
IMAPConnect
IMAPCopyMessage
IMAPCreateMailbox
IMAPDeleteMailbox
IMAPDisconnect
IMAPExpungeMessages
IMAPListMailboxes
IMAPListMessages
IMAPListSubscribedMailboxes
IMAPNoOp
IMAPRecvHeaders
IMAPRecvMessage
IMAPRenameMailbox
IMAPSelectMailbox
IMAPSetMessageFlags
IMAPSubscribeMailbox
IMAPUnsubscribeMailbox
Import data
Import field from file
Import field from port
Import fields
Insert line in list
Install menu
Install toolbar
Invert selection for line(s)
JavaScript:
Jump to start of loop
Launch program
Line:
Load connected records
Load error handler
Load event handler
Load external routine
Load from list
Load page setup
MailSplit
Maximize window instance
Merge list
Message timeout
Minimize window instance
Modify class
Modify methods
Move file
New class
Next
No/Yes message
OK message
On
On default
Open check data log
Open data file
Open DDE channel
Open file
Open library
Open lookup file
Open runtime data file browser
Open task instance
Open trace log
Open window instance
Optimize method
OR selected and saved
Paste from clipboard
POP3Connect
POP3DeleteMessage
POP3Disconnect
POP3ListMessages
POP3MessageCount
POP3Recv
POP3RecvHeaders
POP3RecvMessage
POP3Stat
POP3UndoDeletes
Popup menu
Popup menu from list
Prepare for edit
Prepare for export to file
Prepare for export to port
Prepare for import from client
Prepare for import from file
Prepare for import from port
Prepare for insert
Prepare for insert with current values
Prepare for print
Previous
Print check data log
Print class
Print record
Print report
Print report from disk
Print report from memory
Print top window
Print trace log
Process event and continue
Prompt for data file
Prompt for destination
Prompt for import file
Prompt for input
Prompt for library
Prompt for page setup
Prompt for port name
Prompt for print or export file
Prompted find
Put file name
Queue bring to top
Queue cancel
Queue click
Queue close
Queue double-click
Queue keyboard event
Queue OK
Queue quit
Queue scroll
Queue set current field
Queue tab
Quick check
Quit all if canceled
Quit all methods
Quit event handler
Quit method
Quit Omnis
Read entire file
Read file as binary
Read file as character
ReadBinFile
Redefine list
Redraw
Redraw lists
Redraw menus
Redraw toolbar
Redraw working message
Register DLL
Reinitialize search class
Remove all menus
Remove final menu
Remove menu
Remove toolbar
Rename class
Rename data
Reorganize data
Repeat
Replace line in list
Replace standard Edit menu
Replace standard File menu
Request advises
Request field
Restore selection for line(s)
Revert class
Save class
Save selection for line(s)
SEA continue execution
SEA repeat command
SEA report fatal error
Search list
Select list line(s)
Select printer
Send advises now
Send command
Send field
Send to a window field
Send to clipboard
Send to DDE channel
Send to file
Send to page preview
Send to port
Send to printer
Send to trace log
Set 'About...' method
Set advise options
Set bottom margin
Set break calculation
Set class description
Set closed files
Set current data file
Set current list
Set DDE channel item name
Set DDE channel number
Set default data file
Set export format
Set file read-only attribute
Set final line number
Set import file name
Set label width
Set labels across page
Set left margin
Set lines per page
Set main file
Set memory-only files
Set Omnis window title
Set page width
Set port name
Set port parameters
Set print or export file name
Set read-only files
Set read/write files
Set record spacing
Set reference
Set repeat factor
Set report main file
Set report main list
Set report name
Set right margin
Set search as calculation
Set search name
Set server mode
Set sort field
Set timer method
Set top margin
Set top window title
Show 'About...' window
Show docking area
Show fields
Show Omnis maximized
Show Omnis minimized
Show Omnis normal
Signal error
Single file find
SMTPSend
Sort list
Sound bell
Split path name
Sta:
Standard menu command
Start program maximized
Start program minimized
Start program normal
Start server
Stop server
Swap lists
Swap selected and saved
Switch
TCPAccept
TCPAddr2Name
TCPBind
TCPBlock
TCPClose
TCPConnect
TCPGetMyAddr
TCPGetMyPort
TCPGetRemoteAddr
TCPListen
TCPName2Addr
TCPPing
TCPReceive
TCPSend
TCPSocket
Test check data log
Test clipboard
Test data with search class
Test for a current record
Test for a unique index value
Test for field enabled
Test for field visible
Test for menu installed
Test for menu line checked
Test for only one user
Test for program open
Test for valid calculation
Test for window open
Test if file exists
Test if list line selected
Test if running in background
Text:
Trace off
Trace on
Transmit text to port
Transmit text to print file
Truncate file
Uncheck menu line
Unload error handler
Unload event handler
Unload external routine
Until break
Until calculation
Until flag false
Until flag true
Update data dictionary
Update files
Update files if flag set
UUDecode
UUEncode
Variable menu command
Wait for semaphores
Web Command Error Codes
WebDevGetSecureError
WebDevSetConfig
While calculation
While flag false
While flag true
Working message
Write entire file
Write file as binary
Write file as character
WriteBinFile
XOR selected and saved
Yes/No message
Yield to other threads
Omnis Function Reference
Omnis Function Reference
Omnis Software Ltd
About This Manual
Function information
Function Groups
Client Functions
Copyright info
Functions A-Z
abs()
acos()
alt()
ann()
anna()
asc()
asin()
atan()
atan2()
avgc()
basecolor()
bdif()
binchecksum()
bincompare()
binfrombase32()
binfrombase64()
binfromhex()
binfromint32()
binfromint64()
binlength()
binsearch()
bintobase32()
bintobase64()
bintohex()
bintoint32()
bintoint64()
bitand()
bitclear()
bitfirst()
bitmid()
bitnot()
bitor()
bitrotatel()
bitrotater()
bitset()
bitshiftl()
bitshiftr()
bittest()
bitxor()
bool()
br()
bundif()
bytecon()
byteget()
bytemid()
byteset()
callprivate()
cap()
cdif()
charat()
charcount()
chartoutf8()
chk()
chr()
cmd()
cmp()
cnubintolist()
complementarycolor()
compress()
con()
contains()
cos()
ctrl()
cundif()
dadd()
dat()
ddiff()
decstr()
decxtea()
delchars()
dim()
dname()
DNet.$addclass()
DNet.$basefolder()
DNet.$getenum()
dpart()
dtcy()
dtd()
dtm()
dtw()
dty()
encstr()
encxtea()
endswith()
errcode()
errtext()
eval()
evalf()
exp()
fact()
fday()
FileOps.$changeworkingdir()
FileOps.$converthfspathtoposixpath()
FileOps.$convertposixpathtohfspath()
FileOps.$copyfile()
FileOps.$createdir()
FileOps.$deletefile()
FileOps.$doesfileexist()
FileOps.$filelist()
FileOps.$getfileinfo()
FileOps.$getfilename()
FileOps.$getlasterror()
FileOps.$getunixpermissions()
FileOps.$getworkingdir()
FileOps.$isdirectory()
FileOps.$isfile()
FileOps.$movefile()
FileOps.$parentdir()
FileOps.$putfilename()
FileOps.$readfile()
FileOps.$rename()
FileOps.$selectdirectory()
FileOps.$setfileinfo()
FileOps.$setunixpermissions()
FileOps.$spaceinfo()
FileOps.$splitpathname()
FileOps.$writefile()
FileOpsObj.$closefile()
FileOpsObj.$createfile()
FileOpsObj.$createtmpfile()
FileOpsObj.$getfileinfo()
FileOpsObj.$getfilesize()
FileOpsObj.$getlasterror()
FileOpsObj.$getposition()
FileOpsObj.$isopen()
FileOpsObj.$openfile()
FileOpsObj.$openresources()
FileOpsObj.$readcharacter()
FileOpsObj.$readfile()
FileOpsObj.$selectfilesinsystemviewer()
FileOpsObj.$setfileinfo()
FileOpsObj.$setfilesize()
FileOpsObj.$setposition()
FileOpsObj.$writecharacter()
FileOpsObj.$writefile()
FileOps Function Error Codes
flag()
fld()
fmtdatetime()
fmtdp()
fmtshortdate()
fmtshorttime()
fontlist()
FontOps.$replistfonts()
FontOps.$reptextheight()
FontOps.$reptextwidth()
FontOps.$winlistfonts()
FontOps.$wintextheight()
FontOps.$wintextwidth()
format()
formatchunk()
formathttpdate()
formatserversentevent()
getdatetime()
getenv()
getfye()
getseed()
getticks()
getws()
hexcolor()
hsla()
iconidwithbadge()
iconurl()
idletime()
int()
isclear()
isclient()
iseven()
isfontinstalled()
isheadless()
isleopard()
islion()
ismountainlion()
isnull()
isnumber()
iso8601toomnis()
isodd()
isoweek()
isoweekstart()
issnowleopard()
isunicode()
isvista()
iswindows10()
iswindows11()
iswindows7()
iswindows8()
iswindows81()
iswindowsserver()
JavaObjs Library.$addclass()
JavaObjs Library.$resetclasscache()
join()
jst()
lday()
left()
len()
list()
listenv()
ln()
locale()
loctoutc()
log()
lookup()
low()
lst()
max()
maxc()
mid()
min()
minc()
mod()
mousedn()
mouseover()
mouseup()
msgcancelled()
nam()
natcmp()
nday()
nfc()
nfd()
not()
OIMAGE.$getdimensions()
OIMAGE.$makeqrcode()
OIMAGE.$resize()
OIMAGE.$transform()
OJSON.$arrayarraytolist()
OJSON.$couldbearray()
OJSON.$couldbeobject()
OJSON.$formatjson()
OJSON.$jsontolistorrow()
OJSON.$listorrowtojson()
OJSON.$listtoarrayarray()
OJSON.$listtoobjectarray()
OJSON.$objectarraytolist()
OmnisICalendar.$createcomponent()
OmnisICalendar.$createrow()
OmnisIcn Library.$getmask()
OmnisIcn Library.$getpict()
Omnis PDF Device.$encrypt()
Omnis PDF Device.$setdocinfo()
Omnis PDF Device.$setpdfsubset()
Omnis PDF Device.$setpdfversion()
Omnis PDF Device.$settemp()
omnistoiso8601()
ONOTIFY.$removebadge()
ONOTIFY.$removelocal()
ONOTIFY.$sendlocal()
ONOTIFY.$setbadgecount()
ONOTIFY.$setbadgeicon()
ord()
OREGEX.$replace()
OREGEX.$replaceall()
OW3.$computername()
OW3.$escapeuritext()
OW3.$gethardwareid()
OW3.$makeuri()
OW3.$makeuuid()
OW3.$parserfc3339()
OW3.$splitmultipart()
OW3.$totpgenerate()
OW3.$totpvalidate()
OW3.$unescapeuritext()
OXML.$base64decode()
OXML.$base64encode()
OXML.$formatbinaschar()
OXML.$maybexml()
OXML.$md5hexdigest()
OXML.$striphttpheader()
parsehttpauth()
parsehttpdate()
pathsep()
pday()
pick()
pictconvfrom()
pictconvto()
pictconvtypes()
pictformat()
pictsize()
platform()
PortProfile.$getportnames()
PortProfile.$getprofilenames()
pos()
prinf()
putenv()
pwr()
rand()
randintrng()
randrealrng()
rcedit.$getapplicationmanifest()
rcedit.$getfileversion()
rcedit.$getproductversion()
rcedit.$getresourcestring()
rcedit.$getversionstring()
rcedit.$setapplicationmanifest()
rcedit.$setfileversion()
rcedit.$seticon()
rcedit.$setproductversion()
rcedit.$setresourcestring()
rcedit.$setversionstring()
replace()
replaceall()
rgb()
rgba()
right()
rmousedn()
rmouseup()
rnd()
rolldice()
rollstring()
row()
rpos()
rxpos()
setfye()
setseed()
setws()
sha256()
sha512()
shift()
shufflelist()
sin()
sleep()
split()
sqr()
startswith()
stddevc()
stgetcol()
stgettext()
StringTable.$colcnt()
StringTable.$getcolumnname()
StringTable.$getcolumnnumber()
StringTable.$getlistfromfile()
StringTable.$gettablelist()
StringTable.$gettext()
StringTable.$loadcolumn()
StringTable.$loadexistingtablefromlist()
StringTable.$loadlistfromtable()
StringTable.$loadstringtable()
StringTable.$loadtablefromlist()
StringTable.$redraw()
StringTable.$removestringtable()
StringTable.$rowcnt()
StringTable.$savestringtable()
StringTable.$setcolumn()
StringTable.$unloadall()
StringTable.$unloadstringtable()
Strip()
strpbrk()
strspn()
strtok()
stsetcol()
style()
styledtohtml()
sys()
systemversion()
tan()
textsize()
tim()
tot()
totc()
tracelog()
trim()
truergb()
tzcurrent()
tzdaylight()
tzoffset()
tzstandard()
uncompress()
unichr()
unicode()
uniconv()
upp()
useradians()
utctoloc()
utf8tochar()
Omnis Notation Reference
$root
Unattached
Properties
Methods
Children
$components
$constants
$datas
$devices
$extobjects
$hashvardefs
$hashvars
$imenus
$iremoteforms
$iremotetasks
$ireports
$itasks
$itoolbars
$iwindows
$libs
$modes
$prefs
$sessionpools
$sessions
Common
ITEM.$cvardefs
ITEM.$cvars
ITEM.$ivardefs
ITEM.$ivars
ITEM.$methods
Standard DAM Session Methods
Standard DAM Session Properties
Standard DAM Statement Methods
Standard DAM Statement Properties
Standard Events
Standard Events
Standard Group Methods
Standard Methods
Standard Properties
External Objects
AUTOMATIONOBJECT
Properties
Methods
BLOWFISH
Properties
Methods
CRYPTOworker
Properties
Methods
DOM_Attribute
Properties
Methods
DOM_CDATASection
Properties
Methods
DOM_Comment
Properties
Methods
DOM_Document
Properties
Methods
DOM_DocumentFragment
Properties
Methods
DOM_DocumentType
Properties
Methods
DOM_Element
Properties
Methods
DOM_Entity
Properties
Methods
DOM_EntityReference
Properties
Methods
DOM_NamedNodeMap
Properties
Methods
DOM_NodeList
Properties
Methods
DOM_Notation
Properties
Methods
DOM_ProcessingInstruction
Properties
Methods
DOM_Text
Properties
Methods
FILEOPS
Properties
Methods
FTPworker
Properties
Methods
GRAPH2
Properties
Methods
HASHworker
Properties
Methods
HTTPworker
Properties
Methods
IMAPworker
Properties
Methods
MYSQLworker
Properties
Methods
OAUTH2worker
Properties
Methods
ODBCworker
Properties
Methods
ORACLEworker
Properties
Methods
POP3worker
Properties
Methods
PORTPROFILE
Properties
Methods
POSTGRESQLworker
Properties
Methods
SMTPworker
Properties
Methods
SQLITEworker
Properties
Methods
STRINGTABLE
Properties
Methods
SYBASEworker
Properties
Methods
TIMER
Properties
Methods
TRAYICON
Properties
Methods
WAVPLAY
Methods
Miscellaneous
Frame HWND
Properties
Generic
Properties
Methods
Children
HWND
Properties
List
Properties
Methods
Children
List defined from SQL class
Properties
Methods
Children
List row
Properties
Methods
Children
Remote Menu Instance
Properties
Children
Top Level HWND
Properties
Tree node
Properties
Methods
Omnis Studio External Components
Omnis Studio External Components
About This Manual
Upgrading to the Latest Version
Copyright info
Disclaimer
Chapter 1—Omnis External Components
Introduction
Creating your own External Components
Components in Omnis
Upgrading to the Latest Version
Windows and Child Windows
Data types Defined by the Component Library
Types of visual components
Types of non-visual components
Writing Thread-Safe Components
Component SDK Requirements
Component SDK Source Files
Getting Started with Generic
Extending Generic
General Hints
Creating Non-Visual Components
Static Functions
Class Objects
Object Base Classes
Control Handlers
Background Components
ECM_OBJCONSTRUCT
ECM_CONNECT
ECM_PRINT
Web Client Components
Chapter 2—Structures, Messages & Functions
Structures
ECOmethodEvent (for methods)
ECOmethodEvent (for events)
ECOproperty
EXTclipType
EXTCompInfo
EXTParamInfo
EXTParamTypeInfo (v3.1)
EXTSerialise (v3.1)
Flags
EXTD_OBJFLAG_xxx
EXTD_OBJFLAG_SINGLE_NOTIFY
EXTD_OBJFLAG_WORKER
EXTD_EFLAG_xxx
EXTD_EFLAG_REPFONT
EXTD_EFLAG_MVDBUTTON
EXTD_EFLAG_LISTDATEFORMATCUSTOM
EXTD_EFLAG_LISTNUMBERFORMAT
EXTD_EFLAG_ISDATANAME
EXTD_EFLAG_NOEXPORT
EXTD_EFLAG_REPORT_MEASURE
EXTD_EFLAG_EXT_PROPERTIES_CRB
EXTD_FLAG_xxx
EXTD_FLAG_BUTTON
EXTD_FLAG_EDITRONLY
EXTD_FLAG_ENUM
EXTD_FLAG_EXTCONSTANT
EXTD_FLAG_FAR_SRCH
EXTD_FLAG_FONTPROP
EXTD_FLAG_HIDDEN
EXTD_FLAG_INTCONSTANT
EXTD_FLAG_PARAMALTER
EXTD_FLAG_PARAMOPT
EXTD_FLAG_PRIMEDATA
EXTD_FLAG_PROPACT
EXTD_FLAG_PROPAPP
EXTD_FLAG_PROPCOLS
EXTD_FLAG_PROPCUSTOM
EXTD_FLAG_PROPDATA
EXTD_FLAG_PROPGENERAL
EXTD_FLAG_PROPGRP1
EXTD_FLAG_PROPJAVA
EXTD_FLAG_PROPPREFS
EXTD_FLAG_PROPPANE
EXTD_FLAG_PROPSECTIONS
EXTD_FLAG_PROPTEXT
EXTD_FLAG_PWINDCOL
EXTD_FLAG_PWINDCOL256
EXTD_FLAG_PWINDCURSOR (v3.1)
EXTD_FLAG_PWINDFSTYLE
EXTD_FLAG_PWINDICON
EXTD_FLAG_PWINDLSTYLE
EXTD_FLAG_PWINDMLINE
EXTD_FLAG_PWINDPAT
EXTD_FLAG_PWINDSET
EXTD_FLAG_PWINDTYPE
EXTD_FLAG_RUNTIMEONLY
EXTD_FLAG_SECTIONS
EXTD_FLAG_SINGLESEL
EXTD_FLAG_STATEONLY
EXTD_FLAG_SUPPRESS
General Messages
ECM_ADDTOPRINTJOB
ECM_BOBJ_EXERASE
ECM_CANADDTOPRINTJOB
ECM_CANCLICK (Web Client 1.0)
ECM_CANFOCUS (Web Client 1.0)
ECM_CANSHOWSYSTEMFOCUS (V3.2)
ECM_CMPPRIMARYDATA
ECM_COMPONENTCMD
ECM_CONNECT
ECM_CONSTPREFIX
ECM_CONVFROMHPIXMAP (Studio 2.1)
ECM_CONVHEADER (Studio 2.1)
ECM_CONVTOHPIXMAP (Studio 2.1)
ECM_CUSTOMTABNAME
ECM_DEBUGGING
ECM_DISCONNECT
ECM_EVENTRESULT (Web Client 1.0)
ECM_FMT_CANASSIGN
ECM_FMT_GETPROPERTY
ECM_FMT_SETPROPERTY
ECM_GETCOMPICON
ECM_GETCOMPID
ECM_GETCOMPLIBINFO
ECM_GETCOMPSTOREGROUP (Studio 2.1)
ECM_GETCOMPSTOREICON (Studio 2.1)
ECM_GETCONSTNAME
ECM_GETEVENTMETHOD
ECM_GETEVENTNAME
ECM_GETHANDLERICON
ECM_GETMETHODNAME
ECM_GETOBJECT
ECM_GETOBJECTRECT
ECM_GETPICTFILEDESC (Studio 2.1)
ECM_GETPICTFORMAT (Studio 2.1)
ECM_GETPICTUREDIM
ECM_GETPRIMARYDATA
ECM_GETPRIMARYDATALEN
ECM_GETPROPERTY
ECM_GETPROPERTYENUMS
ECM_GETPROPNAME
ECM_GETSTATICOBJECT
ECM_GETVERSION
ECM_HASPRIMARYDATACHANGED (Web Client V1.0)
ECM_ICONDRAWENTRY
ECM_INBUILT_OVERRIDE
ECM_INSTALLLIBRARY
ECM_ISCONVFORMAT (Studio 2.1)
ECM_LISTDRAWLINE
ECM_MEMORYDELETION
ECM_METHODCALL
ECM_NEWMETHODFLAGS
ECM_NEWPROPERTYFLAGS
ECM_OBJCONSTRUCT
ECM_OBJDESTRUCT
ECM_OBJECTDATABLOCK
ECM_OBJECT_COPY
ECM_OBJECT_REBUILD
ECM_OBJINITIALIZE
ECM_PAINTCONTENTS
ECM_PRIMARYDATACHANGE
ECM_PRINT
ECM_PRINTMAPPING
ECM_PROPERTYCALCTYPE
ECM_PROPERTYCANASSIGN
ECM_SETPRIMARYDATA
ECM_SETPROPERTY
ECM_SQLOBJECT_COPY (v3.1)
ECM_TEXTDRAWENTRY
WM_CONTROL Messages
DESKTOP_MENU_ENABLED
DRAW_DESIGN_NAME
DRAW_MULTIDESIGN_KNOBS
DRAW_NUMBER
GET_MENUHANDLE (Windows only)
GET_OMNIS_HPALETTE (Windows only)
HAS_FOCUS
HIDE_TOOLTIP
IS_FLD_EDITABLE
IS_IN_DESIGN
IS_MULTISELECTED
IS_OMNIS_IN_BUILDMODE
IS_SELECTED
IS_SERIALISED (v3.1)
IS_SETUP
IS_SHOWNUMBER
IS_WINDOW_TOP
LIST_SETLINEHEIGHT
OMNIS_IN_BACKGROUND
PICTURE_ERASEBKGROUND
PICTURE_UPDSCROLLRANGE
RESET_METHOD_FLAGS
RESET_PROPERTY_FLAGS
SET_EDITMENU
SET_PALETTE
SET_STATUSBAR_TEXT
SET_TOOLGRPS_VISIBLE
SET_WINDOWS_VISIBLE
SETNOERASEFORPICTURES
UPDATE_PROPINSPECTOR
General Functions
ECOaddParam()
ECOaddTraceLine()
ECOallowDefaultContextMenu()
ECOBprocessRemoteFormDesignMessage()
ECOBsendPropertyChange()
ECOBsetCurrentDesignItem()
ECOBsetScrollAmt()
ECOBsetScrollInfo()
ECOcanSendEvent() (web client only)
ECOclipboardGetPicture()
ECOclipboardGetPictureEx()
ECOclipboardGetText()
ECOclipboardHasFormat()
ECOclipboardSetPicture()
ECOclipboardSetText()
ECOconvertHFSToPosix()
ECOconvertPosixToHFS()
ECOconvKnownJavaObjs()
ECOcreateThread()
ECOdecrypt()
ECOdestroyCriticalSection()
ECOdoFind()
ECOdoMethod()
ECOdoMethodECI()
ECOdrawDesignName()
ECOdrawMultiKnobs()
ECOdrawNumber()
ECOdrawNumberEx()
ECOencrypt()
ECOenterCriticalSection()
ECOexcludeToolTipRect()
ECOfindObject()
ECOfindNVObject()
ECOfindParamNum()
ECOfindString()
ECOformatJSON()
ECOfromUChar()
ECOgetApp()
ECOgetBundleRef() Mac OSX only
ECOgetCoch()
ECOgetConstantDescriptionByValue()
ECOgetCrbFieldInfo()
ECOgetDeviceParms()
ECOgetDirectoryDialog()
ECOgetDpCh()
ECOgetFirstCharFromJSON()
ECOgetFont()
ECOgetFont()
ECOgetFontDPI()
ECOgetFontIndex()
ECOgetId()
ECOgetFsCh()
ECOgetJSNativeDisplay()
ECOgetLocalIpAddress()
ECOgetOmnisErrorText()
ECOgetNVObject()
ECOgetOmnisVersionNumber() (v5.1.1)
ECOgetParamCount()
ECOgetParamInfo()
ECOgetProperty()
ECOgetSepCh()
ECOgetStyle()
ECOgetTickCount()
ECOgetToolTipText()
ECOgetToolTipRect()
ECOgetUParamValue()
ECOhasConfigurationItem()
ECOhasFocus()
ECOhideTooltip()
ECOinitCriticalSection()
ECOinsertObject()
ECOinsertNVObject()
ECOinvalBackObj()
ECOisDesign()
ECOisJSONArray()
ECOisJSONObject()
ECOisMultiSelected()
ECOisOMNISinTrueRuntime()
ECOisSelected()
ECOisSerialised()
ECOisSetup()
ECOisShowNumber()
ECOisStudioNow()
ECOisWndTop()
ECOleaveCriticalSection()
ECOlistFonts()
ECOlistJSONMembers()
ECOlistSetLineHeight()
ECOloadFileDialog()
ECOlistSetLineHeight()
ECOlocpSetInst()
ECOmapString()
ECOmarkModified()
ECOmeetsStudioVersion()
ECOmemoryDeletion()
ECOmessageBox()
ECOopenMenu()
ECOopenTraceLog()
ECOnormalizeUChar()
ECOnotifyObject()
ECOnotifyObjectECI()
ECOpaintControlNotImplemented()
ECOpaintGrayFrame()
ECOparseClientJSON()
ECOparseJSON()
ECOparseJSONArraryArray()
ECOparseJSONObjectArrary()
ECOpostTaskMessage()
ECOpromptForInput()
ECOpushWorkerCallback()
ECOpushWorkerCallbackECI()
ECOreadBooleanConfigurationItem()
ECOreadIntegerConfigurationItem()
ECOreadLocalisationItem()
ECOreadSeparatorItem()
ECOreadStringConfigurationItem()
ECOreloadLibData()
ECOremoveObject()
ECOremoveNVObject()
ECOreplaceSeparators()
ECOresetObjDetails()
ECOresolveJSONMember()
ECOreturnCompID()
ECOreturnCompInfo()
ECOreturnConstants()
ECOreturnCStoreGrpName()
ECOreturnEventMethod()
ECOreturnEventMethod()
ECOreturnEvents()
ECOreturnIcon()
ECOreturnMethodEvents
ECOreturnMethods()
ECOreturnObjects()
ECOreturnProperties()
ECOreturnVersion()
ECOreturnVersion()
ECOrunCommand()
ECOrunningInHeadlessServer()
ECOsaveFileDialog()
ECOsaveToClientJSON()
ECOsaveToJSON()
ECOsaveToJSONArrayArray()
ECOsaveToJSONObjectArray()
ECOsendCompEvent()
ECOsendEvent()
ECOsendTab()
ECOsetConnectFlags()
ECOsetCustomTabName()
ECOsetDTformat()
ECOsetError()
ECOsetNotifyObjectWhenPushed()
ECOsetParameterChanged()
ECOsetParameterKeepTableInstance()
ECOsetProperty()
ECOsetToolTipText()
ECOsetupCallbacks()
ECOsleep()
ECOtlsSetValue()
ECOtoUChar()
ECOtryEnterCriticalSection()
ECOUpdateJSON()
ECOUpdateJSONArray()
ECOupdatePropInsp()
ECOuprCmp()
ECOwriteBooleanConfigurationItem()
ECOwriteIntegerConfigurationItem()
ECOwriteStringConfigurationItem()
WNDdefWindowProc()
Memory Functions
MEMcalloc()
MEMdataLen()
MEMdecAddr()
MEMfree()
MEMglobalAlloc()
MEMglobalFree()
MEMglobalHandle()
MEMglobalLock()
MEMglobalReAlloc()
MEMglobalSize()
MEMglobalUnlock()
MEMincAddr()
MEMmalloc()
MEMmemcmp()
MEMmemFill()
MEMmovel()
MEMmover()
MEMrealloc()
MEMscanf()
HANglobalAlloc()
HANglobalReAlloc()
HANglobalSize()
HANglobalFree()
qHandlePtr Class
qHandlePtr::qHandlePtr
qHandlePtr::qHandlePtr()
qHandlePtr::qHandlePtr()
qHandlePtr::operator =()
qHandlePtr::operator =()
qHandlePtr::operator +=()
qHandlePtr::operator -=()
qHandlePtr::operator +()
qHandlePtr::operator -()
qHandlePtr::operator !()
qHandlePtr::operator *()
qHandlePtr::operator *()
qHandlePtr::operator []()
qHandlePtr::dataLen()
qHandlePtr::dataLen()
qHandlePtr::getOffset()
qHandlePtr::getHandle()
qHandlePtr::set()
qHandlePtr::setOffset()
qHandlePtr::setNull()
Resource Functions
REScloseLibrary()
REScloseResourceFork() (MacOS only)
RESloadBitmap()
RESloadDialog()
RESloadString()
RESloadString()
RESopenLibrary()
RESopenResourceFork() (MacOS only)
Bit Functions
bitClear()
bitSet()
bitSet()
bitTest()
ObjInst Functions
EXTobjinst()
EXTobjinst()
EXTobjinst()
Chapter 3—strxxx Class Reference
Member Functions strxxx Class
strxxx::strxxx()
strxxx::assign()
strxxx::compare()
strxxx::concat()
strxxx::concat()
strxxx::concat()
strxxx::copy()
strxxx::cString()
strxxx::deleet()
strxxx::insert()
strxxx::insert()
strxxx::insertStr()
strxxx::insertStr0()
strxxx::length()
strxxx::maxLength()
strxxx::operator !()
strxxx::operator != ()
strxxx::operator [ ]()
strxxx::operator <()
strxxx::operator <=()
strxxx::operator =()
strxxx::operator =(qniltype qnil)
strxxx::operator ==()
strxxx::operator >()
strxxx::operator >=()
strxxx::pos()
strxxx::pos()
strxxx::pString()
strxxx::repWith0()
strxxx::upps()
strxxx::uprCmp()
Member Functions str15 Class
str15::str15()
str15::str15()
str15::str15()
str15::str15()
str15::str15()
str15::str15()
Member Functions str80 Class
str80::str80()
str80::str80()
str80::str80()
str80::str80()
str80::str80()
str80::str80()
Member Functions str255 Class
str255::str255()
str255::str255()
str255::str255()
str255::str255()
str255::str255()
str255::str255()
Other Functions
qlongToString()
qrealToString()
stringToQlong()
stringToQreal()
lowC()
uppC()
uppC()
uprCmp()
Chapter 4—Unicode Character Conversion
Introduction
Unicode Data Types
qchar
qoschar
qbyte
Utility Classes
CHRconvToOs
CHRconvFromOs
CHRconvToAscii
CHRunicode
CHRconvToUtf16
CHRconvFromUtf16
CHRconvToBytes
CHRconvFromBytes
CHRconvFromLatin1ApiBytes
CHRconvToLatin1ApiBytes
CHRconvToEncodedCharacters
CHRconvFromEncodedCharacters
CHRconvToOmnis
CHRconvFromOmnis
CHRconvToUniChar
CHRconvFromCodePage
CHRconvToCodePage
CHRconvFromUnicodeEncoding
CHRconvToUnicodeEncoding
CHRconvToUtf32FromChar
CHRconvFromUtf32ToChar
Other Functions
OMstr… Functions
QTEXT() Macro
QCHARLEN() and QOSCHARLEN() Macros
QBYTELEN() and QOSBYTELEN() Macros
Chapter 5—EXTBMPref & EXTCURref
Introduction
Enumerations
ePicModes (EXTBMPref only)
ePicSize (EXTBMPref only)
EXTBMPref Class Reference
EXTBMPref::EXTBMPref()
EXTBMPref::~EXTBMPref()
EXTBMPref::addBmpSize()
EXTBMPref::copyImage()
EXTBMPref::copyImage()
EXTBMPref::copyMask()
EXTBMPref::draw()
EXTBMPref::drawMask()
EXTBMPref::getBmpSize()
EXTBMPref::getIconId()
EXTBMPref::getRect()
EXTBMPref::hasMode()
EXTBMPref::hasSize()
EXTBMPref::transparentColor()
EXTCURref Class Reference (v2.2)
EXTCURref::EXTCURref()
EXTCURref::~EXTCURref()
EXTCURref::getCursor()
EXTCURref::getCursorId()
Chapter 6—qkey Reference
Introduction
Enumerations
qkey Class Reference
qkey::qkey()
qkey::qkey()
qkey::qkey()
qkey::qkey()
qkey::getPChar()
qkey::getVChar()
qkey::isAlt()
qkey::isControl()
qkey::isShift()
qkey::operator !()
qkey::operator !=()
qkey::operator ==()
qkey::uppc()
Other Functions
isShift()
isAlt()
Chapter 7—EXTfile Reference
Introduction
API Functions
FILEclose()
FILEcreate()
FILEcreateInst()
FILEcreateTemp()
FILEdelete()
FILEdestroyInst()
FILEexists()
FILEfullName()
FILEgetLength()
FILEgetName()
FILEgetOmnisFolder() (v3.1)
FILEgetOmnisProgramFolder() (v4.3)
FILEgetPosition()
FILEopen()
FILEopenResources() (v3.1)
FILEread()
FILEread()
FILEsetEmpty()
FILEsetLength()
FILEsetMacTypeCreator()
FILEsetMacTypeCreator()
FILEsetPosition()
FILEwrite()
EXTfile Class Reference
EXTfile::EXTfile()
EXTfile::~EXTfile()
EXTfile::close()
EXTfile::create()
EXTfile::createTemp()
EXTfile::deleet()
EXTfile::exists()
EXTfile::fullName()
EXTfile::getLength()
EXTfile::getName()
EXTfile::getOmnisFolder()
EXTfile::getOmnisProgramFolder() (v4.3)
EXTfile::getPosition()
EXTfile::open()
EXTfile::openResources() (v3.1)
EXTfile::read()
EXTfile::read()
EXTfile::readCharacterData() (v4.0)
EXTfile::readIntoHandle() (v4.0)
EXTfile::setEmpty()
EXTfile::setLength()
EXTfile::setMacTypeCreator()
EXTfile::setMacTypeCreator()
EXTfile::setPosition()
EXTfile::write()
Chapter 8—CRB Reference
Introduction
API Functions
CRBcreate()
CRBdestroy()
CRBduplicate()
CRBflatten()
CRBgetCrbRef()
CRBgetData()
CRBgetDataRef()
CRBgetFlatSize()
CRBgetIndexCount()
CRBgetLong()
CRBgetLong64()
CRBgetReal()
CRBsetData()
CRBsetLong()
CRBsetLong64()
CRBsetReal()
CRBunflatten()
EXTcrb Class Reference
EXTcrb::EXTcrb()
EXTcrb::EXTcrb()
EXTcrb()::~EXTcrb()
EXTcrb::copy()
EXTcrb::crb()
EXTcrb::flatten()
EXTcrb::getCrbRef()
EXTcrb::getData()
EXTcrb::getDataRef()
EXTcrb::getFlatSize()
EXTcrb::getIndexCount()
EXTcrb::getLong()
EXTcrb::getReal()
EXTcrb::makeMine()
EXTcrb::setData()
EXTcrb::setLong()
EXTcrb::setReal()
EXTcrb::unflatten()
Chapter 9—EXTqlist Reference
Introduction
EXTqlist Memory Issues
Structures and Enumerations
listtype
EXTsortItem
EXTsortStruct
EXTqlist Class Reference
EXTqlist::EXTqlist()
EXTqlist::EXTqlist()
EXTqlist::EXTqlist()
EXTqlist::EXTqlist()
EXTqlist::EXTqlist() (v3.0)
EXTqlist::~EXTqlist()
EXTqlist::addCol()
EXTqlist::addCol()
EXTqlist::addColEx() (v5.0)
EXTqlist::clear()
EXTqlist::clearRow()
EXTqlist::colCnt()
EXTqlist::convertEncoding() (v4.2)
EXTqlist::copyDef()
EXTqlist::defineFromSQLClass() (v4.2)
EXTqlist::deleteRow()
EXTqlist::dup()
EXTqlist::empty()
EXTqlist::findCol()
EXTqlist::getBinary()
EXTqlist::getBinLen()
EXTqlist::getCol()
EXTqlist::getCol()
EXTqlist::getColType()
EXTqlist::getColVal()
EXTqlist::getColVal()
EXTqlist::getColValRef()
EXTqlist::getCurRow()
EXTqlist::getLstPtr()
EXTqlist::getColFlags() (v4.1)
EXTqlist::getColNullInfo() (v4.1)
EXTqlist::getRow()
EXTqlist::getRow()
EXTqlist::getRowCrb()
EXTqlist::getRowMax()
EXTqlist::insertRow()
EXTqlist::isRowSelected()
EXTqlist::loadRows()
EXTqlist::operator = (qniltype qnil)
EXTqlist::putColVal()
EXTqlist::putRow()
EXTqlist::rowCnt()
EXTqlist::selectRow()
EXTqlist::setCol() (v5.0)
EXTqlist::setCurRow()
EXTqlist::setFinalRow()
EXTqlist::setRowMax()
EXTqlist::sort()
Chapter 10—EXTfldval Reference
Introduction
EXTfldval Memory Issues
EXTfldvals and EXTqlists
Getting a list from an EXTfldval
Enumerations and Structures
ffttype
crbFieldInfo (V2.2)
datestamptype
EXTfldval Class Reference
EXTfldval::EXTfldval()
EXTfldval::EXTfldval()
EXTfldval::EXTfldval()
EXTfldval::~EXTfldval()
EXTfldval::operator =()
EXTfldval::compare()
EXTfldval::compare()
EXTfldval::compare()
EXTfldval::concat()
EXTfldval::concat()
EXTfldval::concat()
EXTfldval::concat()
EXTfldval::conv()
EXTfldval::evalCalculation() (Studio 2.0)
EXTfldval::getBinary()
EXTfldval::getBinLen()
EXTfldval::getBool()
EXTfldval::getCalculation() (Studio 2.0)
EXTfldval::getChar()
EXTfldval::getChar()
EXTfldval::getChar()
EXTfldval::getChar()
EXTfldval::getCharLen() (v4.1)
EXTfldval::getConstant()
EXTfldval::getCrbRef()
EXTfldval::getDate()
EXTfldval::getFldVal()
EXTfldval::getHandle()
EXTfldval::getHandle()
EXTfldval::getList()
EXTfldval::getList()
EXTfldval::getLong()
EXTfldval::getLong()
EXTfldval::getNum()
EXTfldval::getObjInst()
EXTfldval::getOmnisField()
EXTfldval::getType()
EXTfldval::insertStr
EXTfldval::isEmpty()
EXTfldval::isList()
EXTfldval::isLongChar()
EXTfldval::isNull()
EXTfldval::isOmnisData()
EXTfldval::isReadOnly()
EXTfldval::pos()
EXTfldval::pos()
EXTfldval::pos()
EXTfldval::pos()
EXTfldval::replaceStr()
EXTfldval::replaceStr()
EXTfldval::setBinary()
EXTfldval::setBool()
EXTfldval::setCalculation() (Studio 2.0)
EXTfldval::setChar()
EXTfldval::setChar()
EXTfldval::setConstant()
EXTfldval::setConstant()
EXTfldval::setConstant() (v4.1)
EXTfldval::setCrbRef()
EXTfldval::setDate()
EXTfldval::setEmpty() (v3.1)
EXTfldval::setFldVal()
EXTfldval::setHandle()
EXTfldval::setHandle()
EXTfldval::setList()
EXTfldval::setList()
EXTfldval::setLong()
EXTfldval::setNull() (v3.1)
EXTfldval::setNum()
EXTfldval::setObjInst()
EXTfldval::setOmnisData()
EXTfldval::setReadOnly()
Chapter 11—HWND Reference
The HWND
The Z-order
HWND Components
Structures, Data types, and Defines
GW_xxx
GWL_xxx
HDC
HTxxx
HWND
HWND_xxx
LPARAM
SW_xxx
SWP_xxx
UINT
WM_EXUSER
WND_CAPTURE_xxx
WND_BORD_xxx
WND_CURS_xxx
WND_RW_xxx
WND_SCROLLBAR_WIDTH (v3.1)
WND_TIMER_xxx
WNDborderStruct
WNDenumProc
WNDeraseInfoStruct
WNDminMaxInfo
WNDmultiKey (v4.1)
WNDpaintStruct
WNDprocClass
WNDwindowPosStruct
WPARAM
Styles
WND_DRAGBORDER (extended style)
WND_FLOAT_xxx (extended style)
WND_KEYPREVIEW (extended style)
WND_NOADJUSTCOMPONENTS (extended style)
WND_NOFLOATCHILDREN (extended style)
WND_OSMESSAGES (extended style)
WND_REDRAWONSIZE (extended style)
WND_TRANSPARENT (extended style)
WND_WC_xxx (extended style)
WS_xxx
Messages
WM_BORDCALCRECT
WM_BORDERCHANGED (v3.1)
WM_BORDERCHANGING (v3.1)
WM_BORDERASEBACKGROUND (v4.0)
WM_BORDPAINT
WM_CAPTUREABORT
WM_CHILDPAINT
WM_COREPATTERNGRADIENTSUPPORT (v5.0)
WM_CREATE
WM_DESTROY
WM_DRAGBORDER
WM_DRAGDROP
WM_ERASEBKGND
WM_FOCUSCHANGED
WM_GETERASEINFO
WM_GETMINMAXINFO
WM_GETSHADOWRECT (Mac OSX only)
WM_HSCROLL and WM_VSCROLL
WM_IPHONE_ROUNDRECT_TEXTFIELDSTYLE
WM_KEYxxx
WM_LBUTTONxxx and WM_RBUTTONxxx
WM_MOUSEMOVE
WM_MOUSEWHEEL
WM_MULTIKEYDOWNPREVIEW
WM_NCACTIVATE
WM_NCLBUTTONDOWN
WM_NULL
WM_PAINT
WM_PRI_INSTALL
WM_PRI_REMOVE
WM_RBUTTONxxx
WM_OSXREPAINTPLUGIN (v5.0)
WM_SETCURSOR
WM_SHOWSIZEGRIP
WM_SHOWWINDOW
WM_TIMER
WM_TOOLTIP
WM_VSCROLL
WM_WINDOWPOSCHANGED
WM_WINDOWPOSCHANGING
Functions
HIWORD()
LOWORD()
WNDabortMouseCapture()
WNDaddWindowComponent()
WNDbeginPaint()
WNDbringWindowToTop()
WNDchangeComponentId()
WNDcheckCursor()
WNDchildPaintBegin() (v3.1)
WNDchildPaintEnd() (v3.1)
WNDclipCursor()
WNDcreateCaret()
WNDcreateWindow()
WNDdelay()
WNDdestroyCaret()
WNDdestroyWindow()
WNDdragAcceptFiles()
WNDdrawThemeBackground() (v3.1)
WNDdrawThemeControl()
WNDendDraw()
WNDendDrawEx()
WNDendPaint()
WNDenumChildWindows()
WNDfloatChildren()
WNDgetBorderSpec()
WNDgetCapture()
WNDgetCaretPos()
WNDgetClientRect()
WNDgetCursor()
WNDgetCursorPos()
WNDgetFloat()
WNDgetGrowBoxRect()
WNDgetMainHwnd() (Win & Linux only)
WNDgetMinMaxInfo()
WNDgetOS()
WNDgetParent()
WNDgetScrollPos()
WNDgetScrollRange()
WNDgetThemeColor()
WNDgetThemeState()
WNDgetThemeControlSize()
WNDgetUpdateRgn()
WNDgetWindow()
WNDgetWindowComponent()
WNDgetWindowCursor()
WNDgetWindowFromPt()
WNDgetWindowLong()
WNDgetProcInst()
WNDgetWindowRect()
WNDhasCapture()
WNDhideCaret()
WNDinflateBorderRect()
WNDinsetBorderRect()
WNDinvalidateFrame()
WNDinvalidateRect()
WNDinvalidateRgn()
WNDisBorderExternal() (v3.1)
WNDisPaintInProgress()
WNDisVistaTheme()
WNDisWindowVisible()
WNDkillTimer()
WNDmakeLong()
WNDmakeLong() (v3.1)
WNDmakeEnumWindowsProc ()
WNDmakePoint()
WNDmakeRect() (v3.1)
WNDmapWindowPoint()
WNDmapWindowRect()
WNDmouseLeftButtonDown()
WNDmouseRightButtonDown()
WNDmouseTrackLeftButton() (v3.1)
WNDmoveWindow()
WNDnextWindowComponent()
WNDpaintBorder()
WNDpostMessage() (v3.1)
WNDredrawChildren()
WNDredrawWindow()
WNDredrawWindowCO()
WNDreleaseCapture()
WNDremoveWindowComponents()
WNDscrollWindow()
WNDsendMessage()
WNDsetBorderSpec()
WNDsetCanSetCursorProc()
WNDsetCapture()
WNDsetCaretPos()
WNDsetCursor()
WNDsetCursorPos()
WNDsetFloat()
WNDsetParent()
WNDsetProcInst()
WNDsetRedraw()
WNDsetScrollPos()
WNDsetScrollRange()
WNDsetTimer()
WNDsetTimerAttributesOSX()
WNDsetWindowCursor()
WNDsetWindowLong()
WNDsetWindowPos()
WNDsetWindowPosEx()
WNDshowCaret()
WNDshowWindow()
WNDstartDraw()
WNDstartDrawEx()
WNDupdateLayeredWindow()
WNDupdateWindow()
WNDupdateWindowCO()
WNDwindowFromDC() (v3.1)
Chapter 12—GDI Reference
Structures, Data types, and Defines
GDIdeviceScale
GDItextSpecStruct
HBITMAP
HBITMAPMASK
HBRUSH
HFONT
HPEN
HPALETTE
HPIXMAP
HPIXMAPinfo
qcol
qColorEntry
qdim
qdmd
qfnt
qjst
qpat
qpen
qpoint
qrect
qrgn
qsty
Functions
GDIalignPicture()
GDIalphaBitmapToPIXMAP() (v3.3)
GDIalphaPixmapToBitmap() (v3.3)
GDIanimatePalette()
GDIbitmapToColorShared()
GDIbitmapToMonoPIXMAP() (v3.3)
GDIbitmapToPIXMAP() (v3.3)
GDIcalcJstEscLen() (v5.0)
GDIcgContextFlush() (v4.1, Mac OSX only)
GDIcharWidth()
GDIcheckPort()
GDIclearClip()
GDIclearClipAlpha() (v5.0)
GDIconvToSysPict()
GDIconvToOmnisPict ()
GDIconvToSharedPict()
GDIcopyBits()
GDIcopyRect()
GDIcreateAlphaDC() (v5.0)
GDIcreateBitmap()
GDIcreateBitmapEx()
GDIcreateBrush()
GDIcreateCursor()
GDIcreateDcFont()
GDIcreateFont()
GDIcreateHPIXMAP()
GDIcreatePalette()
GDIcreatePen()
GDIcreatePixmapFromJPEG
GDIcreatePolyRgn()
GDIcreateRectRgn()
GDIcreateRoundRectRgn()
GDIcreateScreenDC()
GDIdeleteAlphaDC() (v5.0)
GDIdeleteBitmap()
GDIdeleteCursor()
GDIdeleteHPIXMAP()
GDIdeleteObject()
GDIdeletePalette()
GDIdeleteScreenDC()
GDIdragBitmapMove()
GDIdragBitmapToScreen()
GDIdragBitmapFromScreen()
GDIdraw3DPushButton()
GDIdrawAlphaBitmap() (v3.3)
GDIdrawBitmap()
GDIdrawBitmapChisel()
GDIdrawComboButton()
GDIdrawFocusRect()
GDIdrawHeadingButton()
GDIdrawHPIXMAP()
GDIdrawHPIXMAPchisel()
GDIdrawHPIXMAPmask()
GDIdrawIcon()
GDIdrawPicture()
GDIdrawSystem3dPushButton()
GDIdrawSystemPushButton()
GDIdrawText()
GDIdrawTextFastAlpha() (v5.0)
GDIdrawTextJst()
GDIendText() (v5.0)
GDIequalRect()
GDIequalRgn()
GDIexcludeClipRect()
GDIexcludeClipRgn()
GDIfillEllipse()
GDIfillPoly()
GDIfillRect()
GDIfillRgn()
GDIfillRoundRect()
GDIfloodFill()
GDIflushDC() (v3.1)
GDIfontDecSize()
GDIfontGetExtra()
GDIfontGetSize()
GDIfontHeight()
GDIfontIncSize()
GDIfontIsReal()
GDIfontIsTrueType()
GDIfontPart()
GDIfontSetExtra()
GDIfontSetSize()
GDIframeEllipse()
GDIframePoly()
GDIframeRect()
GDIframeRgn()
GDIframeRoundRect()
GDIgetBkColor()
GDIgetBkColorAlpha() (v5.0)
GDIgetClipRect()
GDIgetClipRgn()
GDIgetColorEntries()
GDIgetDarkerShade()
GDIgetDeviceScale()
GDIgetFlagsForAlphaDC() (v5.0)
GDIgetFontName()
GDIgetHPIXMAPinfo()
GDIgetLighterShade()
GDIgetMenubarHeight()
GDIgetNativeGraphicsObjectForAlphaDC() (v5.0)
GDIgetPaletteEntries()
GDIgetPixel()
GDIgetRealColor()
GDIgetRgnBox()
GDIgetScreenRect()
GDIgetScreenResolution()
GDIgetStockBrush()
GDIgetStockPen()
GDIgetTempDC()
GDIgetTextColorAlpha() (v5.0)
GDIgetTextColor()
GDIgetViewportOrg()
GDIhasAlphaSupport()
GDIhiliteBitmap()
GDIhiliteRect()
GDIhiliteRgn()
GDIhiliteTextEnd() (v3.1)
GDIhiliteTextStart() (v3.1)
GDIHPIXMAPfromSharedPicture()
GDIinflateButtonRect()
GDIinflateRect()
GDIinsetButtonRect()
GDIinsetRect()
GDIintersectClipRect()
GDIintersectClipRgn()
GDIintersectRect()
GDIinvertRect()
GDIinvertRgn()
GDIisAlphaImage() (v3.3)
GDIisRectEmpty()
GDIlineTo()
GDIlockHPIXMAP()
GDImakeGrayScale()
GDImakeHilited() (v4.0)
GDImakeOptionClickProc()
GDImaskFromBitmap()
GDImoveTo()
GDIoffscreenPaintBegin() (v3.1)
GDIoffscreenPaintEnd() (v3.1)
GDIoffsetRect()
GDIoffsetRgn()
GDIpictGetBounds()
GDIpixmapToColorShared()
GDIptInRect()
GDIptInRgn()
GDIptInScreen()
GDIrectInRgn()
GDIreadVersion()
GDIrgnAnd()
GDIrgnCopy()
GDIrgnDiff()
GDIrgnOr()
GDIrgnXor()
GDIselectBitmap()
GDIselectObject()
GDIsetAlphaLevel() (v5.0)
GDIsetBkColor()
GDIsetBkColorAlpha() (v5.0)
GDIsetClipRect()
GDIsetClipRgn()
GDIsetColorEntries()
GDIsetDeviceScale()
GDIsetDrawingMode()
GDIsetFlagsForAlphaDC() (v5.0)
GDIsetFlush() (v3.1)
GDIsetFontName()
GDIsetPalette()
GDIsetPaletteEntries()
GDIsetPixel()
GDIsetPortClipRegion() (v3.1, Mac OSX only)
GDIsetRect()
GDIsetRectEmpty()
GDIsetRectRgn()
GDIsetTextColor()
GDIsetTextColorAlpha() (v5.0)
GDIsetViewportOrg()
GDIstartText() (v5.0)
GDItextBox()
GDItextWidth()
GDItextWidthJst()
GDIthemeText() (v3.1, Mac OSX only)
GDIthemeText() (v3.1, Mac OSX only)
GDIunionClipRect()
GDIunionClipRgn()
GDIunionRect()
GDIunlockHPIXMAP()
GDIuseStyledTextColors() (V2.2)
Chapter 13—PRI Reference
The Input Manager
A simple print job
The Output Manager
A simple external output device
Internal Output Devices
PRI_DEST_EXTBASE
PRI_DEST_EXTHDC
PRI_DEST_EXTPRINTER
PRI_DEST_EXTPREVIEW
PRI_DEST_EXTSCREEN
PRI_DEST_EXTDISK
PRI_DEST_EXTMEM
PRI_DEST_EXTCLIPBOARD
PRI_DEST_EXTPORT
PRI_DEST_EXTFILE
PRI_DEST_EXTDDE_PUB (MAC)
Structures, Data types and Defines
ePRIpos
PRI_ERR_xxx
PRI_xxx
PRIdestParmStruct
PRIdeviceInfoStruct
PRIobjectStruct
PRIpageSetup
PRIpageStruct
PRIparmStruct
PRIprocClass
PRIsectionStruct
qpridim
qprierr
qpripage
qpripos
qprirect
Messages (Printing)
PM_ADD_FOOTER_OBJECTS
PM_ADD_HEADER_OBJECTS
PM_CLOSE
PM_INIT_PAGE
PM_OUT_PAGE
PM_OUT_PREVIEW
PM_OUT_PRINTER
PM_OUT_SAVE
PM_PAINT_OBJECT
Messages (Custom devices)
PM_OUT_ADDPAGE
PM_OUT_ADJPOS
PM_OUT_AFTER
PM_OUT_BROWSE
PM_OUT_CLICK
PM_OUT_CLOSE
PM_OUT_CLOSEDEVICE
PM_OUT_CONSTRUCT
PM_OUT_DCLICK
PM_OUT_DESTRUCT
PM_OUT_DRAWOBJECT
PM_OUT_DRAWPAGE
PM_OUT_FLUSHDEVICE
PM_OUT_GETDLGIDS
PM_OUT_GETEOL
PM_OUT_GETERRTEXT
PM_OUT_GETPAGEDLG
PM_OUT_GETPARM
PM_OUT_GETPARMDLG
PM_OUT_ISDEVICEOPEN
PM_OUT_KILL
PM_OUT_LOADPARMS
PM_OUT_OPEN
PM_OUT_OPENDEVICE
PM_OUT_SAVEPARMS
PM_OUT_SENDDATA
PM_OUT_SENDPAGE
PM_OUT_SENDTEXT
PM_OUT_SETDATA
PM_OUT_SETPARM
PM_OUT_SET_HDC
PM_OUT_VALIDATEPARMS
PM_OUT_ZOOM
Functions
PRIaddObject
PRIbrowseOutput
PRIbuildPrinterList (Windows only)
PRIchangeJobPageSetup
PRIclose
PRIcloseDevice
PRIconvFromCM
PRIconvFromCMorINCH
PRIconvFromDC
PRIconvFromIN
PRIconvFromScreen
PRIconvPos
PRIconvRectFromDC
PRIconvRectFromScreen
PRIconvRectToDC
PRIconvRectToScreen
PRIconvToCM
PRIconvToCMorINCH
PRIconvToDC
PRIconvToIN
PRIconvToScreen
PRIcopyPageSetup
PRIcreateSection
PRIdefOutputProc
PRIdeleteSection
PRIdestroyPageSetup
PRIdisposeCustomProc
PRIejectPage
PRIendJob
PRIendPage
PRIextended
PRIflattenDriverInfo
PRIflushDevice
PRIgetDeviceEOLchars
PRIgetDeviceInfo
PRIgetDeviceName
PRIgetDriverSignature
PRIgetError
PRIgetErrorText
PRIgetFlattDriverInfoSize
PRIgetPageInfo
PRIgetPageSetup
PRIgetPageSetupItem
PRIgetPaperDimensions
PRIgetParmStruct (v4.2)
PRIgetSectionInfo
PRIgetSysError
PRIgrowSection
PRIinitDestinationParms
PRIisDeviceOpen
PRIkillJob
PRIloadJob
PRImakeCustomProc
PRInormPos
PRIopen
PRIopenChangePrinterDialog (Windows only)
PRIopenDestinationDialog
PRIopenDevice
PRIopenGetFileDialog
PRIopenJobSetupDialog
PRIopenPageSetupDialog
PRIpageSetupFromCRB
PRIpageSetupToCRB
PRIredirectJob
PRIregisterOutput
PRIsendDataToDevice
PRIsendTextToDevice
PRIsetDeviceInfo
PRIsetError
PRIsetPageInfo
PRIsetPageSetup
PRIsetPageSetupItem
PRIsetSectionInfo
PRIshowError
PRIstartJob
PRIstartPage
PRItextHeight
PRItextWidth
PRItextWidthEx
PRIunflattenDriverInfo
PRIunregisterOutput
PRIvalidateDest
Chapter 14—DAM API Reference
Introduction
Developer Guide
Folder Structure
Building the DAM
Implementation Notes
Adding Custom Attributes
Omnis Object Methods
Session Object
$logon()
$logoff()
$clear()
$makeschema()
$newstatement() $newstatementref()
$begin()
$commit()
$rollback
$nextnativeerror()
$rpcdefine()
$coltext()
$createnames()
$insertnames()
$selectnames()
$updatenames()
$wherenames()
Statement Object
$clear()
drop()
$columns()
$execdirect()
$prepare()
$execute()
$fetch()
$fetchinto()
$fetchtofile()
$indexes()
$nextnativeerror()
$results()
$rpc()
$rpcparameters()
$rpcprocedures()
$tables()
StatementWorker Object
$init()
$run()
$start()
$cancel()
$sessionref()
Base Classes
tqfDAMbaseObj
tqfDAMStatementObj
StatementWorker
StatementWorkerDelegate
tqfDAMObjCont
tqfDAMStatementCont
StatementWorkerCont
Support Classes
DAMTypeTable
DAMErrorInfo
DAMParam
DAMData
DAMCharMapTable
DAMrpcDefn
DAMunicodeText
General Functions
Constants and Enumerations
Transaction Mode
Commit Mode
Rollback Mode
Session state
Type Entry
DAM Errors
Session Character Map
Character Map Mode
Unicode Encoding
Error State
Statement Level State
Fetch Call State
Table Types
Index Types
Parameter Types
Parameter Send Types
Parameter Bind Types
Parameter C-Types
Chunk States
Add Row Modes
DAM-Specific External Component Library Callbacks
Appendix A—Debugging macOS Components
Introduction
Appendix B—Building macOS Universal Components
JavaScript Component SDK
JavaScript Component SDK
About This Manual
C++ Design Component
JavaScript Control
Tutorial
Building Generic
C++ Component
The JavaScript Control
Running Generic
Extending Generic
Generic 2
Generic 3
Debugging
Debugging a Component
Debugging a Control
C++ Design Component Reference
External Component Structures
ECOmethodEvent
ECOparam
ECOproperty
JavaScript Component Structures
JSChtmlOptions
WCCcontrol
Flags
EXTIPJS_FLAG_xxx
EXTJS_FLAG_xxx
WCC_FLAG_xxx
Messages
ECM_GETPROPERTY
ECM_PROPERTYCANASSIGN
ECM_SETPROPERTY
Function Pointer Types
JSC_GETINNERHTML
webClientComponent Reference
Public Members
mNoDesignName
Virtual Methods
attributeSupport()
inval()
paintDesign()
javaScriptComponent Reference
Class Methods
javaScriptComponent::escapeHTMLsyntaxChars()
javaScriptComponent::jsAddIconUrl()
javaScriptComponent::jsGetFontName()
javaScriptComponent::jsGetIconPath()
javaScriptComponent::jsInsert()
javaScriptComponent::jsInsertBool()
javaScriptComponent::jsInsertBorder()
javaScriptComponent::jsInsertColor()
javaScriptComponent::jsInsertColorPair()
javaScriptComponent::jsInsertIcon()
javaScriptComponent::jsInsertId()
javaScriptComponent::jsInsertIfNotEmpty()
javaScriptComponent::jsInsertNum()
javaScriptComponent::jsInsertStyle()
javaScriptComponent::jsInsertWithAttName()
javaScriptComponent::jsStyleAppendColor()
javaScriptComponent::jsStyleAppendColorFromValue()
javaScriptComponent::jsStyleAppendFontAlign()
javaScriptComponent::jsStyleAppendFontName()
javaScriptComponent::jsStyleAppendFontSize()
javaScriptComponent::jsStyleAppendFontStyle()
javaScriptCompone
n
t::setRedrawOnSize()
Virtual Methods
javaScriptComponent::getCtrlName
JavaScript Control Reference
Fundamentals
Loading Controls
Themed Colors
Constants
eAnums
eBaseBorder
eBaseEvent
eBaseProperties
eClientPlatforms
eDateParts
eDoMethodFlags
eOmnisDataSubTypes
eOmnisDataTypes
ctrl_base.DEFAULT_COLOR_NAMES
Info
Date Formatting
Definitions
Number Formatting
JavaScript Structures
omnis_cols
omnis_date
omnis_list
omnis_list_col
omnis_raw_list
JavaScript API Reference
Control – Inherited Methods
constructor
init_class_inst()
init_ctrl_inst()
delete_class_inst()
updateCtrl()
handleEvent()
getCanAssign()
getProperty()
setProperty()
sizeChanged()
fillChanged()
fontChanged()
enabledChanged()
activeChanged()
getTrueVisibility()
visibilityChanged()
formBuilt()
getErrorBorderDiv()
scriptAvail()
Control - Instance Methods
alphaFromCssColor()
callMethod()
callMethodEx()
canSendEvent()
doSetProperty()
eventParamsAdd()
focus()
getCanAssign()
getClientElem()
getData()
setData()
getDisplayFormat()
getIconUrlFromImgSrc()
getIconUrlFromStyleUrl()
getProperty()
getTextWidthDiv()
removeTextWidthDiv()
getTrueVisibility()
isEnabled()
removeFromTabOrder()
sendEvent()
setPropCli()
setProperty()
setPropertyBorder()
setupIcon()
update()
visibilityChanged()
isActive()
getTheme()
resolveDefaultColor()
Control - Properties
.elem
.form
.mEventFunction
.objName
.objNumber
allowDefaultDropHandling
baseClassName
DefaultColors
mAcceptsReturn
mAcceptsEscape
Form
beginAnimations()
callMethod()
callMethodEx()
commitAnimations()
findChild()
findChildByName()
getData()
getDataIndex()
getNextPrevTabObject()
registerForFormBuilt()
requestScriptAvailNotify()
setData()
jIcons
getCheckedImage()
getIconBackSize()
getIconSize()
replaceOrAddToElem()
iconUrl()
setImageUrl()
jOmnis
addClass()
removeClass()
hasClass()
addStyleSheet()
removeStyleSheet()
registerStyleSheetObject()
unregisterStyleSheetObject
loadResource()
loadResources()
addSwipeListener()
animate()
clearAnimations()
applyAlphaValueToColorPair()
applyColorValueToColorPair()
disableTextSelection()
extractColor()
extractSolidColor()
getAttributeAsBool()
getAttributeList()
getCheckedImage()
getClientLocale()
cToChar()
rgbFromCssColor()
getColorString()
getColorStringWithAlpha()
getColorStringForElement()
getEventCurrentTarget()
getEventTarget()
getIconBackSize()
getIconSize()
getOmnisForm()
getOmnisFormControl()
getOmnisHeight()
getOmnisInst()
getOmnisLeft()
getOmnisTop()
getOmnisWidth()
getStyle()
getTotalHeight()
getTotalWidth()
getWindowClientScroll()
getWindowClientSize()
inAppWrapper()
okMessage()
showDialogEx()
parseInteger()
setBackgroundFromOmnisDefinition()
setBorderRadius()
setOmnisHeight()
setOmnisLeft()
setOmnisRect()
setOmnisTop()
setOmnisWidth()
setPropertyBackground()
stopEventNow()
setFontSize()
getElemPosRelativeToAncestor()
getDefaultDateFormatCustom()
setDefaultDateFormatCustom()
getLocaleTimeFormat()
getLocaleShortDateFormat()
getLocaleShortDateTimeFormat()
getLocaleMediumDateFormat()
getLocaleMediumDateTimeFormat()
getLocaleLongDateFormat()
getLocaleLongDateTimeFormat()
getLocaleFullDateFormat()
getLocaleFullDateTimeFormat()
trim()
ltrim()
rtrim()
inFirefox()
inOpera()
inChrome()
inSafari()
inEdge()
getMethod()
doMethod()
defaultParameter()
clientPlatform
inFirefoxiOS()
inChromeiOS()
deepCopy()
getURLParameters()
sendDOMEvent()
getContainerControl()
jStyles
setElem()
get()
getInt()
done()
Theme - Static Properties
.COLORS
.COLOR_NAMES
Theme - Instance Methods
getColorString()
getTextColorString()
getColorRGB()
OMColor
TintRGB()
TintRGBWithColor()
eTintFactor
eTintType
jOmnisEffects
addRippleToElem()
setRippleColor()
Omnis Synchronisation Server User Guide
Omnis Synchronisation Server User Guide
Introduction
Selecting the Consolidated Database
Synchronisation User Groups
Synchronisation Devices
CDB Tables
Client Tables
Use of Bind Variables
Sync Cache
Synchronisation Types
Uplink only
Downlink only
Normal Synchronisation
Reload only
Uplink and Reload
None
Server-Side Replication
Handling Primary Keys
Primary Key Enforcement
Omnis Running as a Service
Using the Web Interface
Synchronising with the SyncServer
Synchronisation Initialization
Synchronisation Request
Client-side Synchronisation Tables
FAQs
Omnis App Framework
Omnis App Framework
User Guide
Setup – Android
Support Library
Add The Library To Your Project
Instantiate The Omnis Interface
Setup - iOS
Add the Framework
Stripping The Framework
Loading Forms
Loading Progress Events
Offline Forms
Implement Delegate
Custom Messaging
Photo Functionality - Android
Barcode Functionality - Android
API Reference
OmnisInterface
Statics
Properties
Methods
Features
Statics
Methods
Settings
Statics
Methods
LocalDBController
Properties
Methods
OMCommsDelegate
Methods
OMWebNavigationDelegate
Methods
ScafHandler
Properties
Static Methods
Methods
OMScafHandlerDelegate
Methods
Enumerations
OMDialogs
Static Properties
Static Methods