JavaScript

UX Component Methods

IN THIS PAGE

Description

list and methods that can be used on the client-side to interact with UX components.

 Placeholders

Placeholders are dynamic objects that can be used JavaScript code to reference objects that are defined by the Application Server.

Placeholder
Description
{dialog.ComponentName}

Gets replaced with the alias of the UX Component. For example, if the UX alias is 'DLG1', then is replaced with 'DLG1'.

{dialog.ControlIdEscaped}

The control Id of the control. Special characters in the id are Javascript escaped. You must use this placeholder (and not {dialog.ControlId}) if you want to use this placeholder in a selector (such as JQuery - jQuery('#{dialog.controlIDEscaped}') )

{dialog.ControlId}

The control Id of the control. Note: See comment on {dialog.ControlIDEscaped}.

{dialog.EmbeddedCustomComponent_[Alias]}

Used to get the Object name of an embedded Custom Component. Replace [Alias] with the alias you specified for the embedded Custom Component object. You can use this placeholder to execute methods on the embedded Custom Component.

{dialog.EmbeddedDUX_[UXAlias]}

Used to get the Object name of an embedded UX Component. Replace [UXAlias] with the alias you specified for the embedded UX object. You can use this placeholder to execute methods on the embedded UX.

{dialog.EmbeddedGrid_[GridAlias]}

Used to get the Object name of an embedded Grid Component. Replace [GridAlias] with the alias you specified for the embedded Grid object. You can use this placeholder to execute methods on the embedded Grid.

{dialog.listId}

For use with the List control. Gets replaced with the ID of the current List control.

{dialog.object}

Gets replaced with the name of the Javascript UX Component Object. For example, if the UX alias is 'DLG1', then is replaced with 'DLG1_DlgObj'. Use this placeholder when you want to call a method of the UX Object. e.g. {Dialog.Object}.submit(), to submit the UX to the server.

{dialog.Style}

Gets replaced with the style name of the UX. For example, if the style is 'GlassOlive', then gets replaced with 'GlassOlive'.

Properties

_dataSeriesDataObject

Object containing data series that have been published to the client. See the Publish data to client-side UX Component property to learn more. Has the following properties:

<SeriesName>ObjectArray

Contains the data in a series. Replace <SeriesName> with the name of the series. E.g. {dialog.object}._dataSeriesData.Names. If the series does not have a named subseries, the object will be an array. Otherwise, <SeriesName> will contain one or more subseries properties containing the data in the series:

<SubSeries1>String

A CR-LF delimited string of values for a data series sub-series. Replace <SubSeries1> with the name of the subseries. E.g. {dialog.object}._dataSeriesData.Names.Firstname

<SubSeriesN>String

One or more additional properties containing a CR-LF delimited string of values for a data series sub-series. Replace <SubSeriesN> with the name of the subseries. E.g. {dialog.object}._dataSeriesData.Names.Lastname

_localStorageSettingsObject

Local storage settings for the UX Component.

dialogIdString

The UX Component name. Equivalent to {dialog.componentName}. Prefer to use {dialog.componentName}.

stateInfoObject

A JSON object containing state information. Can be used to read and set state information for the component. See also getStateInfo() and setStateInfo().

Methods

{dialog.object}._delayTillPhoneGapReady Method

Registers a function to call when PhoneGap is loaded and ready.

{dialog.object}._filterList Method

Performs a server-side query to filter and/or sort the data in a List that is based on a SQL, DBF, or custom data source.

{dialog.object}._findRepeatingSection Method

Returns the name of the Repeating Section container in which a particular control is to be found.

{dialog.object}._fixAllRepeatingSectionHeaders Method

Aligns all Repeating Section column titles. Used in cases where a Repeating Section is hidden unless shown via Javascript.

{dialog.object}._getDirtyLists Method

Returns an array of the Lists that are dirty.

{dialog.object}._getListForDetailViewControl Method

Returns the name of the List control for the specified column name if the column is referenced in a Detail View.

{dialog.object}._getOnlineStatus Method

Returns true if the device has an internet connection. Returns false if there is no connection.

