Wijmo UI for the Web
options type
Inheritance Hierarchy

Object
   jQuery.wijmo.wijdialog.options

Browser Compatibility
7
5
5
Fields
 NameDescription
public Fieldstatic (Shared in Visual Basic)appendTo

Default value: 'body'

Which element the dialog (and overlay, if modal) should be appended to.

 
public Fieldstatic (Shared in Visual Basic)autoOpen

Default value: true

If set to true, the dialog will automatically open upon initialization. If false, the dialog will stay hidden until the open() method is called.

 
public Fieldstatic (Shared in Visual Basic)buttons

Default value (array): []  

Default value (object): {}

The buttons option specifies the buttons to display within the dialog content area. The property key is the button text. The value is the callback function when the button is clicked. The context of the callback is the dialog element. Access to the button is available as the target of the event object.

When used as an array, each element of the array must be an Object that defines a button's properties.

 
public Fieldstatic (Shared in Visual Basic)captionButtons

The captionButtons option determines the caption buttons to show on the wijdialog title bar.

 
public Fieldstatic (Shared in Visual Basic)closeOnEscape

Default value: true

Specifies whether the dialog should close when it has focus and the user presses the esacpe (ESC) key.

 
public Fieldstatic (Shared in Visual Basic)closeText

Default value: 'close'

Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.

 
public Fieldstatic (Shared in Visual Basic)collapsingAnimation

Default value: null

The collapsingAnimation option determines the animation effect that is used when the wijdialog is collapsed.

 
public Fieldstatic (Shared in Visual Basic)contentUrl

Default value: ""

This option specifies the URL for the iframe element inside wijdialog.

 
public Fieldstatic (Shared in Visual Basic)dialogClass

Default value: ""

The specified class name(s) will be added to the dialog, for additional theming.

 
public Fieldstatic (Shared in Visual Basic)disabled  
public Fieldstatic (Shared in Visual Basic)draggable

Default value: true

If set to true, the dialog will be draggable by the title bar. Requires the jQuery UI Draggable widget to be included.

 
public Fieldstatic (Shared in Visual Basic)expandingAnimation

Default value: null

The expandingAnimation option determines the animation effect that is used when the wijdialog is expanded.

 
public Fieldstatic (Shared in Visual Basic)height

Default value: 'auto'

The height of the dialog.

 
public Fieldstatic (Shared in Visual Basic)hide

Default value: null

If and how to animate the hiding of the dialog.

 
public Fieldstatic (Shared in Visual Basic)maxHeight

Default value: null

The maximum height to which the dialog can be resized, in pixels.

 
public Fieldstatic (Shared in Visual Basic)maxWidth

Default value: null

The maximum width to which the dialog can be resized, in pixels.

 
public Fieldstatic (Shared in Visual Basic)minHeight

Default value: 150

The minimum height to which the dialog can be resized, in pixels.

 
public Fieldstatic (Shared in Visual Basic)minimizeZoneElementId

Default value: ""

The minimizeZoneElementId option specifies the ID of the DOM element to dock to when wijdialog is minimized.

 
public Fieldstatic (Shared in Visual Basic)minWidth

Default value: 150

The minimum width to which the dialog can be resized, in pixels.

 
public Fieldstatic (Shared in Visual Basic)modal

Default value: false

If set to true, the dialog will have modal behavior; other items on the page will be disabled, i.e., cannot be interacted with. Modal dialogs create an overlay below the dialog but above other page elements.

 
public Fieldstatic (Shared in Visual Basic)position

Specifies where the dialog should be displayed. The dialog will handle collisions such that as much of the dialog is visible as possible.

 
public Fieldstatic (Shared in Visual Basic)resizable

Default value: true

undefined

 
public Fieldstatic (Shared in Visual Basic)show

Default value: null

If and how to animate the showing of the dialog.

 
public Fieldstatic (Shared in Visual Basic)stack

Default value: true

undefined

 
public Fieldstatic (Shared in Visual Basic)title

Default value: null

Specifies the title of the dialog. If the value is null, the title attribute on the dialog source element will be used.

 
public Fieldstatic (Shared in Visual Basic)width

Default value: 300

The width of the dialog, in pixels.

 
public Fieldstatic (Shared in Visual Basic)zIndex

Default value: 1000

This option specifies the starting z-index for the dialog.

 
Top
Events
 NameDescription
public EventbeforeCloseTriggered when a dialog is about to close. If canceled, the dialog will not close.  
public EventblurThe blur event is called when the dialog widget loses focus.  
public EventbuttonCreatingThe buttonCreating event is called before the caption buttons are created. It can be used to change the array of the buttons or to change, add, or remove buttons from the title bar.  
public EventcloseTriggered when the dialog is closed.  
public EventcreateTriggered when the dialog is created.  
public EventdragTriggered while the dialog is being dragged.  
public EventdragStartTriggered when the user starts dragging the dialog.  
public EventdragStopTriggered after the dialog has been dragged.  
public EventfocusTriggered when the dialog gains focus.  
public EventopenTriggered when the dialog is opened.  
public EventresizeTriggered while the dialog is being resized.  
public EventresizeStartTriggered when the user starts resizing the dialog.  
public EventresizeStopTriggered after the dialog has been resized.  
public EventstateChangedThe stateChanged event is called when the dialog state ("maximized", "minimized", "normal") is changed.  
Top
See Also

Reference

jQuery.wijmo.wijdialog Namespace

 

 


© 2013 All Rights Reserved.

Send comments on this topic.