Classes By Category - Kirix Documentation

Developer Resources

Classes By Category Overview

The following class categories divide into classes for basic language operations, classes for creating interfaces, classes for accessing and manipulating information, and classes for interacting with the system and host application. Following is an overview of the major class categories.

Core

The Core class category contains the foundational classes and functions that are used to manipulate strings, numbers, dates, boolean values, arrays, and basic objects.

Array A class for storing lists of objects or data.
Boolean A class that represents boolean-typed data.
Date A class that represents a date and time.
Error A class for storing error-related information.
EvalError A class that represents a eval error condition.
Function A class that represents a function
JSON A class for parsing JSON and serializing objects into JSON.
Math A collection of math-related static functions.
Number A class that represents numeric-typed data.
Object A generic object class and container.
RangeError A class that represents a range error condition.
ReferenceError A class that represents a reference error condition.
RegExp A class that represents a regular expression.
String A class that represents string-typed data.
SyntaxError A class that represents a syntax error condition.
TypeError A class that represents a type error condition.
URIError A class that represents a uri error condition.

Application

The Application class category contains classes necessary for creating and interacting with user interfaces such as forms. It contains the Application class, which is responsible for starting and stopping the script event loop, which drives the user interface aspects of the program and coordinates the connection between the user's actions and the program.

Application A class that represents a script application.
Event A class that represents an event.
Timer A class for firing events at a specified interval.

Dialog

The Dialog class category contains classes for creating common dialogs typically found in applications, such as dialogs for opening or saving files, entering text or passwords, or choosing colors.

ColorDialog A class that represents a color chooser dialog.
DialogResult A class that represents a dialog result.
DirectoryDialog A class that represents a directory chooser dialog.
FileDialog A class that represents a file chooser dialog.
OpenFileDialog A class that represents a file open dialog.
PasswordEntryDialog A class that represents a password entry dialog.
ProjectFileDialog A class that represents a project file dialog.
SaveFileDialog A class that represents a file save dialog.
TextEntryDialog A class that represents a text entry dialog.

Form

The Form class category contains classes for creating top-level forms that contain other controls, as well as classes for creating and manipulating menus, toolbars, and status bars.

Form A class that represents a form on which controls can be placed.
FormControl A class that represents a base form control component from which other controls derive.
Menu A class that represents a menu.
MenuBar A class that represents a menu bar.
MenuItem A class that represents items on a menu.
StatusBar A class that represents a status bar.
StatusBarItem A class that represents an item on a statusbar.
ToolBar A class that represents a toolbar.
ToolBarItem A class that represents an item on a toolbar.

Control

The Control class category contains classes for creating controls that are added to forms, including controls such as buttons, check boxes, text entry boxes, web browsers, tree controls, and list controls.

BannerBox A class that represents a banner box control.
BitmapButton A class that represents a bitmap button control.
BorderBox A class to draw a box on a form to group controls.
Button A class that represents a button control.
CheckBox A class that represents a check box control.
ChoiceBox A class that represents a choice box control.
ComboBox A class that represents a combo box control.
Control A class that represents a control that can be placed on a form.
Label A class that represents a label control.
Line A class to draw a line on a form to separate controls.
ListBox A class that represents a list box control.
ListView A class that represents a list view control.
ListViewItem A class that represents an item in a list view control.
PictureBox A class to draw a bitmap on a form.
ProgressBar A class that represents a progress bar control.
RadioButton A class that represents a radio button control.
Slider A class that represents a slider control.
SpinBox A class that represents a spin box control.
SpinButton A class that represents a spin button control.
TextBox A class that represents a text box control.
TreeView A class that represents a tree view control.
TreeViewItem A class that represents items on a tree view control.
WebBrowser A class that represents a web browser control.

Layout

The Layout class category contains classes for automatically positioning and sizing controls that are placed on a form.

BorderBoxLayout A class that draws a box around controls that it positions and sizes automatically.
BoxLayout A class that allows controls to be positioned and sized automatically in a horizontal or vertical row.
Layout A class that allows controls to be positioned and sized automatically.

Graphics

The Graphics class category contains classes for drawing graphics on a graphics context, such as the graphics context of a form.