{dialog.object}._getRepeatingSectionRowCount Method

Gets the number of rows in a repeating section.

{dialog.object}._hasDirtyLists Method

Returns true if any List on the UX is dirty.

{dialog.object}._isControlInDetailView Method

Returns true if the colName is inside the Detail View of any List on the UX.

{dialog.object}._listFetchMore Method

Gets the next 'page' of data in a List that has been configured to use 'Fetch More' pagination.

{dialog.object}._listFetchRecordsByKey Method

Appends records to the end of the list.

{dialog.object}._listGetElement Method

Gets a pointer to an individual control in a List row, allowing you to manipulate its properties using Javascript.

{dialog.object}._listMoveAllRows Method

Moves all rows from one List control to another List control.

{dialog.object}._listMoveCurrentSelection Method

Moves selected rows from one List control to another List control.

{dialog.object}._listNavigate Method

Navigates to the next/previous 'page' of data in a List that has been configured to use pagination. List must be configured as paginated.

{dialog.object}._listNavigateRecord Method

Navigates by record in the specified direction: first, previous, next, or last.

{dialog.object}._listNavigateToPage Method

Navigates to an explicit page number. (List must be configured as paginated.)

{dialog.object}._listRefreshCascadingLists Method

Refreshes the data in child List controls that are dependent on the data in this List control.

{dialog.object}._listRefreshRecordsByKey Method

Refreshes the data in the List for the specified records.

{dialog.object}._listRefreshRow Method

Refreshes the data in the current row of a List control.

{dialog.object}._listRemoveAllRows Method

Removes all rows from a List control.

{dialog.object}._listRemoveSelectedRows Method

Removes the currently selected row(s) from a List control.

{dialog.object}._listShiftPositionSelectedRows Method

Reorders the items in a List by shifting the selected rows in the specified direction.

{dialog.object}._ls_deleteKeys Method

Deletes data for the specified keys from Local Storage.

{dialog.object}._ls_getData Method

Returns an object with information about keys stored in Local Storage.

{dialog.object}._persistFolder Method

Gets the sub-folder in which the files are actually stored. Returned folderName includes a trailing / character.

{dialog.object}._persistFS Method

Gets the file system URL of the directory in which the List data sub-directory is located.

{dialog.object}._persistToLocalStorageInitializeKeys Method

Use to delete persisted List data (including edits) from Local Storage or the File System (PhoneGap applications.)

{dialog.object}._populateSourceComponent Method

Set the value of controls in the calling Grid or Dialog component to the value of the mapped controls in the current Dialog.

{dialog.object}._prepareRepeatingSection Method

This command will fix the column titles.

{dialog.object}._primaryKeyListSetKey Method

Sets the active row in the Primary key Control to the specified primary key value.

{dialog.object}._refreshListData Method

Refreshes the data in a List control.

{dialog.object}._repeatingSectionLogicalToPhysicalRow Method

Returns the physical row number for given logical row number in a specified Repeating Section.

{dialog.object}._restoreVariablesFromLocalStorage Method

Restores persisted variables stored in Local Storage to the UX Component.

{dialog.object}._setRepeatingSectionRowCount Method

Sets the number of rows in a repeating section.

{dialog.object}._setSimulatedOnlineStatus Method

Allows you to simulate offline behavior of you component event when you have a connection.

{dialog.object}._tabInfo Method

Returns Javascript object with info about the tab control.

{dialog.object}._updateAjaxURL Method

Updates the Ajax Callback URL for a PhoneGap application.

{dialog.object}.accordionControl Method

Either opens or closes all panes in an accordion object.

{dialog.object}.actionSheet Method

Displays an Action Sheet.

{dialog.object}.activateControlContainer Method

If a control is inside a Tab or Accordion container, activates the pane in which the control in contained. This method will also activate the PanelCard in which the control has been placed.

{dialog.object}.addRepeatingSectionRow Method

Adds a new row to the specified Repeating Section.

{dialog.object}.ajaxCallback Method

Does an Ajax callback to a server.

{dialog.object}.ajaxCallbackCrossDomain Method

Performs a cross-domain Ajax callback.

