Appxweb Meta
Home > Developer > Objects

Objects



Declared Objects

Declared Objects are Meta Objects declared using an XML based declarative language called the Appxweb Meta Language (AML). AML is defined by the AML Schema. Click the Meta Object name in the chart below for declaration and usage examples.

meta - AML object declaration extension - AML object declaration package - AML object declaration data - AML object declaration function - AML object declaration view - AML object declaration scalar - AML object declaration array - AML object declaration pointer - AML object declaration script - AML object declaration call_script - AML object declaration render - AML object declaration navigate - AML object declaration menu - AML object declaration menu - AML object declaration dialog - AML object declaration report - AML object declaration window - AML object declaration
Figure: Object Chart

Object Chart
top

Canned Objects

Canned Objects are Meta 0bjects provided by default to all Meta extensions. These canned objects are able to be incorporated and used within your Meta extension like a declared object simply by referencing the objects identifier. Data Objects and Function Objects that are canned are described below.

Data Objects

Object IdentifierDescription
_did_urlURL value of the current web page.
_did_url_toURL value the browser is about to navigate to. Once the web page is fully downloaded this value is the same as _did_url
_did_key_eventsValue of "1" (default) indicating that keyboard events are handled. Set this value to "0" to improve the performance for webpages with a high number of fields.
_did_download_completeValue of "1" indicating that the downloading of the current web page is complete, otherwise "0"
_did_webpage_titleTitle of the current web page.
_did_clipboardCurrent HTML contents of the Windows clipboard added by the _fid_set_clipboard_html function call.
_did_dialog_okValue of "true" indicating that _fid_dialog_ok was called, otherwise "0".
_did_dialog_cancelValue of "1" indicating that _fid_dialog_cancel was called, otherwise "0".
_did_dialog_yesValue of "1" indicating that _fid_dialog_yes was called, otherwise "0".
_did_dialog_noValue of "1" indicating that _fid_dialog_no was called, otherwise "0".

Function Objects

Object IdentifierDescription
_fid_data_getUpdates the extension's data with the values of bound html elements within the web page.
_fid_data_setUpdates the values of bound html elements within the web page with the extension's data.
_fid_saveSaves the extension's data to file. If the data has not been previously saved the "Save As" dialog will be displayed and the user will be prompted to select a file to save to.
_fid_saveasDisplays the "Save As" dialog with the user prompted to select a different file to save the extensions data to.
_fid_newResets the extension, clearing all data and setting the title to "Untitled".
_fid_openDisplays the "Open" dialog with user prompted to select an existing extension data file which is then loaded.
_fid_exitExits the extension.
_fid_get_clipboard_htmlCopies the Windows clipboard data in HTML format to the _did_clipboard data object.
_fid_get_clipboard_html_absoluteCopies the Windows clipboard data in HTML format to the _did_clipboard data object. All URLs are in the copied data are absolute.
_fid_set_clipboard_htmlCopies the _did_clipboard data object to Windows clipboard.
_fid_undo_markSaves a temporary copy of the extension's data.
_fid_undoRolls the extension's data back to the point when _fid_undo_mark was called.
_fid_redoRolls the extension's data forward to reflect the latest changes.
_fid_browser_backNavigates the browser back one item in the browsers history list.
_fid_browser_forwardNavigates the browser forward one item in the browsers history list.
_fid_browser_stopStops the browser downloading the current web page.
_fid_browser_refreshReloads the browsers current web page.
_fid_browser_homeNavigates the browser to the current home or start page specified in the Internet Explorer Internet Options dialog box.
_fid_dialog_minimizeMinimize the active dialog.
_fid_dialog_minimize_allMinimize all open dialogs.
_fid_dialog_maximizeMaximize the active dialog.
_fid_dialog_restore_allRestore all previously minimized dialogs to their original size and position.
_fid_dialog_moveCreates a handle by which the dialog is able to be moved. Normally associated with the left mouse down event on the element that this function object is bound to.
_fid_dialog_okCommit changes and close the dialog. _did_dialog_ok is set to "1".
_fid_dialog_yesCommit changes and close the dialog. _did_dialog_yes is set to "1".
_fid_dialog_noCancel changes and close the dialog. _did_dialog_no is set to "1".
_fid_dialog_cancelCancel changes and close the dialog. _did_dialog_cancel is set to "1".


top