Siebel Object Interfaces Reference > Interfaces Reference > Application Methods >

ShowModalDialog Method


ShowModalDialog allows you to show a modal dialog box with the cursor maintained in its default state. This Application object method invokes Microsoft's equivalent Window object method.

This method is implemented in Siebel Business Applications release 7.7.2.2 and later.

Syntax

theApplication().ShowModalDialog (url[, argin][, options])

Argument
Description

url

The URL of the document to load and display.

argin

This optional parameter is used to pass arguments to use when displaying the document. This argument can be a value of any type, including an array of values.

options

String that specifies the attributes of the window that displays the dialog box.

This optional parameter may include one or more of the following semicolon-delimited values:

  • dialogHeight:sHeight sets the height of the dialog window, where sHeight can be an integer or floating-point number, followed by an absolute units designator (cm, mm, in, pt, pc, or px) or a relative units designator (em or ex). For consistent results, specify the dialogHeight and dialogWidth in pixels when designing modal dialog boxes. Default unit of measure is em. Minimum height is 100 pixels.
  • dialogLeft:sXPos sets the left position of the dialog window relative to the upper-left corner of the desktop.
  • dialogTop:sYPos sets the top position of the dialog window relative to the upper-left corner of the desktop.
  • dialogWidth:sWidth sets the width of the dialog window.
  • center:{ yes | no | 1 | 0 | on | off } specifies whether to center the dialog window within the desktop. The default is yes.
  • dialogHide:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window is hidden when printing or using print preview. This feature is only available when a dialog box is opened from a trusted application. The default is no.
  • edge:{ sunken | raised } specifies the edge style of the dialog window. The default is raised.
  • help:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window displays the context-sensitive Help icon. The default is yes.
  • resizable:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window has fixed dimensions. The default is no.
  • scroll:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window displays scrollbars. The default is yes.
  • status:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window displays a status bar. The default is yes for untrusted dialog windows and no for trusted dialog windows.
  • unadorned:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window displays the border window chrome. This feature is only available when a dialog box is opened from a trusted application. The default is no.
Returns

The value of the returnValue property, as set by the window of the document specified by the url parameter

Used With

Browser Script

Example

This example shows how this method can be used in browser script to bring up a modal dialog box with a specified URL.

function Applet_Load ()
{
var sOptions="dialogHeight: 1000px;edge:sunken;resizable;yes";
theApplication().ShowModalDialog("http://www.yahoo.com", "", sOptions)
}

Siebel Object Interfaces Reference