{dialog.object}.argumentValue Method

Get the value of an argument that was passed to the UX component.

{dialog.object}.buttonClick Method

Executes the click event for a Button.

{dialog.object}.clearLoginErrors Method

Clears login errors that are displayed in the 'login error placeholder' (specified in the UX Component integrated login properties).

{dialog.object}.clientSideValidateField Method

Executes client-side validation for a control in the UX Component.

{dialog.object}.closeContainerWindow Method

If the Dialog is opened inside a pop-up Javascript window, closes the window in which the Dialog is contained. Need to pass in a pointer to any element on the Dialog.

{dialog.object}.closeCurrentTabbedUIPane Method

If the Dialog was opened in a Tabbed UI Pane, closes the current pane in the Tabbed UI.

{dialog.object}.closeWindow Method

Closes a window.

{dialog.object}.copyRepeatingSectionRow Method

Copies the values from one row in a Repeating Section to another.

{dialog.object}.countRecordsToSynch Method

Returns an object with properties showing the number of records that have not yet been synchronized with the server.

{dialog.object}.customSetting Method

Get or Set the value of a custom setting.

{dialog.object}.debugInfoToFile Method

Writes client-side data to a file on the server.

{dialog.object}.debugInfoToS3 Method

Writes client-side data to a file stored in an Amazon S3 bucket.

{dialog.object}.deleteRecord Method

Deletes the current record in the 'primary' table. Applies only to a component that has been bound to one or more tables.

{dialog.object}.deleteRepeatingSectionRow Method

Removes the current row from the specified Repeating Section.

{dialog.object}.destroyChildComponent Method

Can be used to delete child UX components from memory.

{dialog.object}.dropDownMessage Method

Shows a dropdown message.

{dialog.object}.dropDownMessageHide Method

Hides a dropdown message.

{dialog.object}.duplicateRepeatingSectionRow Method

Copies the values in the current Repeating Section row to a new row.

{dialog.object}.editorCancel Method

Closes an EditorSet without committing any unsaved edits.

{dialog.object}.editorCommit Method

Commits the change made in the Editor to the value you are editing.

{dialog.object}.editorFromControl Method

Displays an EditorSet showing the specified Editor in the EditorSet to edit the value in the specified UX control. Contrast with the .editorFromValue() method which is used to edit an arbitrary value.

{dialog.object}.editorFromValue Method

Displays an EditorSet showing the specified Editor in the EditorSet to edit an arbitrary value. Contrast with the .editorFromControl() method which is used to edit a value in a UX control.

{dialog.object}.exportChart Method

Exports one or more charts to a PDF or RTF file and then downloads the file to the client computer.

{dialog.object}.fireLayoutRule Method

Executes the actions for a Responsive Layout rule, ignoring whether or not the rule evaluates to a true result.

{dialog.object}.formViewClearErrors Method

Clears any errors shown on the FormView control.

{dialog.object}.formViewCommit Method

Commits the data in the FormView control back to the data source.

{dialog.object}.formViewData Method

Populates a FormView control with data in a dataObject.

{dialog.object}.formViewGetState Method

Gets the FormView state object and stores it in a variable.

{dialog.object}.formViewGetViewBox Method

Gets a pointer to the ViewBox control used in the FormView control.

{dialog.object}.formViewInvokeEditor Method

Opens the editor for a field, even if the field is not visible in the current FormView.

{dialog.object}.formViewIsDirty Method

Returns true if the FormView controls is dirty (i.e. has edits that have not been commited back to the data source);

{dialog.object}.formViewNavigate Method

Sets focus to a field in the FormView (and opens the Editor - if defined - for the target field.)

{dialog.object}.formViewNewRecord Method

Displays a new record in the FormView control.

{dialog.object}.formViewRefresh Method

Repopulates the Form View with data from the FormView's data source.

{dialog.object}.formViewRow Method

Gets or sets the logical 'row' property of the FormView control.

{dialog.object}.formViewSetLayout Method

Displays the specified layout. (Assumes that when the FormView was defined, multiple layouts were defined).