Bitmap A class that represents a bitmap.
Brush A class that encapsulates a brush object, which is used for drawing the background on a graphics object.
Color A class that represents a color as a combination of red, green, and blue values.
Font A class that represents a font.
Graphics A class that encapsulates drawing commands on a graphics object.
Pen A class that encapsulates a pen object, which is used for drawing the foreground on a graphics object.
Point A class that represents a location as an (x,y) pair.
Size A class that represents a size as a (width,height) pair.

Input/Output

The Input/Output class category contains classes for inputting and outputting values to files in text or binary formats.

Directory A class that provides information about directories.
DriveInfo A class that provides information about drives/volumes
File A class that exposes functions which allow access to files.
FileInfo A class that provides information about a file.
FileStream A class that provides functionality to access binary files.
Log A class that provides logging functionality.
MemoryBuffer A class that encapsulates read/write operations to the memory.
TextReader A class that provides functionality to read text files.
TextWriter A class that provides functionality to write to text files.

XML

The XML class category contains a class for accessing information in XML files.

XmlNode A class that represents an XML data structure, allowing read/write access to XML files.

Document Object Model (DOM)

The Document Object Model class category contains classes for accessing and manipulating the DOM of a web control.

WebDOMAttr A class that represents a DOM attribute node.
WebDOMDocument A class that represents a DOM document.
WebDOMElement A class that represents a DOM element.
WebDOMHTMLAnchorElement A class that represents an HTML anchor element.
WebDOMHTMLButtonElement A class that represents an HTML button element.
WebDOMHTMLElement A class that represents a DOM html element.
WebDOMHTMLInputElement A class that represents an HTML input element.
WebDOMHTMLLinkElement A class that represents an HTML link element.
WebDOMHTMLOptionElement A class that represents an HTML option element.
WebDOMHTMLParamElement A class that represents an HTML param element.
WebDOMHTMLSelectElement A class that represents an HTML select element.
WebDOMHTMLTextAreaElement A class that represents an HTML text area element.
WebDOMNode A class that represents a DOM node.
WebDOMText A class that represents a DOM text node.

Network

The Network class category contains classes for accessing information on web servers using HTTP or on FTP servers using FTP or SFTP.

FileTransfer A class for communicating via FTP and SFTP.
HttpRequest A class for issuing HTTP requests and processing the results.

Database

The Database class category contains classes for connecting to databases, such as Oracle, MySQL or Kirix Strata's database, and interacting with the data inside the database. With classes in this category, you can connect to databases, create tables, perform queries on the data, such as queries to select data from tables, insert new records into tables, delete records, as well as perform other standard database operations.

DbBulkInsert A class that provides the ability to insert many rows into database tables quickly.
DbColumn A class that provides information about a column.
DbConnection A class that manages a database connection to a local or remote database.
DbEncoding A class that provides an enumeration of database encoding types.
DbError A class that describes a database error condition
DbException An class whose objects are thrown when database errors occur
DbObjectInfo A class that provides information about a database object.
DbResult A class that manages results from a database query operation.
DbType A class that provides an enumeration of database field types.

Encryption

The Encryption class category contains classes for encrypting and decrypting strings.

Hash A class that provides hashing routines.
SymmetricCrypt A class that provides symmetric encryption routines.

System

The System class category contains classes for interacting with the computer on which the script is running. With classes in this category, you can find out information about system settings, such as system metrics, fonts, and colors, or load and access shared libraries, such as DLLs, SOs, and DYLIBs.

Environment A class that provides information about the computer and execution environment.
NativeModule A class that provides the ability to load and access shared libraries such as DLLs, SOs, and DYLIBs.
Process A class that provides access to a system process
ProcessOutputStream Provides access to the output of processes
System A class that provides system utility functions.
SystemColors A class that provides access to system colors.
SystemFonts A class that provides access to system fonts.
SystemMetrics A class that provides access to system metrics.

Host Application

The Host Application class category contains classes for interacting with the application on which the script is running. For example, if a Script is running inside Strata, you can use these classes to add items to Strata's menus, add dockable forms to Strata's interface, manipulate Strata's documents, and more.

Console A class that provides a mechanism to control what is displayed in the application's output console.
Extension A class that provides information about and access to extensions.
HostApp A class that provides a mechanism of communicating with the script's host application.
HostDocument A class that exposes method calls to manipulate document windows.
HostPreferences A class that provides a mechanism to store application preferences.