Alphabetical index of custom XojoScript commands

 

Name

Description

AbortDelete  (Integer)

Cancel a delete action from the "Delete Record Script"

AbortDelete (String)

Cancel a delete action from the "Delete Record Script"

AbortInsert (Integer)

Cancel a insert action from the "Insert Record Script"

AbortInsert (String)

Cancel a insert action from the "Insert Record Script"

AbortSave (Integer)

Cancel a save action from the "Registration Save Script"

AbortSave (String)

Cancel a save action from the "Registration Save Script"

AbortUpdate (Integer)

Cancel a update action from the "Update Record Script"

AbortUpdate (String)

Cancel a update action from the "Update Record Script"

ComboBoxAddRow

Appends an item in a new row to the end of the list of a combobox

ComboBoxAddRows

Appends the elements of an array to the the list of a combobox

ComboBoxDeleteAllRows

Deletes all rows in the list of a combobox.

ComboBoxGetRowTag

Returns a hidden text of the currently selected combobox-item

DoScript

Runs an AppleScript on OSX

EOL

Returns an end-of-line terminator character for the current platform (OSX)

EditDeleteScript

Edit the XojoScript, which runs before a record is going to be deleted

EditInsertScript

Edit the XojoScript, which runs before a database-record gets inserted

EditScriptRegistrationEdit

Opens the Script Manager and loads the Registration Start script for editing

EditScriptRegistrationSave

Opens the Script Manager and loads the Registration Save script for editing

EditStartupScript

Edit the XojoScript, which runs once after the application has been started

EditUpdateScript

Edit the XojoScript, which runs before a database-record gets updated

EmailOpen (11 Parameters)

Opens an email client window for composing and sending an Email

EmailOpen (6 Parameters)

Opens an email client window for composing and sending an Email

EmailOpen (7 Parameters)

Opens an email client window for composing and sending an Email

EmailOpen (JSON)

Opens an email client window for composing and sending an Email

EndOfField

Returns the field delimiter string {*FLD*} of a custom listbox record

EndOfRecord

Returns the record delimiter string {*REC*} of a custom listbox row

ExcelGetVersion

Returns CFBundleVersion of Microsoft Excel as a String.

ExcelLaunch

Launches Microsoft Excel

FileAddToFilebox

Adds a file to a filebox

FileLaunch

Opens a file in its default application

FileNew

Creates a new as a copy of a template file

GetActiveLinking

Returns the modul name of the currently active registration

GetActiveModul

Returns the name of the currently frontmost modul in the databox

GetAddressLabels

Returns the mailing labels of the selected addresses

GetAddressListColumnCount

Returns the current number of columns of the addresses listbox

GetAddressListRecord

Returns the fields of the indicated row of the addresses listbox

GetAddressListRecordCount

Returns the number of rows in the addresses listbox

GetCurrentID

Returns the ID of the last record, loaded in detail view of the databox

GetDataBoxSQL

Returns the last SQL statement from the databox

GetDateLocalized

Returns the localized date in short format

GetDecision

Shows a dialog window asking for user's decision

GetFilePath

Loads a file from a filebox and return the path to it

GetFileTemplateText

Loads a textfile from the templates folder and return its contents

GetFileText

Loads a text file from a filebox and return its contents

GetFolderItemText

Returns the contents of a textfile

GetInput

Shows a dialogbox to ask user for input

GetInvoiceNumber

Returns year plus counter as a new invoice number, like "2018-53"

GetLinkedDataBoxSQL

Returns the last SQL statement of LinkedDataBox

GetOpenFolderItemPath

Opens a dialog window to select a file and returns the path to the file

GetOpenFolderItemText

Opens a dialog window to select a textfile and returns its contents

GetPanel

Retrieves the name of the currently active panel of a PanelBox

GetPanelNum

Returns the index of the currently active panel of a PanelBox

GetPrefix

Returns the currently used tablename prefix (leading characters)

GetProperty

Retrieves the String value of a property, set in the properties manager

GetPropertyBool

Retrieves the Boolean value of a property, set in the properties manager

GetPropertyDouble

Retrieves the Double value of a property, set in the properties manager

GetPropertyInt

Retrieves the Integer value of a property, set in the properties manager

GetSQLDate

Returns a string in SQL date format YYY-MM-DD

GetSafeSQL

Returns a string with all single-quote characters ' doubled

GetTag

Check if a specific Tag is attributed to an address

GetText

Retrieves the text contents of a control

GetText (with record ID)

Retrieves the text contents of a control for a specific record

htmlConnection

Prepares a connection to a webservice, in order to send or request data

htmlConnectionClose

Close a connection to a webservice and free up memory resources

htmlBasicAuthentication

Set credentials before connection to a webservice

