Wijmo UI for the Web
wijdialog jQuery Widget
Add maximizing, minimizing, content toggling, and pinning features to jquery.ui.dialog.
Syntax
Javascript (Usage) 
$(function () {
    var options; // Type:  wijmo.dialog.wijdialog.options
     
    $(".selector").wijdialog(options);
});
Javascript (Specification) 
function wijdialog() : any;
Browser Compatibility
7
5
5
Options
 NameDescription
public OptionappendTo

Default value: 'body'

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

 
public OptionautoOpen

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 Optionbuttons

Default value: []

Specifies which buttons should be displayed on the dialog. The context of the callback is the dialog element; if you need access to the button, it is available as the target of the event object.

 
public OptioncaptionButtons

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

 
public OptioncloseOnEscape

Default value: true

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

 
public OptioncloseText

Default value: 'close'

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

 
public OptioncollapsingAnimation

Default value: null

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

 
public OptioncontentUrl

Default value: ""

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

 
public OptiondialogClass

Default value: ""

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

 
public Optiondisabled  
public Optiondraggable

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 OptionexpandingAnimation

Default value: null

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

 
public Optionheight

Default value: 'auto'

The height of the dialog.

 
public Optionhide

Default value: null

If and how to animate the hiding of the dialog.

 
public OptionmaxHeight

Default value: null

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

 
public OptionmaxWidth

Default value: null

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

 
public OptionminHeight

Default value: 150

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

 
public OptionminimizeZoneElementId

Default value: ""

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

 
public OptionminWidth

Default value: 150

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

 
public Optionmodal

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 Optionposition

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

 
public Optionresizable

Default value: true

undefined

 
public Optionshow

Default value: null

If and how to animate the showing of the dialog.

 
public Optionstack

Default value: true

undefined

 
public Optiontitle

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 Optionwidth

Default value: 300

The width of the dialog, in pixels.

 
public OptionzIndex

Default value: 1000

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

 
Top
Methods
 NameDescription
public MethodcloseThe close method closes the dialog widget.  
public MethoddestroyRemoves the wijdialog functionality completely. This returns the element to its pre-init state.  
public Methoddisable  
public Methodenable  
public MethodgetStateThe getState method gets the state of the dialog widget.  
public MethodisOpen  
public MethodmaximizeThe maximize method maximizes the wijdialog.  
public MethodminimizeThe minimize method minimizes the wijdialog.  
public MethodmoveToTop  
public MethodopenThe open method opens an instance of the wijdialog.  
public Methodoption  
public MethodpinThe pin method prevents the wijdialog from being moved.  
public MethodrefreshThe refresh method refreshes the iframe content within the wijdialog.  
public MethodresetThe reset method resets dialog properties such as width and height to their default values.  
public MethodrestoreThe restore method restores the wijdialog to its normal size from either the minimized or the maximized state.  
public MethodtoggleThe toggle method expands or collapses the content of the wijdialog.  
public Methodwidget  
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

Widgets

Dialog

Reference

wijdialog jQuery Widget

 

 


© 2013 All Rights Reserved.

Send comments on this topic.