{dialog.object}.formViewSetStateVariables Method

Sets FormView state variables.

{dialog.object}.formViewUpdate Method

Sets the value in one or more FormView controls.

{dialog.object}.formViewValidate Method

Validates the data in FormView by evaluating the validation function for each field.

{dialog.object}.frameOpenStateChange Method

Sets the open or closed state of a modern frame.

{dialog.object}.getChildObject Method

Returns a pointer to the child component.

{dialog.object}.getConnectionType Method

Returns the type of connection the device has. (May not return reliable information if not running in a PhoneGap shell).

{dialog.object}.getControl Method

Get a pointer to a control to call methods of an object, or set properties of an object.

{dialog.object}.getCurrentEditorSettings Method

Gets the 'settings' object for the currently open Editor. If no Editor is open, returns false;

{dialog.object}.getData Method

Gets the value of all of the controls in the UX Component in the form of a query string (name/value pairs).

{dialog.object}.getDateValue Method

Get the valuel of a control in the UX Component as a JavaScript Date object.

{dialog.object}.getFromDataCache Method

Reads an item in the client-side data cache. Makes an ajax callback to the server to download the data if it isn't already in the cache.

{dialog.object}.getInstanceNumber Method

If a control is in a Repeating Section, returns the row number (i.e. instance number) of the active row in the Repeating Section. Otherwise returns a blank value.

{dialog.object}.getKey Method

Gets the primary key value for the specified table alias.

{dialog.object}.getListClientSideSummaryValue Method

If the List definition specified that client-side summary values should be computed for any of the fields in the list, retrieves the summary value.

{dialog.object}.getListData Method

Gets a Javascript array (as an array of objects) with all of the data in the specified List control.

{dialog.object}.getListServerSideSummaryValue Method

If the List definition specified that server-side summary values should be computed for any of the fields in the list, retrieves the summary value.

{dialog.object}.getOrientation Method

Returns the device's orientation.

{dialog.object}.getPanelObject Method

If the UX component use Panels, gets a pointer to the Panel object. Once you have a pointer to the Panel Object you can call methods of the Panel Object (such as .getState() and .setState()).

{dialog.object}.getParentObject Method

If this component is opened from a parent Grid or Dialog component, this returns a pointer to the parent object so you can execute methods on the parent object.

{dialog.object}.getPointer Method

Get a pointer to the DOM element for a UX component control.

{dialog.object}.getRepeatingSectionActiveRow Method

Gets the active row in the specified Repeating Section.

{dialog.object}.getSessionVariable Method

Get the value of a session variable.

{dialog.object}.getSize Method

Gets information about the screen size and orientation.

{dialog.object}.getStateInfo Method

Get all of the state variable information for the UX component.

{dialog.object}.getStripeResults Method

Returns a Stripe charge JSON object or an error after a Stripe transaction has been performed using the Process Stripe Payment Action Javascript.

{dialog.object}.getTopParentObject Method

Returns a pointer to the top most parent object.

{dialog.object}.getValue Method

Get the value of a control in the UX Component.

{dialog.object}.getWindow Method

Get a poiner to a window.

{dialog.object}.harvestRepeatingSectionColumn Method

Retrieves the data from a column in a Repeating Section and return a delimited string of values. The default for delimiter is comma.

{dialog.object}.hideContainerWindow Method

Hides a window defined by a 'container' control whose sub-type is 'window'. The controls in the 'window' container are the contents of the window.

{dialog.object}.hideRepeatingSectionColumn Method

Hide/show a column in a Repeating Section.

{dialog.object}.hideWaitMessage Method

If no argument is passed in, all open wait messages are hidden. If you pass in an argument, the specified wait message is hidden.

{dialog.object}.httpFetch Method

Fetches data from a specified URL.

{dialog.object}.imageIsEmpty Method

Returns true if an image control is empty.

{dialog.object}.inkIsEmpty Method

Returns true if an Ink control is empty.

{dialog.object}.instantUpdateCheckForUpdate Method

Checks for updates for a PhoneGap app with Instant Update.

{dialog.object}.instantUpdateRefresh Method

