UX Component Methods
Description
Placeholders, properties, and methods that can be used on the client-side to interact with UX components.
Discussion
JavaScript can be used on the client to manipulate the UX component using the {dialog.object} JavaScript object. {dialog.object} is a placeholder that is replaced with the actual JavaScript object at run-time. Methods on this object are available for manipulating the UX, including methods for saving and restoring data; working with Lists, Repeating Sections, Panels, Windows, and other controls; interacting directly with the DOM; calling into the Cordova framework; and more. See Properties and Methods below for a listing of what properties and methods are available for the {dialog.object} object.
In addition, there are numerous other placeholders available to use with your component that are replaced for you at run-time, allowing you to reference things such as the UX component's alias, the name of the stylesheet in use, embedded components, and more. See Placeholders below for a list of what is available.
- Name
- Description
- IndexedDB Methods
Methods for storing, retrieving, and removing data in IndexedDB
- UX Progress Bar Methods
UX component methods for displaying and updating a simple progress bar.
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.EmbeddedUX_[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
- _rsOverwriteRowMsgstring
Message shown to user when data in a Repeating Section is copied into a dirty row. If not set, the default message "Overwrite existing data in row?" is used.
- _localStorageSettingsObject
Local storage settings for the UX Component.
- ajaxCallbackTimeoutnumber
The maximum number of milliseconds to wait for a response from an ajax callback to the server. This property can be set in the onRenderComplete event.
- dialogIdString
The UX Component name. Equivalent to {dialog.componentName}. Prefer to use {dialog.componentName}.
- originalValuesJSON array
Contains the original values for the controls in the UX Component. Values are stored in a JSON array. The contents of the array are dependent on the structure of the component.
The {dialog.object}.resetForm() uses the values stored in originalValues to reset the controls in the UX component to their original state. You can change the data in this object to modify the original values for controls.
Show data in the originalValues propertyvar origValues = {dialog.object}.originalValues; // Show values in a popup window alert(JSON.stringify(origValues));
If you return JavaScript to set the row count and values of a Repeating Section in the onDialogInitialize event, you must set the original values manually. See onDialogInitialize for more information.
Original values are not default values.
- 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
- _delayTillPhoneGapReady Method
Registers a function to call when Cordova is loaded and ready.
- _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.
- _findRepeatingSection Method
Returns the name of the Repeating Section container in which a particular control is to be found.
- _fixAllRepeatingSectionHeaders Method
Aligns all Repeating Section column titles. Used in cases where a Repeating Section is hidden unless shown via Javascript.
- _getDirtyLists Method
Returns an array of the Lists that are dirty.
- _getListForDetailViewControl Method
Returns the name of the List control for the specified column name if the column is referenced in a Detail View.
- _getOnlineStatus Method
Returns true if the device has an internet connection. Returns false if there is no connection.
- _getRepeatingSectionRowCount Method
Gets the number of rows in a repeating section.
- _hasDirtyLists Method
Returns true if any List on the UX is dirty.
- _isControlInDetailView Method
Returns true if the colName is inside the Detail View of any List on the UX.
- _listFetchMore Method
Gets the next 'page' of data in a List that has been configured to use 'Fetch More' pagination.
- _listFetchRecordsByKey Method
Appends records to the end of the list.
- _listGetElement Method
Gets a pointer to an individual control in a List row, allowing you to manipulate its properties using Javascript.
- _listMoveAllRows Method
Moves all rows from one List control to another List control.
- _listMoveCurrentSelection Method
Moves selected rows from one List control to another List control.
- _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.
- _listNavigateRecord Method
Navigates by record in the specified direction: first, previous, next, or last.
- _listNavigateToPage Method
Navigates to an explicit page number. (List must be configured as paginated.)
- _listRefreshCascadingLists Method
Refreshes the data in child List controls that are dependent on the data in this List control.
- _listRefreshRecordsByKey Method
Refreshes the data in the List for the specified records.
- _listRefreshRow Method
Refreshes the data in the current row of a List control.
- _listRemoveAllRows Method
Removes all rows from a List control.
- _listRemoveSelectedRows Method
Removes the currently selected row(s) from a List control.
- _listShiftPositionSelectedRows Method
Reorders the items in a List by shifting the selected rows in the specified direction.
- _ls_deleteKeys Method
Deletes data for the specified keys from Local Storage.
- _ls_getData Method
Returns an object with information about keys stored in Local Storage.
- _persistFolder Method
Gets the sub-folder in which the files are actually stored. Returned folderName includes a trailing / character.
- _persistFS Method
Gets the file system URL of the directory in which the List data sub-directory is located.
- _persistToLocalStorageInitializeKeys Method
Use to delete persisted List data (including edits) from Local Storage or the File System (Cordova applications.)
- _populateSourceComponent Method
Set the value of controls in the calling Grid or UX component to the value of the mapped controls in the current UX.
- _prepareRepeatingSection Method
This command will fix the column titles.
- _primaryKeyListSetKey Method
Sets the active row in the Primary key Control to the specified primary key value.
- _refreshListData Method
Refreshes the data in a List control.
- _repeatingSectionLogicalToPhysicalRow Method
Returns the physical row number for given logical row number in a specified Repeating Section.
- _restoreVariablesFromLocalStorage Method
Restores persisted variables stored in Local Storage to the UX Component.
- _setRepeatingSectionRowCount Method
Sets the number of rows in a repeating section.
- _setSimulatedOnlineStatus Method
Allows you to simulate offline behavior of you component event when you have a connection.
- _tabInfo Method
Returns Javascript object with info about the tab control.
- _updateAjaxURL Method
Updates the Ajax Callback URL for a Cordova application.
- accordionControl Method
Either opens or closes all panes in an accordion object.
- actionSheet Method
Displays an Action Sheet.
- 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.
- addCustomSchemeForAlphaWkWebView Method
Adds a local URL prefix to a file URL so that it can be referenced in the source property for an image, video, audio, or other element in an iOS Cordova app using the WkWebView plugin.
- addRepeatingSectionRow Method
Adds a new row to the specified Repeating Section.
- ajaxCallback Method
Does an Ajax callback to a server.
- ajaxCallbackCrossDomain Method
Performs a cross-domain Ajax callback.
- argumentValue Method
Get the value of an argument that was passed to the UX component.
- buttonClick Method
Executes the click event for a Button.
- clearLoginErrors Method
Clears login errors that are displayed in the 'login error placeholder' (specified in the UX Component integrated login properties).
- clientSideValidateField Method
Executes client-side validation for a control in the UX Component.
- 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.
- closeCurrentTabbedUIPane Method
If the Dialog was opened in a Tabbed UI Pane, closes the current pane in the Tabbed UI.
- closeWindow Method
Closes a window.
- computeSearchFromMetaDataAndFilterList Method
Performs a server-side query to filter/sort the data in a List based on a SQL data source.
- copyRepeatingSectionRow Method
Copies the values from one row in a Repeating Section to another.
- copyTextToClipboard Method
Copies text to the clipboard.
- countRecordsToSynch Method
Returns an object with properties showing the number of records that have not yet been synchronized with the server.
- customSetting Method
Get or Set the value of a custom setting.
- debugInfoToFile Method
Writes client-side data to a file on the server.
- debugInfoToS3 Method
Writes client-side data to a file stored in an Amazon S3 bucket.
- deleteRecord Method
Deletes the current record in the 'primary' table. Applies only to a component that has been bound to one or more tables.
- deleteRepeatingSectionRow Method
Removes the current row from the specified Repeating Section.
- destroyChildComponent Method
Can be used to delete child UX components from memory.
- dropDownMessage Method
Shows a dropdown message.
- dropDownMessageHide Method
Hides a dropdown message.
- duplicateRepeatingSectionRow Method
Copies the values in the current Repeating Section row to a new row.
- editorCancel Method
Closes an EditorSet without committing any unsaved edits.
- editorCommit Method
Commits the change made in the Editor to the value you are editing.
- 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.
- 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.
- exportChart Method
Exports one or more charts to a PDF or RTF file and then downloads the file to the client computer.
- fireLayoutRule Method
Executes the actions for a Responsive Layout rule, ignoring whether or not the rule evaluates to a true result.
- formViewClearErrors Method
Clears any errors shown on the FormView control.
- formViewCommit Method
Commits the data in the FormView control back to the data source.
- formViewData Method
Populates a FormView control with data in a dataObject.
- formViewGetState Method
Gets the FormView state object and stores it in a variable.
- formViewGetViewBox Method
Gets a pointer to the ViewBox control used in the FormView control.
- formViewInvokeEditor Method
Opens the editor for a field, even if the field is not visible in the current FormView.
- formViewIsDirty Method
Returns true if the FormView controls is dirty (i.e. has edits that have not been committed back to the data source);
- formViewNavigate Method
Sets focus to a field in the FormView (and opens the Editor - if defined - for the target field.)
- formViewNewRecord Method
Displays a new record in the FormView control.
- formViewRefresh Method
Repopulates the Form View with data from the FormView's data source.
- formViewRow Method
Gets or sets the logical 'row' property of the FormView control.
- formViewSetLayout Method
Displays the specified layout. (Assumes that when the FormView was defined, multiple layouts were defined).
- formViewSetStateVariables Method
Sets FormView state variables.
- formViewUpdate Method
Sets the value in one or more FormView controls.
- formViewValidate Method
Validates the data in FormView by evaluating the validation function for each field.
- frameOpenStateChange Method
Sets the open or closed state of a modern frame.
- getChildObject Method
Returns a pointer to the child component.
- getConnectionType Method
Returns the type of connection the device has. (May not return reliable information if not running in a Cordova shell).
- getControl Method
Get a pointer to a control to call methods of an object, or set properties of an object.
- getCurrentEditorSettings Method
Gets the 'settings' object for the currently open Editor. If no Editor is open, returns false;
- getData Method
Gets the value of all of the controls in the UX Component in the form of a query string (name/value pairs).
- getDateValue Method
Get the valuel of a control in the UX Component as a JavaScript Date 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.
- getInstanceNumber Method
Returns the instance number for the specified control in a Repeating Section.
- getKey Method
Gets the primary key value for the specified table alias.
- 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.
- getListData Method
Gets a Javascript array (as an array of objects) with all of the data in the specified List control.
- 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.
- getOrientation Method
Returns the device's orientation.
- 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()).
- getParentObject Method
If this component is opened from a parent Grid or UX component, this returns a pointer to the parent object so you can execute methods on the parent object.
- getPointer Method
Get a pointer to the DOM element for a UX component control.
- getRepeatingSectionActiveRow Method
Gets the active row in the specified Repeating Section.
- getSessionVariable Method
Get the value of a session variable.
- getSize Method
Gets information about the screen size and orientation.
- getStateInfo Method
Get all of the state variable information for the UX component.
- 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.
- getTopParentObject Method
Returns a pointer to the top most parent object.
- getValue Method
Get the value of a control in the UX Component.
- getValueDisplay Method
Get the value of a control in the UX Component.
- getWindow Method
Get a pointer to a window.
- graphQLQuery Method
Executes a GraphQL query.
- graphQLQueryPromise Method
Executes a GraphQL query and returns a promise.
- 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.
- 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.
- hideRepeatingSectionColumn Method
Hide/show a column in a Repeating Section.
- 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.
- httpFetch Method
Fetches data from a specified URL.
- imageIsEmpty Method
Returns true if an image control is empty.
- inkIsEmpty Method
Returns true if an Ink control is empty.
- instantUpdateCheckForUpdate Method
Checks for updates for a Cordova app with Instant Update.
- instantUpdateRefresh Method
Checks for, downloads, and installs a new update for a Cordova application with Instant Update.
- instantUpdateUseAutoUpdate Method
Enables or disables automatically checking for updates in a Cordova app that includes Instant Update.
- jsChartRedraw Method
Redraws a Javascript chart.
- jsChartRefreshData Method
Refreshes the data in Data Series that the Chart uses and then redraws the Chart.
- jsChartResize Method
Resizes a Javascript chart.
- jsChartSetProperties Method
Change the properties of the Javascript Chart.
- json_to_excel Method
Exports JSON data to Excel, then downloads the file to the client's machine.
- listColumnSelector Method
Displays a pick-list of all columns in the currently active columnar List layout. Clicking items in the pick-list toggles a column's visibility.
- listGetValue Method
Get the value of a column in a List control.
- loadCSSFile Method
Loads CSS from a file.
- loadDataFromRepository Method
Loads data that was previously saved to the Repository.
- loadJavascriptFile Method
Loads an external JavaScript file.
- 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).
- login Method
Logs a user in using the UX Component's integrated login.
- loginStage2 Method
Submits the two-factor authentication information for a UX Component with integrated login.
- logout Method
Logs a user out. For use in a UX with Integrated Login or AppLauncher component.
- moveDownRepeatingSectionRow Method
Moves the data in the current Repeating Section row down one row.
- moveUpRepeatingSectionRow Method
Moves the data in the current Repeating Section row up one row.
- networkSpeedTest Method
Measures the network speed between the server and the device calling the method.
- newRecord Method
Changes the current 'mode' from editing an existing record to entering a new record.
- onTimerEventStart Method
Causes the onTimer client-side event to start firing automatically every n seconds as specified by the interval (in milliseconds).
- onTimerEventStop Method
Turns off the onTimer event.
- openLookup Method
Opens the lookup Grid for a particular field.
- panelGet Method
Gets a pointer to a Panel.
- panelGetActive Method
Gets the name of the active Panel.
- panelGetId Method
Gets the ID of the specified 'part' of a Panel.
- panelHeight Method
Returns the height of the Panel body in pixels.
- panelNavigate Method
Navigates to the next or previous Panel in a Panel Navigator
- panelRemove Method
Remove a Panel from a Panel Navigator control.
- panelSetActive Method
Sets focus to a particular Panel. Press the control-down key or click to select Panel name in a UX component.
- panelWidth Method
Returns the width of the Panel body in pixels.
- pdfViewerLoad Method
Displays a PDF in the PDFViewer control.
- persistListColumnLayout Method
Persists the column layout for the specified List control.
- 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).
- persistVariablesToLocalStorage Method
Manually persist variables to local storage in the UX Component. All variables in the UX component will be saved to local storage when this method is called. You can specify additional variables and values to store as a JSON object passed to the function.
- phoneGapCopyFileURL Method
Copies a file from one location to another on the file system.
- phoneGapCreateDirectory Method
Create a directory in the file system of the mobile device.
- phoneGapCreateDirectoryRecurse Method
Create directories recursively in the file system of the mobile device.
- phoneGapCreateFile Method
Creates a file in the file system of the mobile device.
- phoneGapDeleteFile Method
Deletes a file in the file system of the mobile device.
- 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.
- phoneGapDeleteFileURL Method
Delete a file.
- phoneGapDownloadManifestFiles Method
Download files to a device.
- phoneGapEnsureDirPathURL Method
Ensures a directory structure exists within the specified root path. If the directories do not exist, they are created.
- phoneGapFileExists Method
Checks if a file exists in the file system of the mobile device.
- 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.)
- phoneGapFilesAvailable Method
Checks whether or not the local file system is available in a Cordova application.
- phoneGapGetDirectory Method
Gets a list of files in a directory in the file system of the mobile device.
- phoneGapGetDirectoryRecurse Method
Gets a list of files in a directory in the file system of the mobile device.
- phoneGapGetLocalDirURL Method
Returns URL of base for the requested part of the file system.
- phoneGapListFilesRecurseURL Method
List files in a directory and in the sub-directories of the specified directory.
- 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.
- phoneGapLoaded Method
Returns true if the UX component is running in a Cordova shell.
- phoneGapMoveFileURL Method
Move a file.
- phoneGapReadFile Method
Reads the contents of a text file in the file system of the mobile device.
- phoneGapReadFileURL Method
Reads a file.
- phoneGapRemoveDirectory Method
Deletes a directory in the file system of the mobile device.
- phoneGapRemoveDirectoryRecurse Method
Removes directories recursively in the file system of the mobile device.
- phoneGapRemoveDirectoryRecurseURL Method
Deletes the specified director and all of its contents, including other directories and their contents.
- phoneGapUnzipFiles Method
Unzip files on a mobile device built with Cordova.
- phoneGapWriteFileURL Method
Write to a file.
- populateControlsFromTable Method
Populates the controls in a Dialog with data from a table.
- populateDropdownBox Method
Populates the choices in a Dropdownbox control.
- populateDropdownBoxRepeatingSection Method
Updates dropdown box choices.
- populateExpandingMenuControl Method
Populates an Expanding Menu control.
- populateMultiSelectTokensControl Method
Populates a Multi-select Tokens control with new data.
- populateUXControls Method
Populates the Detail View controls for all Lists in a UX Component.
- readDataCacheItems Method
Reads multiple data items, then calls the onComplete event. Contrast with .getFromDataCache() which reads a single item.
- refreshCaptcha Method
Refreshes the CAPTHA image for the specified control.
- refreshChart Method
Refresh a chart control.
- refreshClientSideComputations Method
Force all client-side computations (calculated fields, show/hide expression, enable expression, etc) to be recomputed.
- refreshDataCacheItem Method
Refreshes the data in one or more client-side data cache items.
- refreshDataSeries Method
Refreshes one or more data series.
- refreshDropdownBoxChoices Method
Does an Ajax callback to recompute the choices in a DropdownBox and repopulates the choices in the DropbownBox for the specified controlName.
- refreshExpandingMenuData Method
Refreshes one or more Expanding Menu controls.
- refreshListData Method
Refreshes data in a List control.
- refreshListsIncremental Method
Perform an incremental refresh of all List controls in the UX Component.
- refreshPrimaryKeyList Method
Refreshes the list of primary keys that the UX component has retrieved from the server.
- refreshViewBoxData Method
Refreshes a ViewBox control.
- resetForm Method
Resets all controls in the UX Component to their original value. Displays a confirmation prompt before resetting the controls. Pass in an optional parameter of false to suppress the prompt.
- restoreListColumnLayout Method
Restores a previously saved column layout for the specified List control.
- runAction Method
Runs an action that was defined using the Action Script builder.
- saveDataInRepository Method
Saves component data to the application repository.
- saveListEdits Method
Synchronizes edits that have been made to the List (and any of its child Lists).
- 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.
- 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.
- setArgumentValue Method
Sets the value of an argument.
- setChannel Method
Sets the Instant Update channel in an mobile application published with Instant Updated enabled.
- setClean Method
Set the UX Component's data modified state to "clean".
- setControlDisplay Method
Show or hide a UX Control. Can also be used to show or hide a Tab or Accordion Pane.
- setCSS Method
Adds CSS to the UX Component at run-time.
- setDirty Method
Sets the UX component to be dirty.
- setDisabled Method
Set the state of a control to either enabled or disabled.
- setErrors Method
Display error messages for fields in the UX component.
- setFocus Method
Sets focus to a specified control on the dialog.
- setKey Method
If the UX has been bound to tables, sets the primary key value for the specified table alias.
- setListColumnsAndPopulate Method
Dynamically sets the columns in a List and populates the List.
- setListTemplateAndPopulate Method
Dynamically sets the template for a freeform List control and populates the List with data.
- setRepeatingSectionActiveLogicalRow Method
Sets the active row in a Repeating Section.
- setRepeatingSectionActiveRow Method
Sets the active row in the specified Repeating Section.
- setRepeatingSectionColumnWidth Method
Sets the width of a column in a Repeating Section.
- setStateInfo Method
Allows you to store arbitrary data in the UX Component's 'state' object.
- setValue Method
Set the value of a control in the UX Component.
- setValueFrom Method
Combines the .getValue() and .setValue() methods into a single method.
- 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.
- showWaitMessage Method
Displays a wait message.
- signatureIsEmpty Method
Returns value indiciating whether or not the Signature control is empty.
- sortPrimaryKeyList Method
Sort the entries in the List View after the user has edited a field.
- sortRepeatingSection Method
Sorts the data in a Repeating Section.
- stripCustomSchemeForAlphaWkWebView Method
Removes a custom scheme from a file URL.
- submit Method
Submits the UX to the server.
- 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.
- swapRepeatingSectionRows Method
Swaps the data in two rows in a Repeating Section. Id is the id of the Repeating Section.
- synchronizeEmbeddedUX Method
Synchronizes an embedded UX component.
- synchronizeLists Method
Synchronizes all Lists. This method calls the {dialog.object}.saveListEdits() method for each List in the component.
- tabTimerGoto Method
Advances to the target tab pane.
- tabTimerStart Method
Starts the tab to automatically advance on the timer interval.
- tabTimerStop Method
Stops the tab from automatically advancing on the timer interval.
- transientMessage Method
Displays a transient message.
- unZoomPanelCard Method
Resets the zoom level for a Panel Card.
- validate Method
Submits the UX Component to the server in order to validate the fields on the UX Component.