jqwidgets-framework

<!DOCTYPE html> <html lang="en"> <head> <link rel="stylesheet" href="../../../../Styles/jqx.apireference.css" type="text/css" /> <script type="text/javascript" src="../../../../scripts/jquery-1.11.1.min.js"></script> <script type="text/javascript" src="../../../../scripts/documentation.js"></script> <meta name="keywords" content="jQuery, Button, Toggle Button, Repeat Button, Link Button, Help Documentation" /> <meta name="description" content="This page represents the help documentation of the jqxButton, jqxToggleButton, jqxRepeatButton and jqxLinkButton widgets." /> <title>jqxDropDownButton</title> <script type="text/javascript"> $(document).ready(function () { $(".documentation-option-type-click").click(function (event) { $(event.target).parents('tr').next().find(".property-content").toggle(); }); }); </script> </head> <body> <div id="dropdownbutton"> <div style="margin: 5px;" id="properties3"> <h2 class="documentation-top-header">Properties</h2> <table class="documentation-table"> <tr> <th>Name </th> <th>Type </th> <th>Default </th> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span32'>animationType</span> </td> <td> <span>String</span> </td> <td>'slide' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the type of the animation. </p> <b>Possible Values:</b> <br /> <pre><code>'fade'</code></pre> <pre><code>'slide'</code></pre> <pre><code>'none'</code></pre> <h4>Code example</h4> <p> Set the animationType property </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({animationType: 'none'});</code></pre> <p> Get the <code>animationType</code> property. </p> <pre><code>var animationType = $('#jqxDropDownButton').jqxDropDownButton('animationType');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/dwHWw/">animationType is set to 'fade'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span50'>autoOpen</span> </td> <td> <span>Boolean</span> </td> <td>false </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets whether the DropDown is automatically opened when the mouse cursor is moved over the widget. </p> <h4>Code example</h4> <p> Set the <code>autoOpen</code> property. </p> <pre><code>$("#jqxDropDownButton").jqxDropDownButton({ autoOpen: true }); </code></pre> <p> Get the <code>autoOpen</code> property. </p> <pre><code>var autoOpen = $('#jqxDropDownButton').jqxDropDownButton('autoOpen');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/GRgQ6/">autoOpen is set to true</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span31'>closeDelay</span> </td> <td> <span>Number</span> </td> <td>400 </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the delay of the 'close' animation. </p> <h4>Code example</h4> <p> Set the closeDelay property </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({closeDelay: 200});</code></pre> <p> Get the <code>closeDelay</code> property. </p> <pre><code>var closeDelay = $('#jqxDropDownButton').jqxDropDownButton('closeDelay');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/KS2fL/">closeDelay is set to 2000</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span22'>disabled</span> </td> <td> <span>Boolean</span> </td> <td>false </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Enables or disables the dropDownButton. </p> <h4>Code examples</h4> <p> Set the <code>disabled</code> property. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({disabled: false });</code></pre> <p> Get the <code>disabled</code> property. </p> <pre><code>var disabled = $('#jqxDropDownButton').jqxDropDownButton('disabled');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/8rqtD/">disabled is set to true</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span29'>dropDownHorizontalAlignment</span> </td> <td> <span>String</span> </td> <td>'left' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the DropDown's alignment. </p> <b>Possible values: </b> <br /> <pre><code>'left' </code></pre> <pre><code>'right'</code></pre> <h4>Code example</h4> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({ dropDownHorizontalAlignment: 'right'}); </code></pre> <p> Get the <code>dropDownHorizontalAlignment</code> property. </p> <pre><code>var dropDownHorizontalAlignment = $('#jqxDropDownButton').jqxDropDownButton('dropDownHorizontalAlignment');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/LShym/">dropDownHorizontalAlignment is set to 'right'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span85'>dropDownVerticalAlignment</span> </td> <td> <span>String</span> </td> <td>'bottom' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the DropDown's alignment. </p> <b>Possible Values:</b> <br /> <pre><code>'top'</code></pre> <pre><code>'bottom'</code></pre> <h4>Code example</h4> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({ dropDownVerticalAlignment: 'top'}); </code></pre> <p> Get the <code>dropDownVerticalAlignment</code> property. </p> <pre><code>var dropDownVerticalAlignment = $('#jqxDropDownButton').jqxDropDownButton('dropDownVerticalAlignment');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/yg1dp2fb/">dropDownVerticalAlignment is set to "top"</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span28'>enableBrowserBoundsDetection</span> </td> <td> <span>Boolean</span> </td> <td>false </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> When this property is set to true, the popup may open above the button, if there's not enough available space below the button. </p> <h4>Code example</h4> <p> Set the <code>enableBrowserBoundsDetection</code> property. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({ enableBrowserBoundsDetection: false}); </code></pre> <p> Get the <code>enableBrowserBoundsDetection</code> property. </p> <pre><code>var enableBrowserBoundsDetection = $('#jqxDropDownButton').jqxDropDownButton('enableBrowserBoundsDetection');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/4eTCk/">enableBrowserBoundsDetection is set to true</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span23'>height</span> </td> <td> <span>Number/String</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the button's height. </p> <h4>Code examples</h4> <p> Set the <code>height</code> property. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({ height: '25px' }); </code></pre> <p> Get the <code>height</code> property. </p> <pre><code>var height = $('#jqxDropDownButton').jqxDropDownButton('height');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/LLJEV/">height is set to 19</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span60'>initContent</span> </td> <td> <span>Function</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets a function which initializes the button's content. </p> <h4>Code examples</h4> <p> Set the <code>initContent</code> property. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({ initContent: function() { }}); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/o10v3wr3/">initContent is set</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span30'>openDelay</span> </td> <td> <span>Number</span> </td> <td>350 </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the delay of the 'open' animation. </p> <h4>Code example</h4> <p>Set the <code>openDelay</code> property</p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({openDelay: 200});</code></pre> <p>Get the <code>openDelay</code> property.</p> <pre><code>var openDelay = $('#jqxDropDownButton').jqxDropDownButton('openDelay');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/Psfj5/">openDelay is set to 2000</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span73'>popupZIndex</span> </td> <td> <span>Number</span> </td> <td>20000 </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the popup's z-index. </p> <h4>Code example</h4> <p> Set the <code>popupZIndex</code> property. </p> <pre><code>$("#jqxDropDownButton").jqxDropDownButton({popupZIndex: 999999});</code></pre> <p> Get the <code>popupZIndex</code> property. </p> <pre><code>var zIndex = $('#jqxDropDownButton').jqxDropDownButton('popupZIndex'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/GZk2h/">popupZIndex is set to 999999</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span25'>rtl</span> </td> <td> <span>Boolean</span> </td> <td>false </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p>Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.</p> <h4>Code example</h4> <p> Set the <code>rtl</code> property. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({rtl : true}); </code></pre> <p> Get the <code>rtl</code> property. </p> <pre><code>var rtl = $('#jqxDropDownButton').jqxDropDownButton('rtl'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/jmTwk/">rtl is set to true</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span86'>template</span> </td> <td> <span>String</span> </td> <td>'default' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Determines the template as an alternative of the default styles. </p> <b>Possible Values:</b> <br /> <pre><code>'default' - the default template. The style depends only on the "theme" property value.</code></pre> <pre><code>'primary' - dark blue style for extra visual weight.</code></pre> <pre><code>'success' - green style for successful or positive action.</code></pre> <pre><code>'warning' - orange style which indicates caution.</code></pre> <pre><code>'danger' - red style which indicates a dangerous or negative action.</code></pre> <pre><code>'info' - blue button, not tied to a semantic action or use.</code></pre> <h4>Code examples</h4> <p> Set the <code>template</code> property. </p> <pre><code>$("#jqxDropDownButton").jqxDropDownButton({ template: 'primary'});</code></pre> <p> Get the <code>template</code> property. </p> <pre><code>var template = $('#jqxDropDownButton').jqxDropDownButton('template');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/c675Lngu/">template is set to 'success'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span26'>theme</span> </td> <td> <span>String</span> </td> <td>'' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets the widget's theme. </p> jQWidgets uses a pair of css files - jqx.base.css and jqx.[theme name].css. The base stylesheet creates the styles related to the widget's layout like margin, padding, border-width, position. The second css file applies the widget's colors and backgrounds. The jqx.base.css should be included before the second CSS file. In order to set a theme, you need to do the following: <ul> <li>Include the theme's CSS file after jqx.base.css.<br /> The following code example adds the 'energyblue' theme. <pre><code> <pre><code><link rel="stylesheet" href="../../../../jqwidgets/styles/jqx.base.css" type="text/css" /> <link rel="stylesheet" href="../../../../jqwidgets/styles/jqx.energyblue.css" type="text/css" /> </code></pre> </code></pre> </li> <li>Set the widget's theme property to 'energyblue' when you initialize it. </li> </ul> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/rpvcC/">theme is set to 'energyblue'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span24'>width</span> </td> <td> <span>Number/String</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the button's width. </p> <h4>Code examples</h4> <p> Set the <code>width</code> property. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton({ width: '250px'}); </code></pre> <p> Get the <code>width</code> property. </p> <pre><code>var width = $('#jqxDropDownButton').jqxDropDownButton('width');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/RhBkq/">width is set to 150</a> </div> </div> </td> </tr> <tr> <td colspan='3' style='width: 100%'> <h2 class="documentation-top-header">Events</h2> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span47'>close</span> </td> <td> <span>Event</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> This event is triggered when the button's popup is closed. </p> <h4>Code examples</h4> <p> Bind to the <code>close</code> event by type: jqxDropDownButton. </p> <pre><code>$('#jqxDropDownButton').on('close', function () { // Some code here. }); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/Busec/">Bind to the close event by type: jqxDropDownButton.</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span46'>open</span> </td> <td> <span>Event</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> This event is triggered when the button's popup is opened. </p> <h4>Code examples</h4> <p> Bind to the <code>open</code> event by type: jqxDropDownButton. </p> <pre><code>$('#jqxDropDownButton').on('open', function () { // Some code here. }); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/jvbwx/">Bind to the open event by type: jqxDropDownButton.</a> </div> </div> </td> </tr> <tr> <td colspan='3' style='width: 100%'> <h2 class="documentation-top-header">Methods</h2> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span57'>close</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Hides the button's content. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples</h4> <p> Invoke the <code>close</code> method. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton('close'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/U3kAq/">closes the jqxDropDownButton </a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span68'>destroy</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Destroys the widget. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples</h4> <p> Invoke the <code>destroy</code> method. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton('destroy'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/XpFYG/">destroys the jqxDropDownButton </a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span58'>focus</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Focuses the widget. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples</h4> <p> Invoke the <code>focus</code> method. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton('focus'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/XpFYG/">focuses the jqxDropDownButton </a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span>getContent</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Gets the button's content. The returned value is the button's content set through the "setContent" method. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>Object</em> - jQuery object. </div> <h4>Code examples</h4> <p> Invoke the <code>getContent</code> method. </p> <pre><code>var content = $('#jqxDropDownButton').jqxDropDownButton('getContent'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/5G8nf/">gets the content of the jqxDropDownButton</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span71'>isOpened</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Returns true, if the drop down is opened. Otherwise returns false. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>Boolean</em> </div> <h4>Code example</h4> <p> Invoke the <code>isOpened</code> method. </p> <pre><code>var opened = $("#jqxDropDownButton").jqxDropDownButton('isOpened' ); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/wn2ef/">determins whether the popup is opened</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span56'>open</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Shows the button's content. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples</h4> <p> Invoke the <code>open</code> method. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton('open'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/r7xqe/">opens the jqxDropDownButton </a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span49'>setContent</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets the button's content. The parameter could be a "string" or "html". </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>content</em></td> <td>String</td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples</h4> <p> Invoke the <code>setContent</code> method. </p> <pre><code>$('#jqxDropDownButton').jqxDropDownButton('setContent', 'my content'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/LW22H/">sets the content of the jqxDropDownButton</a> </div> </div> </td> </tr> </table> <br /> </div> </div> </body> </html>