Checks for, downloads, and installs a new update for a PhoneGap application with Instant Update.

{dialog.object}.instantUpdateUseAutoUpdate Method

Enables or disables automatically checking for updates in a PhoneGap app that includes Instant Update.

{dialog.object}.jsChartRedraw Method

Redraws a Javascript chart.

{dialog.object}.jsChartRefreshData Method

Refreshes the data in Data Series that the Chart uses and then redraws the Chart.

{dialog.object}.jsChartResize Method

Resizes a Javascript chart.

{dialog.object}.jsChartSetProperties Method

Change the properties of the Javascript Chart.

{dialog.object}.listGetValue Method

Get the value of a column in a List control.

{dialog.object}.loadCSSFile Method

Loads CSS from a file.

{dialog.object}.loadDataFromRepository Method

Loads data that was previously saved to the Repository.

{dialog.object}.loadJavascriptFile Method

Loads an external JavaScript file.

{dialog.object}.loggedInUserNameFriendly Method

Gets the friendly logged in user name (only applies if the user logged in using the AppLauncher or integrated login in the UX component).

{dialog.object}.login Method

Logs a user in. The UX component must have been configured to have integrated login functionality and the Web Project must have been configured to have security.

{dialog.object}.logout Method

Logs a user out. The user must have logged in using this UX component (with integrated login functionality turned on), or must have logged in using the AppLauncher component.

{dialog.object}.moveDownRepeatingSectionRow Method

Moves the data in the current Repeating Section row down one row.

{dialog.object}.moveUpRepeatingSectionRow Method

Moves the data in the current Repeating Section row up one row.

{dialog.object}.newRecord Method

Changes the current 'mode' from editing an existing record to entering a new record.

{dialog.object}.onTimerEventStart Method

Causes the onTimer client-side event to start firing automatically every n seconds as specified by the interval (in milliseconds).

{dialog.object}.onTimerEventStop Method

Turns off the onTimer event.

{dialog.object}.openLookup Method

Opens the lookup Grid for a particular field.

{dialog.object}.panelGet Method

Gets a pointer to a Panel.

{dialog.object}.panelGetActive Method

Gets the name of the active Panel.

{dialog.object}.panelGetId Method

Gets the ID of the specified 'part' of a Panel.

{dialog.object}.panelHeight Method

Returns the height of the Panel body in pixels.

{dialog.object}.panelNavigate Method

Navigates to the next or previous Panel in a Panel Navigator

{dialog.object}.panelSetActive Method

Sets focus to a particular Panel. Press the control-down key or click to select Panel name in a UX component.

{dialog.object}.panelWidth Method

Returns the width of the Panel body in pixels.

{dialog.object}.persistListToLocalStorage Method

Manually persist List data and state to Local Storage (assuming the List properties have been set to allow persistence to Local Storage). Normally this method is not needed because the List is automatically persisted to Local Storage any time the List contents is changed (by adding, deleting or editing data in the List).

{dialog.object}.persistVariablesToLocalStorage Method

Manually persist List data and state to Local Storage (assuming the List properties have been set to allow persistence to Local Storage). Normally this method is not needed because the List is automatically persisted to Local Storage any time the List contents is changed (by adding, deleting or editing data in the List).

{dialog.object}.phoneGapCopyFileURL Method

Copies a file from one location to another on the file system.

{dialog.object}.phoneGapCreateDirectory Method

Create a directory in the file system of the mobile device.

{dialog.object}.phoneGapCreateDirectoryRecurse Method

Create directories recursively in the file system of the mobile device.

{dialog.object}.phoneGapCreateFile Method

Creates a file in the file system of the mobile device.

{dialog.object}.phoneGapDeleteFile Method

Deletes a file in the file system of the mobile device.

{dialog.object}.phoneGapDeleteFilesNotInListURL Method

Deletes files from a directory. If a filter is specified, only files that match the filter are deleted. If a 'keep list' is specified, files in the list are not deleted, even if they match the filter.

{dialog.object}.phoneGapDeleteFileURL Method

Delete a file.

{dialog.object}.phoneGapDownloadManifestFiles Method

