Appxweb Meta
Home > Developer > Objects > dialog


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

<dialog>

Figure: Object Chart (dialog Object Highlighted)
Syntax <dialog>
Example
 
Element: dialog
Parent: view
Description: Declaration of a dialog object.
Occurs: 0 or unbound. (i. e Within the <view> element the <dialog> element can occur zero or many times.)
 Attribute: view_id
 Description: Unique alphanumeric indentifier of this dialog view object.
Value Type: string
Value: user defined
Occurs: 1 (i.e required)
 
Element: html_file
Parent: dialog
Description: URL of the HTML resource used by the dialog.
Value Type: URL (parameter)
Value : user defined. Use of the wild card value "*.*" specifies that the dialog is able to use any URL as its HTML resource.
Occurs: 1 (i.e required)
 
Element: type
Parent: dialog
Description: Type of dialog.
Value Type: enumeration (parameter)
Value :
modal (default)
modeless
Occurs: 0 or 1 (i.e optional)
 
Element: singular
Parent: dialog
Description: Property limiting a modeless dialog to a single occurrence.
Value Type: boolean (parameter)
Value : "true" or "false" (default)
Occurs: 0 or 1 (i.e optional)
 
Element: data_transfer
Parent: dialog
Description: Dialog property specifying how data objects bound to the dialog's HTML resource are initialised.
Value Type: enumeration (parameter)
Value :
push - The values of the bound elements within the dialog's HTML resource are intialised with the values held by data objects bound to them. Changes made to element values after intialisation of the dialog's HTML resource are not reflected back to the bound data objects.
pull - The intial values of the bound elements within the dialog's HTML resource are used to intialise the values of data objects bound to them. Changes made to element values after intialisation of the dialog's HTML resource are reflected back to the bound data objects.
push_pull (default) - The values of the bound elements within the dialog's HTML resource are intialised with the values held by data objects bound to them. Changes made to element values after intialisation of the dialog's HTML resource are reflected back to the bound data objects.
Occurs: 0 or 1 (i.e optional)
 
Element: toolbar_id
Parent: dialog
Description: Identifier of the toolbar view object used by the dialog.
Value Type: string (parameter)
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: html_ext_id
Parent: dialog
Description: Identifier of the html extension function object used to modify the dialog's HTML resource.
Value Type: string (parameter)
Value : user defined.
Occurs: 0 or unbound (i.e within the <dialog> element the <html_ext_id> can occur zero or many times)
Element: browser_complete_id
Parent: dialog
Description: Identifier of the function object which is executed once downloading of the HTML resource used by the dialog is complete.
Value Type: string (parameter)
Value : user defined.
Occurs: 0 or 1 (i.e optional)
 
Element: browser_before_id
Parent: dialog
Description: Identifier of the function object executed when the HTML resource used by the dialog is about to change.
Value Type: string (parameter)
Value : user defined.
Occurs: 0 or 1 (i.e optional)
 
Element: title
Parent: dialog
Description: Title text of the dialog box.
Value Type: string (parameter)
Value : user defined.
Occurs: 0 or 1 (i.e optional)
 
Element: left
Parent: dialog
Description: Position of the left edge of dialog box. The position is relative to the left edge of the browser window which is position x=0. Values are in pixel units.
Value Type: unsigned integer (parameter)
Value : user defined. (default centred)
Occurs: 0 or 1 (i.e optional)
 
Element: top
Parent: dialog
Description: Position of the top edge of dialog box. The position is relative to the upper edge of the browser window which is position y=0. Values are in pixel units and are positive in the downward direction.
Value Type: unsigned integer (parameter)
Value : user defined. (default centred)
Occurs: 0 or 1 (i.e optional)
 
Element: width
Parent: dialog
Description: Width of the dialog box in pixels.
Value Type: unsigned integer (parameter)
Value : user defined. (default 250px)
Occurs: 0 or 1 (i.e optional)
 
Element: height
Parent: dialog
Description: Height of the dialog box in pixels.
Value Type: unsigned integer (parameter)
Value : user defined. (default 250px)
Occurs: 0 or 1 (i.e optional)
 
Element: resize
Parent: dialog
Description: Property specifying whether the dialog box is resizable.
Value Type: boolean (parameter)
Value : "true" (default) or "false"
Occurs: 0 or 1 (i.e optional)
 
Element: timer
Parent: dialog
Description: The time in seconds, the dialog should be displayed before being automatically closed.
Value Type: unsiged integer (parameter)
Value : user defined (default - dialog is dispalyed until it is closed by the end user)
Occurs: 0 or 1 (i.e optional)
 
Element: redirect
Parent: dialog
Description: Property specifying whether navigation output should be redirected to the main browser window. This property requires the dialog <type> to be "modeless". This property may not be compatible with HTML resources that utilise certain sequences of AJAX calls.
Value Type: boolean (parameter)
Value : "true" or "false" (default)
Occurs: 0 or 1 (i.e optional)
 
Element: transparent
Parent: dialog
Description: Property specifying transparency of the dialog.
Value Type: unsiged integer (parameter)
Value : range between 0 and 100. 0 being opague, 100 fully transparent.
Occurs: 0 or 1 (i.e optional)
 
Element: transparent_state
Parent: dialog
Description: Property specifying transparency of the dialog when the dialog is inactive. When the dialog is active it is opaque.
Value Type: unsiged integer (parameter)
Value : range between 0 and 100. 0 being opague, 100 fully transparent.
Occurs: 0 or 1 (i.e optional)
 
Element: transparent_region
Parent: dialog
Description: Property specifying that all regions of the dialog with colour matching RGB(255,0,255) with be fully transparent.
Value : "true" or "false" (default)
Occurs: 0 or 1 (i.e optional)
top