Clear Up
SharpKit Reference

DialogOptions Class

Options JSON object for Dialog

Namespace: SharpKit.jQuery

Base Types

System.Object

Constructors

Name Description
DialogOptions()

Properties

Name Description
autoOpen When autoOpen is true the dialog will open automatically when dialog is called. If false it will stay hidden until .dialog("open") is called on it. Default: true
beforeclose This event is triggered when a dialog attempts to close. If the beforeclose event handler (callback function) returns false, the close will be prevented. Default: null
bgiframe When true, the bgiframe plugin will be used, to fix the issue in IE6 where select boxes show on top of other elements, regardless of zIndex. Requires including the bgiframe plugin. Future versions may not require a separate plugin. Default: false
buttons Specifies which buttons should be displayed on the dialog. The property key is the text of the button. The value is the callback function for when the button is clicked. 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. Default: { }
buttonsClicks Specifies which buttons should be displayed on the dialog. The property key is the text of the button. The value is the callback function for when the button is clicked. 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. Default: { }
close This event is triggered when the dialog is closed. Default: null
closeOnEscape Specifies whether the dialog should close when it has focus and the user presses the esacpe (ESC) key. Default: true
create This event is triggered when dialog is created.
dialogClass The specified class name(s) will be added to the dialog, for additional theming. Default: ''
disabled Disables (true) or enables (false) the button. Can be set when initialising (first creating) the button. Default:false
drag This event is triggered when the dialog is dragged. Default: null
draggable If set to true, the dialog will be draggable will be draggable by the titlebar. Default: true
dragStart This event is triggered at the beginning of the dialog being dragged. Default: null
dragStop This event is triggered after the dialog has been dragged. Default: null
focus This event is triggered when the dialog gains focus. Default: null
height The height of the dialog, in pixels. Default: 'auto'
hide The effect to be used when the dialog is closed. Default: null
maxHeight The maximum height to which the dialog can be resized, in pixels. Default: false
maxWidth The maximum width to which the dialog can be resized, in pixels. Default: false
minHeight The minimum height to which the dialog can be resized, in pixels. Default: 150
minWidth The minimum width to which the dialog can be resized, in pixels. Default: 150
modal If set to true, the dialog will have modal behavior; other items on the page will be disabled (i.e. cannot be interacted with). Modal dialogs create an overlay below the dialog but above other page elements. Default: false
open This event is triggered when dialog is opened. Default: null
position Specifies where the dialog should be displayed. Possible values: 'center', 'left', 'right', 'top', 'bottom', or an array containing a coordinate pair (in pixel offset from top left of viewport) or the possible string values (e.g. ['right','top'] for top right corner). Default: 'center' Types: String, Array
resizable If set to true, the dialog will be resizeable. Default: true
resize This event is triggered when the dialog is resized. Default: null
resizeStart This event is triggered at the beginning of the dialog being resized. Default: null
resizeStop This event is triggered after the dialog has been resized. Default: null
show The effect to be used when the dialog is opened. Default: null
stack Specifies whether the dialog will stack on top of other dialogs. This will cause the dialog to move to the front of other dialogs when it gains focus. Default: true
title Specifies the title of the dialog. The title can also be specified by the title attribute on the dialog source element. Default: ''
width The width of the dialog, in pixels. Default: 300
zIndex The starting z-index for the dialog. Default: 1000
© Copyright 2005-2011 SharpKit. All rights reserved.