Download files to a device.

{dialog.object}.phoneGapEnsureDirPathURL Method

Ensures a directory structure exists within the specified rootpath. If the directories do not exist, they are created.

{dialog.object}.phoneGapFileExists Method

Checks if a file exists in the file system of the mobile device.

{dialog.object}.phoneGapFileExistsURL Method

Check if a file exists. If the file does exist, a callback function is called with the properties of the file (such as size, date last modified, etc.)

{dialog.object}.phoneGapFilesAvailable Method

Checks whether or not the local file system is available in a PhoneGap application.

{dialog.object}.phoneGapGetDirectory Method

Gets a list of files in a directory in the file system of the mobile device.

{dialog.object}.phoneGapGetDirectoryRecurse Method

Gets a list of files in a directory in the file system of the mobile device.

{dialog.object}.phoneGapGetLocalDirURL Method

Returns URL of base for the requested part of the file system.

{dialog.object}.phoneGapListFilesRecurseURL Method

List files in a directory and in the sub-directories of the specified directory.

{dialog.object}.phoneGapListFilesURL Method

Lists files in a directory. If a filter, defined with a regular expression, is specified, only files that match the filter are listed.

{dialog.object}.phoneGapLoaded Method

Returns true if the UX component is running in a PhoneGap shell.

{dialog.object}.phoneGapMoveFileURL Method

Move a file.

{dialog.object}.phoneGapReadFile Method

Reads the contents of a text file in the file system of the mobile device.

{dialog.object}.phoneGapReadFileURL Method

Reads a file.

{dialog.object}.phoneGapRemoveDirectory Method

Deletes a directory in the file system of the mobile device.

{dialog.object}.phoneGapRemoveDirectoryRecurse Method

Removes directories recursively in the file system of the mobile device.

{dialog.object}.phoneGapRemoveDirectoryRecurseURL Method

Deletes the specified director and all of its contents, including other directories and their contents.

{dialog.object}.phoneGapUnzipFiles Method

Unzip files on a mobile device built with PhoneGap.

{dialog.object}.phoneGapWriteFileURL Method

Write to a file.

{dialog.object}.populateControlsFromTable Method

Populates the controls in a Dialog with data from a table.

{dialog.object}.populateDropdownBox Method

Populates the choices in a Dropdownbox control.

{dialog.object}.populateDropdownBoxRepeatingSection Method

Updates dropdown box choices.

{dialog.object}.populateExpandingMenuControl Method

Populates an Expanding Menu control.

{dialog.object}.populateMultiSelectTokensControl Method

Populates a Multi-select Tokens control with new data.

{dialog.object}.populateUXControls Method

Populates the Detail View controls for all Lists in a UX Component.

{dialog.object}.readDataCacheItems Method

Reads multiple data items, then calls the onComplete event. Contrast with .getFromDataCache() which reads a single item.

{dialog.object}.refreshCaptcha Method

Refreshes the CAPTHA image for the specied control.

{dialog.object}.refreshChart Method

Refresh a chart control.

{dialog.object}.refreshClientSideComputations Method

Force all client-side computations (calculated fields, show/hide expression, enable expression, etc) to be recomputed.

{dialog.object}.refreshDataCacheItem Method

Refreshes the data in one or more client-side data cache items.

{dialog.object}.refreshDataSeries Method

Refreshes one or more data series.

{dialog.object}.refreshDropdownBoxChoices Method

Does an Ajax callback to recompute the choices in a DropdownBox and repopulates the choices in the DropbownBox for the specified controlName.

{dialog.object}.refreshExpandingMenuData Method

Refreshes one or more Expanding Menu controls.

{dialog.object}.refreshListData Method

Refreshes data in a List control.

{dialog.object}.refreshListsIncremental Method

Perform an incremental refresh of all List controls in the UX Component.

{dialog.object}.refreshPrimaryKeyList Method

Refreshes the list of primary keys that the Dialog has retreived from the server.

{dialog.object}.refreshViewBoxData Method

Refreshes a ViewBox control.

{dialog.object}.resetForm Method

