Merge branch 'master' of https://github.com/firefields/MCTX3420
[matches/MCTX3420.git] / testing / ver0.01 / jquery-ui-1.10.3.custom / development-bundle / docs / dialog.html
1 <!doctype html>
2 <html lang="en">
3 <head>
4         <meta charset="utf-8">
5         <title>jQuery UI dialog documentation</title>
6
7         <style>
8         body {
9                 font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif"
10         }
11         .gutter {
12                 display: none;
13         }
14         </style>
15 </head>
16 <body>
17
18 <script>{
19                 "title":
20                         "Dialog Widget",
21                 "excerpt":
22                         "Open content in an interactive overlay.",
23                 "termSlugs": {
24                         "category": [
25                                 "widgets"
26                         ]
27                 }
28         }</script><article id="dialog1" class="entry widget"><h2 class="section-title">
29 <span>Dialog Widget</span><span class="version-details">version added: 1.0</span>
30 </h2>
31 <div class="entry-wrapper">
32 <p class="desc"><strong>Description: </strong>Open content in an interactive overlay.</p>
33 <section id="quick-nav"><header><h2>QuickNav<a href="#entry-examples">Examples</a>
34 </h2></header><div class="quick-nav-section">
35 <h3>Options</h3>
36 <div><a href="#option-appendTo">appendTo</a></div>
37 <div><a href="#option-autoOpen">autoOpen</a></div>
38 <div><a href="#option-buttons">buttons</a></div>
39 <div><a href="#option-closeOnEscape">closeOnEscape</a></div>
40 <div><a href="#option-closeText">closeText</a></div>
41 <div><a href="#option-dialogClass">dialogClass</a></div>
42 <div><a href="#option-draggable">draggable</a></div>
43 <div><a href="#option-height">height</a></div>
44 <div><a href="#option-hide">hide</a></div>
45 <div><a href="#option-maxHeight">maxHeight</a></div>
46 <div><a href="#option-maxWidth">maxWidth</a></div>
47 <div><a href="#option-minHeight">minHeight</a></div>
48 <div><a href="#option-minWidth">minWidth</a></div>
49 <div><a href="#option-modal">modal</a></div>
50 <div><a href="#option-position">position</a></div>
51 <div><a href="#option-resizable">resizable</a></div>
52 <div><a href="#option-show">show</a></div>
53 <div><a href="#option-title">title</a></div>
54 <div><a href="#option-width">width</a></div>
55 </div>
56 <div class="quick-nav-section">
57 <h3>Methods</h3>
58 <div><a href="#method-close">close</a></div>
59 <div><a href="#method-destroy">destroy</a></div>
60 <div><a href="#method-isOpen">isOpen</a></div>
61 <div><a href="#method-moveToTop">moveToTop</a></div>
62 <div><a href="#method-open">open</a></div>
63 <div><a href="#method-option">option</a></div>
64 <div><a href="#method-widget">widget</a></div>
65 </div>
66 <div class="quick-nav-section">
67 <h3>Events</h3>
68 <div><a href="#event-beforeClose">beforeClose</a></div>
69 <div><a href="#event-create">create</a></div>
70 <div><a href="#event-open">open</a></div>
71 <div><a href="#event-focus">focus</a></div>
72 <div><a href="#event-dragStart">dragStart</a></div>
73 <div><a href="#event-drag">drag</a></div>
74 <div><a href="#event-dragStop">dragStop</a></div>
75 <div><a href="#event-resizeStart">resizeStart</a></div>
76 <div><a href="#event-resize">resize</a></div>
77 <div><a href="#event-resizeStop">resizeStop</a></div>
78 <div><a href="#event-close">close</a></div>
79 </div></section><div class="longdesc" id="entry-longdesc">
80                 <p>A dialog is a floating window that contains a title bar and a content area. The dialog window can be moved, resized and closed with the 'x' icon by default.</p>
81
82                 <p>If the content length exceeds the maximum height, a scrollbar will automatically appear.</p>
83
84                 <p>A bottom button bar and semi-transparent modal overlay layer are common options that can be added.</p>
85         </div>
86 <h3>Additional Notes:</h3>
87 <div class="longdesc"><ul><li>
88                         This widget requires some functional CSS, otherwise it won't work. If you build a custom theme, use the widget's specific CSS file as a starting point.
89                 </li></ul></div>
90 <section id="options"><header><h2 class="underline">Options</h2></header><div id="option-appendTo" class="api-item first-item">
91 <h3>appendTo<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Selector">Selector</a></span>
92 </h3>
93 <div class="default">
94 <strong>Default: </strong><code>"body"</code>
95 </div>
96 <div>Which element the dialog should be appended to. Regardless of the value set, the overlay for modal dialogs will always be appended to the body and cover the entire window.<span class="version-details"> (version added: 1.10)</span>
97 </div>
98 <strong>Code examples:</strong><p>Initialize the dialog with the appendTo option specified:</p>
99 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ appendTo: </code><code class="string">"#someElem"</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
100 <p>Get or set the appendTo option, after initialization:</p>
101 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">appendTo = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"appendTo"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"appendTo"</code><code class="plain">, </code><code class="string">"#someElem"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
102 </div>
103 <div id="option-autoOpen" class="api-item">
104 <h3>autoOpen<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Boolean">Boolean</a></span>
105 </h3>
106 <div class="default">
107 <strong>Default: </strong><code>true</code>
108 </div>
109 <div>If set to <code>true</code>, the dialog will automatically open upon initialization. If <code>false</code>, the dialog will stay hidden until the <a href="#method-open"><code>open()</code></a> method is called.</div>
110 <strong>Code examples:</strong><p>Initialize the dialog with the autoOpen option specified:</p>
111 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ autoOpen: </code><code class="keyword">false</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
112 <p>Get or set the autoOpen option, after initialization:</p>
113 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">autoOpen = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"autoOpen"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"autoOpen"</code><code class="plain">, </code><code class="keyword">false</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
114 </div>
115 <div id="option-buttons" class="api-item">
116 <h3>buttons<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Object">Object</a> or <a href="http://api.jquery.com/Types#Array">Array</a></span>
117 </h3>
118 <div class="default">
119 <strong>Default: </strong><code>{}</code>
120 </div>
121 <div>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.</div>
122 <strong>Multiple types supported:</strong><ul>
123 <li>
124 <strong>Object</strong>: The keys are the button labels and the values are the callbacks for when the associated button is clicked.</li>
125 <li>
126 <strong>Array</strong>: Each element of the array must be an object defining the attributes, properties, and event handlers to set on the button.</li>
127 </ul>
128 <strong>Code examples:</strong><p>Initialize the dialog with the buttons option specified:</p>
129 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ buttons: [ { text: </code><code class="string">"Ok"</code><code class="plain">, click: </code><code class="keyword">function</code><code class="plain">() { $( </code><code class="keyword">this</code> <code class="plain">).dialog( </code><code class="string">"close"</code> <code class="plain">); } ] });</code></div></div></td></tr></tbody></table></div>
130 <p>Get or set the buttons option, after initialization:</p>
131 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">buttons = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"buttons"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"buttons"</code><code class="plain">, [ { text: </code><code class="string">"Ok"</code><code class="plain">, click: </code><code class="keyword">function</code><code class="plain">() { $( </code><code class="keyword">this</code> <code class="plain">).dialog( </code><code class="string">"close"</code> <code class="plain">); } ] );</code></div></div></td></tr></tbody></table></div>
132 </div>
133 <div id="option-closeOnEscape" class="api-item">
134 <h3>closeOnEscape<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Boolean">Boolean</a></span>
135 </h3>
136 <div class="default">
137 <strong>Default: </strong><code>true</code>
138 </div>
139 <div>Specifies whether the dialog should close when it has focus and the user presses the esacpe (ESC) key.</div>
140 <strong>Code examples:</strong><p>Initialize the dialog with the closeOnEscape option specified:</p>
141 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ closeOnEscape: </code><code class="keyword">false</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
142 <p>Get or set the closeOnEscape option, after initialization:</p>
143 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">closeOnEscape = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"closeOnEscape"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"closeOnEscape"</code><code class="plain">, </code><code class="keyword">false</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
144 </div>
145 <div id="option-closeText" class="api-item">
146 <h3>closeText<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#String">String</a></span>
147 </h3>
148 <div class="default">
149 <strong>Default: </strong><code>"close"</code>
150 </div>
151 <div>Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.</div>
152 <strong>Code examples:</strong><p>Initialize the dialog with the closeText option specified:</p>
153 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ closeText: </code><code class="string">"hide"</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
154 <p>Get or set the closeText option, after initialization:</p>
155 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">closeText = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"closeText"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"closeText"</code><code class="plain">, </code><code class="string">"hide"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
156 </div>
157 <div id="option-dialogClass" class="api-item">
158 <h3>dialogClass<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#String">String</a></span>
159 </h3>
160 <div class="default">
161 <strong>Default: </strong><code>""</code>
162 </div>
163 <div>The specified class name(s) will be added to the dialog, for additional theming.</div>
164 <strong>Code examples:</strong><p>Initialize the dialog with the dialogClass option specified:</p>
165 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ dialogClass: </code><code class="string">"alert"</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
166 <p>Get or set the dialogClass option, after initialization:</p>
167 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">dialogClass = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"dialogClass"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"dialogClass"</code><code class="plain">, </code><code class="string">"alert"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
168 </div>
169 <div id="option-draggable" class="api-item">
170 <h3>draggable<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Boolean">Boolean</a></span>
171 </h3>
172 <div class="default">
173 <strong>Default: </strong><code>true</code>
174 </div>
175 <div>If set to <code>true</code>, the dialog will be draggable by the title bar. Requires the <a href="/draggable/">jQuery UI Draggable wiget</a> to be included.</div>
176 <strong>Code examples:</strong><p>Initialize the dialog with the draggable option specified:</p>
177 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ draggable: </code><code class="keyword">false</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
178 <p>Get or set the draggable option, after initialization:</p>
179 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">draggable = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"draggable"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"draggable"</code><code class="plain">, </code><code class="keyword">false</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
180 </div>
181 <div id="option-height" class="api-item">
182 <h3>height<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a> or <a href="http://api.jquery.com/Types#String">String</a></span>
183 </h3>
184 <div class="default">
185 <strong>Default: </strong><code>"auto"</code>
186 </div>
187 <div>The height of the dialog.</div>
188 <strong>Multiple types supported:</strong><ul>
189 <li>
190 <strong>Number</strong>: The height in pixels.</li>
191 <li>
192 <strong>String</strong>: The only supported string value is <code>"auto"</code> which will allow the dialog height to adjust based on its content.</li>
193 </ul>
194 <strong>Code examples:</strong><p>Initialize the dialog with the height option specified:</p>
195 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ height: 400 });</code></div></div></td></tr></tbody></table></div>
196 <p>Get or set the height option, after initialization:</p>
197 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">height = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"height"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"height"</code><code class="plain">, 400 );</code></div></div></td></tr></tbody></table></div>
198 </div>
199 <div id="option-hide" class="api-item">
200 <h3>hide<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a> or <a href="http://api.jquery.com/Types#String">String</a> or <a href="http://api.jquery.com/Types#Object">Object</a></span>
201 </h3>
202 <div class="default">
203 <strong>Default: </strong><code>null</code>
204 </div>
205 <div>If and how to animate the hiding of the dialog.</div>
206 <strong>Multiple types supported:</strong><ul>
207 <li>
208 <strong>Number</strong>: 
209                                         The dialog will fade out while animating the height and width for the specified duration.
210                                 </li>
211 <li>
212 <strong>String</strong>: 
213                                         The dialog will be hidden using the specified jQuery UI effect. See the <a href="/category/effects/">list of effects</a> for possible values.
214                                 </li>
215 <li>
216 <strong>Object</strong>: If the value is an object, then <code>effect</code>, <code>duration</code>, and <code>easing</code> properties may be provided. The <code>effect</code> property must be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If <code>duration</code> or <code>easing</code> is omitted, then the default values will be used.</li>
217 </ul>
218 <strong>Code examples:</strong><p>Initialize the dialog with the hide option specified:</p>
219 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ hide: </code><code class="string">"explode"</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
220 <p>Get or set the hide option, after initialization:</p>
221 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">hide = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"hide"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"hide"</code><code class="plain">, </code><code class="string">"explode"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
222 </div>
223 <div id="option-maxHeight" class="api-item">
224 <h3>maxHeight<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a></span>
225 </h3>
226 <div class="default">
227 <strong>Default: </strong><code>false</code>
228 </div>
229 <div>The maximum height to which the dialog can be resized, in pixels.</div>
230 <strong>Code examples:</strong><p>Initialize the dialog with the maxHeight option specified:</p>
231 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ maxHeight: 600 });</code></div></div></td></tr></tbody></table></div>
232 <p>Get or set the maxHeight option, after initialization:</p>
233 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">maxHeight = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"maxHeight"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"maxHeight"</code><code class="plain">, 600 );</code></div></div></td></tr></tbody></table></div>
234 </div>
235 <div id="option-maxWidth" class="api-item">
236 <h3>maxWidth<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a></span>
237 </h3>
238 <div class="default">
239 <strong>Default: </strong><code>false</code>
240 </div>
241 <div>The maximum width to which the dialog can be resized, in pixels.</div>
242 <strong>Code examples:</strong><p>Initialize the dialog with the maxWidth option specified:</p>
243 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ maxWidth: 600 });</code></div></div></td></tr></tbody></table></div>
244 <p>Get or set the maxWidth option, after initialization:</p>
245 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">maxWidth = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"maxWidth"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"maxWidth"</code><code class="plain">, 600 );</code></div></div></td></tr></tbody></table></div>
246 </div>
247 <div id="option-minHeight" class="api-item">
248 <h3>minHeight<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a></span>
249 </h3>
250 <div class="default">
251 <strong>Default: </strong><code>150</code>
252 </div>
253 <div>The minimum height to which the dialog can be resized, in pixels.</div>
254 <strong>Code examples:</strong><p>Initialize the dialog with the minHeight option specified:</p>
255 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ minHeight: 200 });</code></div></div></td></tr></tbody></table></div>
256 <p>Get or set the minHeight option, after initialization:</p>
257 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">minHeight = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"minHeight"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"minHeight"</code><code class="plain">, 200 );</code></div></div></td></tr></tbody></table></div>
258 </div>
259 <div id="option-minWidth" class="api-item">
260 <h3>minWidth<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a></span>
261 </h3>
262 <div class="default">
263 <strong>Default: </strong><code>150</code>
264 </div>
265 <div>The minimum width to which the dialog can be resized, in pixels.</div>
266 <strong>Code examples:</strong><p>Initialize the dialog with the minWidth option specified:</p>
267 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ minWidth: 200 });</code></div></div></td></tr></tbody></table></div>
268 <p>Get or set the minWidth option, after initialization:</p>
269 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">minWidth = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"minWidth"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"minWidth"</code><code class="plain">, 200 );</code></div></div></td></tr></tbody></table></div>
270 </div>
271 <div id="option-modal" class="api-item">
272 <h3>modal<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Boolean">Boolean</a></span>
273 </h3>
274 <div class="default">
275 <strong>Default: </strong><code>false</code>
276 </div>
277 <div>If set to <code>true</code>, 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.</div>
278 <strong>Code examples:</strong><p>Initialize the dialog with the modal option specified:</p>
279 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ modal: </code><code class="keyword">true</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
280 <p>Get or set the modal option, after initialization:</p>
281 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">modal = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"modal"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"modal"</code><code class="plain">, </code><code class="keyword">true</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
282 </div>
283 <div id="option-position" class="api-item">
284 <h3>position<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Object">Object</a> or <a href="http://api.jquery.com/Types#String">String</a> or <a href="http://api.jquery.com/Types#Array">Array</a></span>
285 </h3>
286 <div class="default">
287 <strong>Default: </strong><code>{ my: "center", at: "center", of: window }</code>
288 </div>
289 <div>
290                                 <p>Specifies where the dialog should be displayed. The dialog will handle collisions such that as much of the dialog is visible as possible.</p>
291                                 <p><em>Note: The <code>String</code> and <code>Array</code> forms are deprecated.</em></p>
292                         </div>
293 <strong>Multiple types supported:</strong><ul>
294 <li>
295 <strong>Object</strong>: Identifies the position of the dialog when opened. The <code>of</code> option defaults to the window, but you can specify another element to position against. You can refer to the <a href="/position">jQuery UI Position</a> utility for more details about the various options.</li>
296 <li>
297 <strong>String</strong>: A string representing the position within the viewport. Possible values: <code>"center"</code>, <code>"left"</code>, <code>"right"</code>, <code>"top"</code>, <code>"bottom"</code>.</li>
298 <li>
299 <strong>Array</strong>: An array containing an <em>x, y</em> coordinate pair in pixel offset from the top left corner of the viewport or the name of a possible string value.</li>
300 </ul>
301 <strong>Code examples:</strong><p>Initialize the dialog with the position option specified:</p>
302 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ position: { my: </code><code class="string">"left top"</code><code class="plain">, at: </code><code class="string">"left bottom"</code><code class="plain">, of: button } });</code></div></div></td></tr></tbody></table></div>
303 <p>Get or set the position option, after initialization:</p>
304 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">position = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"position"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"position"</code><code class="plain">, { my: </code><code class="string">"left top"</code><code class="plain">, at: </code><code class="string">"left bottom"</code><code class="plain">, of: button } );</code></div></div></td></tr></tbody></table></div>
305 </div>
306 <div id="option-resizable" class="api-item">
307 <h3>resizable<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Boolean">Boolean</a></span>
308 </h3>
309 <div class="default">
310 <strong>Default: </strong><code>true</code>
311 </div>
312 <div>If set to <code>true</code>, the dialog will be resizable. Requires the <a href="/resizable/">jQuery UI Resizable widget</a> to be included.</div>
313 <strong>Code examples:</strong><p>Initialize the dialog with the resizable option specified:</p>
314 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ resizable: </code><code class="keyword">false</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
315 <p>Get or set the resizable option, after initialization:</p>
316 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">resizable = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"resizable"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"resizable"</code><code class="plain">, </code><code class="keyword">false</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
317 </div>
318 <div id="option-show" class="api-item">
319 <h3>show<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a> or <a href="http://api.jquery.com/Types#String">String</a> or <a href="http://api.jquery.com/Types#Object">Object</a></span>
320 </h3>
321 <div class="default">
322 <strong>Default: </strong><code>null</code>
323 </div>
324 <div>If and how to animate the showing of the dialog.</div>
325 <strong>Multiple types supported:</strong><ul>
326 <li>
327 <strong>Number</strong>: 
328                                         The dialog will fade in while animating the height and width for the specified duration.
329                                 </li>
330 <li>
331 <strong>String</strong>: 
332                                         The dialog will be shown using the specified jQuery UI effect. See the <a href="/category/effects/">list of effects</a> for possible values.
333                                 </li>
334 <li>
335 <strong>Object</strong>: If the value is an object, then <code>effect</code>, <code>duration</code>, and <code>easing</code> properties may be provided. The <code>effect</code> property must be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If <code>duration</code> or <code>easing</code> is omitted, then the default values will be used.</li>
336 </ul>
337 <strong>Code examples:</strong><p>Initialize the dialog with the show option specified:</p>
338 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ show: </code><code class="string">"slow"</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
339 <p>Get or set the show option, after initialization:</p>
340 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">show = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"show"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"show"</code><code class="plain">, </code><code class="string">"slow"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
341 </div>
342 <div id="option-title" class="api-item">
343 <h3>title<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#String">String</a></span>
344 </h3>
345 <div class="default">
346 <strong>Default: </strong><code>null</code>
347 </div>
348 <div>Specifies the title of the dialog. Any valid HTML may be set as the title. The title can also be specified by the <code>title</code> attribute on the dialog source element.</div>
349 <strong>Code examples:</strong><p>Initialize the dialog with the title option specified:</p>
350 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ title: </code><code class="string">"Dialog Title"</code> <code class="plain">});</code></div></div></td></tr></tbody></table></div>
351 <p>Get or set the title option, after initialization:</p>
352 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">title = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"title"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"title"</code><code class="plain">, </code><code class="string">"Dialog Title"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
353 </div>
354 <div id="option-width" class="api-item">
355 <h3>width<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types#Number">Number</a></span>
356 </h3>
357 <div class="default">
358 <strong>Default: </strong><code>300</code>
359 </div>
360 <div>The width of the dialog, in pixels.</div>
361 <strong>Code examples:</strong><p>Initialize the dialog with the width option specified:</p>
362 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({ width: 500 });</code></div></div></td></tr></tbody></table></div>
363 <p>Get or set the width option, after initialization:</p>
364 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="comments">// getter</code></div><div class="line number2 index1 alt1"><code class="keyword">var</code> <code class="plain">width = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"width"</code> <code class="plain">);</code></div><div class="line number3 index2 alt2">&nbsp;</div><div class="line number4 index3 alt1"><code class="comments">// setter</code></div><div class="line number5 index4 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"width"</code><code class="plain">, 500 );</code></div></div></td></tr></tbody></table></div>
365 </div></section><section id="methods"><header><h2 class="underline">Methods</h2></header><div id="method-close"><div class="api-item first-item">
366 <h3>close()</h3>
367 <div>Closes the dialog.</div>
368 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
369 <div>
370 <strong>Code examples:</strong><p>Invoke the close method:</p>
371 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"close"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
372 </div>
373 </div></div>
374 <div id="method-destroy"><div class="api-item">
375 <h3>destroy()</h3>
376 <div>
377                 Removes the dialog functionality completely. This will return the element back to its pre-init state.
378         </div>
379 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
380 <div>
381 <strong>Code examples:</strong><p>Invoke the destroy method:</p>
382 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"destroy"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
383 </div>
384 </div></div>
385 <div id="method-isOpen"><div class="api-item">
386 <h3>isOpen()<span class="returns">Returns: <a href="http://api.jquery.com/Types#Boolean">Boolean</a></span>
387 </h3>
388 <div>Whether the dialog is currently open.</div>
389 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
390 <div>
391 <strong>Code examples:</strong><p>Invoke the isOpen method:</p>
392 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="keyword">var</code> <code class="plain">isOpen = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"isOpen"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
393 </div>
394 </div></div>
395 <div id="method-moveToTop"><div class="api-item">
396 <h3>moveToTop()</h3>
397 <div>Moves the dialog to the top of the dialog stack.</div>
398 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
399 <div>
400 <strong>Code examples:</strong><p>Invoke the moveToTop method:</p>
401 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"moveToTop"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
402 </div>
403 </div></div>
404 <div id="method-open"><div class="api-item">
405 <h3>open()</h3>
406 <div>Opens the dialog.</div>
407 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
408 <div>
409 <strong>Code examples:</strong><p>Invoke the open method:</p>
410 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"open"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
411 </div>
412 </div></div>
413 <div id="method-option">
414 <div class="api-item">
415 <h3>option( optionName )<span class="returns">Returns: <a href="http://api.jquery.com/Types#Object">Object</a></span>
416 </h3>
417 <div>Gets the value currently associated with the specified <code>optionName</code>.</div>
418 <ul><li>
419 <div><strong>optionName</strong></div>
420 <div>Type: <a href="http://api.jquery.com/Types#String">String</a>
421 </div>
422 <div>The name of the option to get.</div>
423 </li></ul>
424 <div>
425 <strong>Code examples:</strong><p>Invoke the  method:</p>
426 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="keyword">var</code> <code class="plain">isDisabled = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"disabled"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
427 </div>
428 </div>
429 <div class="api-item">
430 <h3>option()<span class="returns">Returns: <a href="http://api.jquery.com/Types#PlainObject">PlainObject</a></span>
431 </h3>
432 <div>Gets an object containing key/value pairs representing the current dialog options hash.</div>
433 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
434 <div>
435 <strong>Code examples:</strong><p>Invoke the  method:</p>
436 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="keyword">var</code> <code class="plain">options = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
437 </div>
438 </div>
439 <div class="api-item">
440 <h3>option( optionName, value )</h3>
441 <div>Sets the value of the dialog option associated with the specified <code>optionName</code>.</div>
442 <ul>
443 <li>
444 <div><strong>optionName</strong></div>
445 <div>Type: <a href="http://api.jquery.com/Types#String">String</a>
446 </div>
447 <div>The name of the option to set.</div>
448 </li>
449 <li>
450 <div><strong>value</strong></div>
451 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
452 </div>
453 <div>A value to set for the option.</div>
454 </li>
455 </ul>
456 <div>
457 <strong>Code examples:</strong><p>Invoke the  method:</p>
458 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, </code><code class="string">"disabled"</code><code class="plain">, </code><code class="keyword">true</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
459 </div>
460 </div>
461 <div class="api-item">
462 <h3>option( options )</h3>
463 <div>Sets one or more options for the dialog.</div>
464 <ul><li>
465 <div><strong>options</strong></div>
466 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
467 </div>
468 <div>A map of option-value pairs to set.</div>
469 </li></ul>
470 <div>
471 <strong>Code examples:</strong><p>Invoke the  method:</p>
472 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"option"</code><code class="plain">, { disabled: </code><code class="keyword">true</code> <code class="plain">} );</code></div></div></td></tr></tbody></table></div>
473 </div>
474 </div>
475 </div>
476 <div id="method-widget"><div class="api-item">
477 <h3>widget()<span class="returns">Returns: <a href="http://api.jquery.com/Types#jQuery">jQuery</a></span>
478 </h3>
479 <div>
480                 Returns a <code>jQuery</code> object containing the generated wrapper.
481         </div>
482 <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul>
483 <div>
484 <strong>Code examples:</strong><p>Invoke the widget method:</p>
485 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="keyword">var</code> <code class="plain">widget = $( </code><code class="string">".selector"</code> <code class="plain">).dialog( </code><code class="string">"widget"</code> <code class="plain">);</code></div></div></td></tr></tbody></table></div>
486 </div>
487 </div></div></section><section id="events"><header><h2 class="underline">Events</h2></header><div id="event-beforeClose" class="api-item first-item">
488 <h3>beforeClose( event, ui )<span class="returns">Type: <code>dialogbeforeclose</code></span>
489 </h3>
490 <div>Triggered when a dialog is about to close. If canceled, the dialog will not close.</div>
491 <ul>
492 <li>
493 <div><strong>event</strong></div>
494 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
495 </div>
496 <div></div>
497 </li>
498 <li>
499 <div><strong>ui</strong></div>
500 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
501 </div>
502 <div></div>
503 </li>
504 </ul>
505 <div>
506 <strong>Code examples:</strong><p>Initialize the dialog with the beforeClose callback specified:</p>
507 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">beforeClose: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
508 <p>Bind an event listener to the dialogbeforeclose event:</p>
509 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogbeforeclose"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
510 </div>
511 </div>
512 <div id="event-close" class="api-item">
513 <h3>close( event, ui )<span class="returns">Type: <code>dialogclose</code></span>
514 </h3>
515 <div>Triggered when the dialog is closed.</div>
516 <ul>
517 <li>
518 <div><strong>event</strong></div>
519 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
520 </div>
521 <div></div>
522 </li>
523 <li>
524 <div><strong>ui</strong></div>
525 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
526 </div>
527 <div></div>
528 </li>
529 </ul>
530 <div>
531 <strong>Code examples:</strong><p>Initialize the dialog with the close callback specified:</p>
532 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">close: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
533 <p>Bind an event listener to the dialogclose event:</p>
534 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogclose"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
535 </div>
536 </div>
537 <div id="event-create" class="api-item">
538 <h3>create( event, ui )<span class="returns">Type: <code>dialogcreate</code></span>
539 </h3>
540 <div>
541                 Triggered when the dialog is created.
542         </div>
543 <ul>
544 <li>
545 <div><strong>event</strong></div>
546 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
547 </div>
548 <div></div>
549 </li>
550 <li>
551 <div><strong>ui</strong></div>
552 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
553 </div>
554 <div></div>
555 </li>
556 </ul>
557 <div>
558 <strong>Code examples:</strong><p>Initialize the dialog with the create callback specified:</p>
559 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">create: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
560 <p>Bind an event listener to the dialogcreate event:</p>
561 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogcreate"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
562 </div>
563 </div>
564 <div id="event-drag" class="api-item">
565 <h3>drag( event, ui )<span class="returns">Type: <code>dialogdrag</code></span>
566 </h3>
567 <div>Triggered while the dialog is being dragged.</div>
568 <ul>
569 <li>
570 <div><strong>event</strong></div>
571 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
572 </div>
573 <div></div>
574 </li>
575 <li>
576 <div><strong>ui</strong></div>
577 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
578 </div>
579 <div></div>
580 <ul>
581 <li>
582 <div><strong>position</strong></div>
583 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
584 </div>
585 <div>The current CSS position of the dialog.</div>
586 </li>
587 <li>
588 <div><strong>offset</strong></div>
589 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
590 </div>
591 <div>The current offset position of the dialog.</div>
592 </li>
593 </ul>
594 </li>
595 </ul>
596 <div>
597 <strong>Code examples:</strong><p>Initialize the dialog with the drag callback specified:</p>
598 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">drag: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
599 <p>Bind an event listener to the dialogdrag event:</p>
600 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogdrag"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
601 </div>
602 </div>
603 <div id="event-dragStart" class="api-item">
604 <h3>dragStart( event, ui )<span class="returns">Type: <code>dialogdragstart</code></span>
605 </h3>
606 <div>Triggered when the user starts dragging the dialog.</div>
607 <ul>
608 <li>
609 <div><strong>event</strong></div>
610 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
611 </div>
612 <div></div>
613 </li>
614 <li>
615 <div><strong>ui</strong></div>
616 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
617 </div>
618 <div></div>
619 <ul>
620 <li>
621 <div><strong>position</strong></div>
622 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
623 </div>
624 <div>The current CSS position of the dialog.</div>
625 </li>
626 <li>
627 <div><strong>offset</strong></div>
628 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
629 </div>
630 <div>The current offset position of the dialog.</div>
631 </li>
632 </ul>
633 </li>
634 </ul>
635 <div>
636 <strong>Code examples:</strong><p>Initialize the dialog with the dragStart callback specified:</p>
637 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">dragStart: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
638 <p>Bind an event listener to the dialogdragstart event:</p>
639 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogdragstart"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
640 </div>
641 </div>
642 <div id="event-dragStop" class="api-item">
643 <h3>dragStop( event, ui )<span class="returns">Type: <code>dialogdragstop</code></span>
644 </h3>
645 <div>Triggered after the dialog has been dragged.</div>
646 <ul>
647 <li>
648 <div><strong>event</strong></div>
649 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
650 </div>
651 <div></div>
652 </li>
653 <li>
654 <div><strong>ui</strong></div>
655 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
656 </div>
657 <div></div>
658 <ul>
659 <li>
660 <div><strong>position</strong></div>
661 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
662 </div>
663 <div>The current CSS position of the dialog.</div>
664 </li>
665 <li>
666 <div><strong>offset</strong></div>
667 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
668 </div>
669 <div>The current offset position of the dialog.</div>
670 </li>
671 </ul>
672 </li>
673 </ul>
674 <div>
675 <strong>Code examples:</strong><p>Initialize the dialog with the dragStop callback specified:</p>
676 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">dragStop: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
677 <p>Bind an event listener to the dialogdragstop event:</p>
678 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogdragstop"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
679 </div>
680 </div>
681 <div id="event-focus" class="api-item">
682 <h3>focus( event, ui )<span class="returns">Type: <code>dialogfocus</code></span>
683 </h3>
684 <div>Triggered when the dialog gains focus.</div>
685 <ul>
686 <li>
687 <div><strong>event</strong></div>
688 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
689 </div>
690 <div></div>
691 </li>
692 <li>
693 <div><strong>ui</strong></div>
694 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
695 </div>
696 <div></div>
697 </li>
698 </ul>
699 <div>
700 <strong>Code examples:</strong><p>Initialize the dialog with the focus callback specified:</p>
701 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">focus: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
702 <p>Bind an event listener to the dialogfocus event:</p>
703 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogfocus"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
704 </div>
705 </div>
706 <div id="event-open" class="api-item">
707 <h3>open( event, ui )<span class="returns">Type: <code>dialogopen</code></span>
708 </h3>
709 <div>Triggered when the dialog is opened.</div>
710 <ul>
711 <li>
712 <div><strong>event</strong></div>
713 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
714 </div>
715 <div></div>
716 </li>
717 <li>
718 <div><strong>ui</strong></div>
719 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
720 </div>
721 <div></div>
722 </li>
723 </ul>
724 <div>
725 <strong>Code examples:</strong><p>Initialize the dialog with the open callback specified:</p>
726 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">open: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
727 <p>Bind an event listener to the dialogopen event:</p>
728 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogopen"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
729 </div>
730 </div>
731 <div id="event-resize" class="api-item">
732 <h3>resize( event, ui )<span class="returns">Type: <code>dialogresize</code></span>
733 </h3>
734 <div>Triggered while the dialog is being resized.</div>
735 <ul>
736 <li>
737 <div><strong>event</strong></div>
738 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
739 </div>
740 <div></div>
741 </li>
742 <li>
743 <div><strong>ui</strong></div>
744 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
745 </div>
746 <div></div>
747 <ul>
748 <li>
749 <div><strong>orginalPosition</strong></div>
750 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
751 </div>
752 <div>The CSS position of the dialog prior to being resized.</div>
753 </li>
754 <li>
755 <div><strong>position</strong></div>
756 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
757 </div>
758 <div>The current CSS position of the dialog.</div>
759 </li>
760 <li>
761 <div><strong>originalSize</strong></div>
762 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
763 </div>
764 <div>The size of the dialog prior to being resized.</div>
765 </li>
766 <li>
767 <div><strong>size</strong></div>
768 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
769 </div>
770 <div>The current size of the dialog.</div>
771 </li>
772 </ul>
773 </li>
774 </ul>
775 <div>
776 <strong>Code examples:</strong><p>Initialize the dialog with the resize callback specified:</p>
777 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">resize: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
778 <p>Bind an event listener to the dialogresize event:</p>
779 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogresize"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
780 </div>
781 </div>
782 <div id="event-resizeStart" class="api-item">
783 <h3>resizeStart( event, ui )<span class="returns">Type: <code>dialogresizestart</code></span>
784 </h3>
785 <div>Triggered when the user starts resizing the dialog.</div>
786 <ul>
787 <li>
788 <div><strong>event</strong></div>
789 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
790 </div>
791 <div></div>
792 </li>
793 <li>
794 <div><strong>ui</strong></div>
795 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
796 </div>
797 <div></div>
798 <ul>
799 <li>
800 <div><strong>orginalPosition</strong></div>
801 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
802 </div>
803 <div>The CSS position of the dialog prior to being resized.</div>
804 </li>
805 <li>
806 <div><strong>position</strong></div>
807 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
808 </div>
809 <div>The current CSS position of the dialog.</div>
810 </li>
811 <li>
812 <div><strong>originalSize</strong></div>
813 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
814 </div>
815 <div>The size of the dialog prior to being resized.</div>
816 </li>
817 <li>
818 <div><strong>size</strong></div>
819 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
820 </div>
821 <div>The current size of the dialog.</div>
822 </li>
823 </ul>
824 </li>
825 </ul>
826 <div>
827 <strong>Code examples:</strong><p>Initialize the dialog with the resizeStart callback specified:</p>
828 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">resizeStart: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
829 <p>Bind an event listener to the dialogresizestart event:</p>
830 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogresizestart"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
831 </div>
832 </div>
833 <div id="event-resizeStop" class="api-item">
834 <h3>resizeStop( event, ui )<span class="returns">Type: <code>dialogresizestop</code></span>
835 </h3>
836 <div>Triggered after the dialog has been resized.</div>
837 <ul>
838 <li>
839 <div><strong>event</strong></div>
840 <div>Type: <a href="http://api.jquery.com/Types#Event">Event</a>
841 </div>
842 <div></div>
843 </li>
844 <li>
845 <div><strong>ui</strong></div>
846 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
847 </div>
848 <div></div>
849 <ul>
850 <li>
851 <div><strong>orginalPosition</strong></div>
852 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
853 </div>
854 <div>The CSS position of the dialog prior to being resized.</div>
855 </li>
856 <li>
857 <div><strong>position</strong></div>
858 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
859 </div>
860 <div>The current CSS position of the dialog.</div>
861 </li>
862 <li>
863 <div><strong>originalSize</strong></div>
864 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
865 </div>
866 <div>The size of the dialog prior to being resized.</div>
867 </li>
868 <li>
869 <div><strong>size</strong></div>
870 <div>Type: <a href="http://api.jquery.com/Types#Object">Object</a>
871 </div>
872 <div>The current size of the dialog.</div>
873 </li>
874 </ul>
875 </li>
876 </ul>
877 <div>
878 <strong>Code examples:</strong><p>Initialize the dialog with the resizeStop callback specified:</p>
879 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).dialog({</code></div><div class="line number2 index1 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">resizeStop: </code><code class="keyword">function</code><code class="plain">( event, ui ) {}</code></div><div class="line number3 index2 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
880 <p>Bind an event listener to the dialogresizestop event:</p>
881 <div class="syntaxhighlighter nogutter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$( </code><code class="string">".selector"</code> <code class="plain">).on( </code><code class="string">"dialogresizestop"</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">( event, ui ) {} );</code></div></div></td></tr></tbody></table></div>
882 </div>
883 </div></section><section class="entry-examples" id="entry-examples"><header><h2 class="underline">Example:</h2></header><div class="entry-example" id="example-0">
884 <h4><span class="desc">A simple jQuery UI Dialog</span></h4>
885 <div class="syntaxhighlighter  "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div><div class="line number2 index1 alt1">2</div><div class="line number3 index2 alt2">3</div><div class="line number4 index3 alt1">4</div><div class="line number5 index4 alt2">5</div><div class="line number6 index5 alt1">6</div><div class="line number7 index6 alt2">7</div><div class="line number8 index7 alt1">8</div><div class="line number9 index8 alt2">9</div><div class="line number10 index9 alt1">10</div><div class="line number11 index10 alt2">11</div><div class="line number12 index11 alt1">12</div><div class="line number13 index12 alt2">13</div><div class="line number14 index13 alt1">14</div><div class="line number15 index14 alt2">15</div><div class="line number16 index15 alt1">16</div><div class="line number17 index16 alt2">17</div><div class="line number18 index17 alt1">18</div><div class="line number19 index18 alt2">19</div><div class="line number20 index19 alt1">20</div><div class="line number21 index20 alt2">21</div><div class="line number22 index21 alt1">22</div><div class="line number23 index22 alt2">23</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">&lt;!doctype html&gt;</code></div><div class="line number2 index1 alt1"><code class="plain">&lt;</code><code class="keyword">html</code> <code class="color1">lang</code><code class="plain">=</code><code class="string">"en"</code><code class="plain">&gt;</code></div><div class="line number3 index2 alt2"><code class="plain">&lt;</code><code class="keyword">head</code><code class="plain">&gt;</code></div><div class="line number4 index3 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">&lt;</code><code class="keyword">meta</code> <code class="color1">charset</code><code class="plain">=</code><code class="string">"utf-8"</code><code class="plain">&gt;</code></div><div class="line number5 index4 alt2"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">&lt;</code><code class="keyword">title</code><code class="plain">&gt;dialog demo&lt;/</code><code class="keyword">title</code><code class="plain">&gt;</code></div><div class="line number6 index5 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">&lt;</code><code class="keyword">link</code> <code class="color1">rel</code><code class="plain">=</code><code class="string">"stylesheet"</code> <code class="color1">href</code><code class="plain">=</code><code class="string">"<a href="http://code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css">http://code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css</a>"</code><code class="plain">&gt;</code></div><div class="line number7 index6 alt2"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">&lt;</code><code class="keyword">script</code> <code class="color1">src</code><code class="plain">=</code><code class="string">"<a href="http://code.jquery.com/jquery-1.8.3.js">http://code.jquery.com/jquery-1.8.3.js</a>"</code><code class="plain">&gt;&lt;/</code><code class="keyword">script</code><code class="plain">&gt;</code></div><div class="line number8 index7 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">&lt;</code><code class="keyword">script</code> <code class="color1">src</code><code class="plain">=</code><code class="string">"<a href="http://code.jquery.com/ui/1.9.2/jquery-ui.js">http://code.jquery.com/ui/1.9.2/jquery-ui.js</a>"</code><code class="plain">&gt;&lt;/</code><code class="keyword">script</code><code class="plain">&gt;</code></div><div class="line number9 index8 alt2"><code class="plain">&lt;/</code><code class="keyword">head</code><code class="plain">&gt;</code></div><div class="line number10 index9 alt1"><code class="plain">&lt;</code><code class="keyword">body</code><code class="plain">&gt;</code></div><div class="line number11 index10 alt2">&nbsp;</div><div class="line number12 index11 alt1"><code class="plain">&lt;</code><code class="keyword">button</code> <code class="color1">id</code><code class="plain">=</code><code class="string">"opener"</code><code class="plain">&gt;open the dialog&lt;/</code><code class="keyword">button</code><code class="plain">&gt;</code></div><div class="line number13 index12 alt2"><code class="plain">&lt;</code><code class="keyword">div</code> <code class="color1">id</code><code class="plain">=</code><code class="string">"dialog"</code> <code class="color1">title</code><code class="plain">=</code><code class="string">"Dialog Title"</code><code class="plain">&gt;I'm a dialog&lt;/</code><code class="keyword">div</code><code class="plain">&gt;</code></div><div class="line number14 index13 alt1">&nbsp;</div><div class="line number15 index14 alt2"><code class="plain">&lt;</code><code class="keyword">script</code><code class="plain">&gt;</code></div><div class="line number16 index15 alt1"><code class="plain">$( "#dialog" ).dialog({ autoOpen: false });</code></div><div class="line number17 index16 alt2"><code class="plain">$( "#opener" ).click(function() {</code></div><div class="line number18 index17 alt1"><code class="undefined spaces">&nbsp;&nbsp;&nbsp;&nbsp;</code><code class="plain">$( "#dialog" ).dialog( "open" );</code></div><div class="line number19 index18 alt2"><code class="plain">});</code></div><div class="line number20 index19 alt1"><code class="plain">&lt;/</code><code class="keyword">script</code><code class="plain">&gt;</code></div><div class="line number21 index20 alt2">&nbsp;</div><div class="line number22 index21 alt1"><code class="plain">&lt;/</code><code class="keyword">body</code><code class="plain">&gt;</code></div><div class="line number23 index22 alt2"><code class="plain">&lt;/</code><code class="keyword">html</code><code class="plain">&gt;</code></div></div></td></tr></tbody></table></div>
886 <h4>Demo:</h4>
887 <div class="demo code-demo"></div>
888 </div></section>
889 </div></article>
890
891 </body>
892 </html>

UCC git Repository :: git.ucc.asn.au