htmlRequestHeader

Set request header of a http request, with key and value

htmlRequestContent

Set data to be sent to a webservice

htmlSendSync

Send a request using an HTTP method such as GET or POST

IDArrayOfSelectedAddresses

Returns the IDs of selected addresses in the addresses listbox

IDArrayOfSelectedRecords

Returns the IDs of selected records in the listbox of the active modul

IsEditMode

Checks if the user currently is editing an existing record

IsInsertMode

Checks if the user currently is inserting a new record

IsLinkMode

Checks if the user is inserting or editing a registration in WindowLink

JsonAppend

Append a new JSONItem object to an array of JSONItems

JsonClearAll

Remove any JSONItem object previously created by JSONCreate

JsonCreate

Creates a new JSON object and returns a pointer to it

JsonCreateFromString

Creates a new JSON object and returns a pointer to it

JsonGetGoogleLatitude

Get Latitude of an address from Google Geocoding

JsonGetGoogleLongitude

Get Longitude of an address from Google Geocoding

JsonGetValueRecursive

Find the value for a specific name within a json object

JsonGetValue

Retrieves the String value of a JSON child element

JsonGetValueBoolean

Retrieves the Boolean value of a JSON child element

JsonGetValueDouble

Retrieves the Double value of a JSON child element

JsonGetValueInteger

Retrieves the Integer value of a JSON child element

JsonSetValue

Adds a JSON child element of type String to an existing JSON object

JsonSetValueBoolean

Adds a JSON child element of type Boolean to an existing JSON object

JsonSetValueDouble

Adds a JSON child element of type Double to an existing JSON object

JsonSetValueInteger

Adds a JSON child element of type Integer to an existing JSON object

JsonToString

Converts a JSON object to its string representation

LinkList_GetID

Returns the ID of the first selected record in WindowLink

ListAddRow

Adds a new row to a listbox

ListColumnAlignment

Sets the alignment of a listbox column

ListColumnAlignmentOffset

Sets the offset of a decimal-point-aligned listbox column

ListColumnCount (Get)

Gets the number of columns of a listbox

ListColumnCount (Set)

Sets the number of columns of a listbox

ListColumnType

Sets the type for a column of a listbox

ListCount

Gets the number of rows of a listbox

ListCount (Handle)

Gets the number of rows of a listbox

ListDeleteAllRows

Removes all rows from a listbox

ListExportAsExcel

Saves the contents of a listbox as an Excel file

ListExportAsTabDelimitedText

Saves the contents of a listbox as a tabulator delimited text file

ListGetCell

Gets the contents of a cell of a listbox

ListGetCell (Handle)

Gets the contents of a cell of a listbox

ListGetHandle

Gets a handle (pointer) to a listbox

ListGetJSON

Retrieves the contents of a listbox into an Array-like JSON String

ListIndex

Gets the selected row number of a listbox

ListIndex (Handle)

Gets the selected row number of a listbox

ListRemoveRow

Deletes the specified row of a listbox

ListSetCell

Write to a cell of a listbox

ListSetJSON

Fills a listbox with the contents of an Array-like JSON String

MsgBox

Displays a message to the user with an OK button

MsgBox (with buttons)

Displays a message to the user with custom reply buttons

PdfAddToFilebox

Adds a pdf file to a filebox

PdfAppend

Adds a new page to a pdf file

PdfChangeFontSize

Changes the size of the current font in a pdf object

PdfCloseFile

Finishes the PDF file and frees all used resources

PdfEndPage

Finishes a PDF page

PdfFontAvailable

Tests whether a specific font is installed

PdfGetTextWidth

Gets width of a text in points

PdfImportAsTemplate

Imports a pdf file from the templates folder and sets it as background

PdfInsertPicture

Inserts a picture from the templates folder on a pdf page

PdfLaunch

Opens a newly generated pdf file in the default viewer

PdfLineDraw

Draws a line on a pdf file

PdfMoveTo

Moves the current drawing position to a point (x, y)

PdfOptimize

Optimizes PDF file

PdfRectangle

Draw a rectangle

PdfSetFillColor

Defines the fill color

PdfSetFont

Loads a font to be used for text output

PdfSetLineWidth

Sets the line width used to stroke paths

PdfSetPageCoordsBottomUp

Sets the coordinate system of a pdf page with 0 at lower edge of a page

PdfSetPageCoordsTopDown

Sets the coordinate system of a pdf page with 0 at upper edge of a page

PdfSetPageFormat

Sets a predefined page or paper format

PdfSetStrokeColor

Sets the line color

PdfSetTextRect

Defines the output rectangle to output formatted text to

PdfStart

Creates a new PDF file and appends a first empty page

PdfStartFromTemplate

Creates a new PDF file, with the first page based on a pdf template