Resets all controls in the UX Component to their original value. Displays a confirmation prompt before resetting the Dialog. Pass in an optional parameter of false to suppress the prompt.

{dialog.object}.runAction Method

Runs an action that was defined using the Action Script builder.

{dialog.object}.saveDataInRepository Method

Saves the data that the user has entered into the component into the Repository using the specified 'key' value. (The Repository settings are configured in Web Project Properties).

{dialog.object}.saveListEdits Method

Synchronizes edits that have been made to the List (and any of its child Lists).

{dialog.object}.selectTabPane Method

Activates the specified pane number on a tab object. In certain cases tab panes can be assigned explicit ids. If the tab pane has an id, you can also specify the pane id.

{dialog.object}.serverIsAvailable Method

Tests if the Alpha Anywhere server is available. This is a more comprehensive test than simply testing if an Internet connection is available.

{dialog.object}.setArgumentValue Method

Sets the value of an argument.

{dialog.object}.setChannel Method

Sets the Instant Update channel in an mobile application published with Instant Updated enabled.

{dialog.object}.setClean Method

Set the UX Component's data modified state to "clean".

{dialog.object}.setControlDisplay Method

Show or hide a UX Control. Can also be used to show or hide a Tab or Accordion Pane.

{dialog.object}.setCSS Method

Adds CSS to the UX Component at run-time.

{dialog.object}.setDirty Method

Sets the UX component to be dirty.

{dialog.object}.setDisabled Method

Set the state of a control to either enabled or disabled.

{dialog.object}.setErrors Method

Display error messages for fields in the UX component.

{dialog.object}.setFocus Method

Sets focus to a specified control on the dialog.

{dialog.object}.setKey Method

If the UX has been bound to tables, sets the primary key value for the specified table alias.

{dialog.object}.setListColumnsAndPopulate Method

Dynamically sets the columns in a List and populates the List.

{dialog.object}.setListTemplateAndPopulate Method

Dynamically sets the template for a freeform List control and populates the List with data.

{dialog.object}.setRepeatingSectionActiveLogicalRow Method

Sets the active row in a Repeating Section.

{dialog.object}.setRepeatingSectionActiveRow Method

Sets the active row in the specified Repeating Section.

{dialog.object}.setRepeatingSectionColumnWidth Method

Sets the width of a column in a Repeating Section.

{dialog.object}.setStateInfo Method

Allows you to store arbitrary data in the Dialog Component's 'state' object.

{dialog.object}.setValue Method

Set the value of a control in the UX Component.

{dialog.object}.setValueFrom Method

Combines the .getValue() and .setValue() methods into a single method.

{dialog.object}.showContainerWindow Method

Shows a window defined by a 'container' control whose sub-type is 'window'. The controls in the 'window' container are the contents of the window.

{dialog.object}.showWaitMessage Method

Displays a wait message.

{dialog.object}.signatureIsEmpty Method

Returns value indiciating whether or not the Signature control is empty.

{dialog.object}.sortPrimaryKeyList Method

Sort the entries in the List View after the user has edited a field.

{dialog.object}.sortRepeatingSection Method

Sorts the data in a Repeating Section.

{dialog.object}.submit Method

Submits the Dialog to the server.

{dialog.object}.submitListDataAndMediaFiles Method

Submit edited rows in a List to a server, but first upload media files to the Alpha Anywhere server or to Amazon S3.

{dialog.object}.swapRepeatingSectionRows Method

Swaps the data in two rows in a Repeating Section. Id is the id of the Repeating Section.

{dialog.object}.synchronizeEmbeddedUX Method

Synchronizes an embedded UX component.

{dialog.object}.synchronizeLists Method

Synchronizes all Lists. This method calls the {dialog.object}.saveListEdits() method for each List in the component.

{dialog.object}.tabTimerGoto Method

Advances to the target tab pane.

{dialog.object}.tabTimerStart Method

Starts the tab to automatically advance on the timer interval.

{dialog.object}.tabTimerStop Method

Stops the tab from automatically advancing on the timer interval.

{dialog.object}.validate Method

Submits the UX Component to the server in order to validate the fields on the UX Component.