PdfTableAddRow

Adds a row to a table in a pdf file

PdfTableAddRows

Adds rows of a given height to a table in a pdf file

PdfTableCreate

Creates a new pdf table object

PdfTableDraw

Draws the table at the given position into the pdf object

PdfTableGetFirstRow

Queries first row from last draw operation

PdfTableGetHeigth

Returns the full height of the table

PdfTableGetNextRow

Queries the next row of the last draw operation

PdfTableGetWidth

Returns the full width of the table

PdfTableHaveMore

Checks whether there are more rows to draw

PdfTableSetBorderWidth

Sets the border width of a table, a row or cells

PdfTableSetCellPadding

Sets the cell padding of a table, a row or cells

PdfTableSetCellSpacing

Sets the cell spacing (space between cells) of a table, a row or cells

PdfTableSetCellText

Sets the text of a cell

PdfTableSetColumnWidth

Sets the width of a table column

PdfTableSetFlags

Sets the flags for a cell (for instance to define a header row)

PdfTableSetFont

Sets the font that is used to output text to a table

PdfTableSetGridWidth

Sets the inner grid width of the table

PdfTableSetPdf

Sets the target PDF for a table

PdfWebLink

Inserts a web link onto the current open pdf page

PdfWriteFText

Write text into an existing pdf object

PdfWriteFTextEx

Write multi-line text into an existing pdf object

PdfWriteText

Write single-line text into an existing pdf object

PopupAddRow

Appends a new item at the end of the list of a popup control

PopupDeleteAllRows

Removes all entries from the list of a popup control

PrintLabel

Displays the Print dialog box to print labels

PrintLinkedLabel

Displays the Print dialog box to print labels of linked addresses

ProgressDialogShow

Display progress about a recurring activity to the user

ProgressDialogSetText

Set counter of current activity of progress dialog window

ProgressDialogClose

Close previously opened progress dialog window

RunScript

Runs a specific XojoScript, identified by guid

SQLExecute

Sends an SQL command to the database

SQLSelect

Returns the result of an SQL query to the database

Say

Uses the built-in speech synthesizer to pronounce a text string

SendSms

Display a dialog window to collect sender name and sms text

SetClipboardText

Sets the clipboard to a text

SetFocus

Sets the focus to a specific control

SetPanel

Sets the currently selected page of PanelBox

SetProperty

Sets the String value of a property in the properties manager

SetPropertyBool

Sets the Boolean value of a property in the properties manager

SetPropertyDouble

Sets the Double value of a property in the properties manager

SetPropertyInt

Sets the Integer value of a property in the properties manager

SetQuickLook

Shows a preview of a file from a filebox on a quicklook control

SetText

Sets the contents of a control

ShowURL

Uses the default application to open the specified URL

ShowWindowSQL

Executes an sql SELECT statement and displays the resulting list

UrlEncode

Encodes the components of a URL

WordGetInfo

Returns the value of the passed in key for Microsoft Word

WordGetPath

Returns the path to Microsoft Word

WordGetVersion

Returns CFBundleVersion of Microsoft Word

WordLaunch

Launches Microsoft Word

XL

Launches Microsoft Excel and loads the current Excel sheet

XLAddFont

Adds a font to a Excel document and defines the font size

XLAddFormat

Adds a format object to a Excel document

XLCreateFromTemplate

Creates a new Excel file as a copy of the specified Excel file

XLFontSetColor

Sets the color of a font used in an Excel file

XLFormatSetAlign

Sets the vertical or horizontal alignment of cell contents

XLFormatSetBorderBottom

Sets the style of the bottom border of a cell

XLFormatSetBorderLeft

Sets the style of the left border of a cell

XLFormatSetBorderRight

Sets the style of the right border of a cell

XLFormatSetBorderTop

Sets the style of the top border of a cell

XLFormatSetFillPattern

Sets the fill pattern of a cell

XLFormatSetFont

Assign a font to a format in an Excel sheet

XLFormatSetNumFormat

Sets the format of a number in a cell

XLFormatSetPatternColor

Sets the foreground or background color of the fill pattern of a cell

XLSave

Saves all changes to an Excel document

XLSetColWidth

Sets the column width

XLSetDefaultFont

Sets a default font and size for the workbook of an Excel document

XLSetPrintArea

Sets the PrintArea on the first sheet and workbook of an Excel file

XLSetRowHeight

Sets the row height

XLWriteBlank

Writes blank cell with optionally specified format

XLWriteBoolean

Writes a Boolean value into a cell with an optionally specified format

XLWriteFormula

Writes a Formula into a cell

XLWriteNumber

Writes a Number or Date value into a cell with an optional format

XLWriteString

Writes a String value into a cell with an optionally specified format