C# Class Fluqi.Widget.jDialog.Options

A set of properties to apply to a set of jQuery UI AutoComplete.

Inheritance: Core.Options

Datei anzeigen Open project: toepoke/Fluqi

Public Methods

Method	Description
AddButton ( string label, string methodSource ) : Options	Adds a button onto the dialog.
SetAutoOpen ( bool autoOpen ) : Options	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.
SetCloseOnEscape ( bool closeOnEscape ) : Options	Specifies whether the dialog should close when it has focus and the user presses the esacpe (ESC) key.
SetCloseText ( string closeText ) : Options	Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.
SetDialogClass ( string dialogClass ) : Options	The specified class name(s) will be added to the dialog, for additional theming.
SetDisabled ( bool disable ) : Options	Disables (true) or enables (false) the dialog. Can be set when initialising (first creating) the dialog.
SetDraggable ( bool draggable ) : Options	If set to true, the dialog will be draggable will be draggable by the titlebar.
SetHeight ( int height ) : Options	The height of the dialog, in pixels. Specifying 'auto' is also supported to make the dialog adjust based on its content.
SetHeight ( string height ) : Options	The height of the dialog, in pixels. Specifying 'auto' is also supported to make the dialog adjust based on its content.
SetHideEffect ( Core effect ) : Options	The effect to be used when the dialog is closed.
SetHideEffect ( string hide ) : Options	The effect to be used when the dialog is closed.
SetHideMethod ( string hideMethod ) : Options	Function to use when the dialog is closed.
SetMaxHeight ( int maxHeight ) : Options	The maximum height to which the dialog can be resized, in pixels.
SetMaxHeight ( string maxHeight ) : Options	The maximum height to which the dialog can be resized, in pixels.
SetMaxWidth ( int maxWidth ) : Options	The maximum width to which the dialog can be resized, in pixels.
SetMaxWidth ( string maxWidth ) : Options	The maximum width to which the dialog can be resized, in pixels.
SetMinHeight ( int minHeight ) : Options	The minimum height to which the dialog can be resized, in pixels.
SetMinWidth ( int minWidth ) : Options	The minimum width to which the dialog can be resized, in pixels.
SetModal ( bool modal ) : Options	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.
SetPosition ( Core position ) : Options	Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( Core x, Core y ) : Options	Specifies where the dialog should be displayed. Possible values: Two strings containing x,y position string values (e.g. ['right','top'] for top right corner)
SetPosition ( int x, int y ) : Options	Specifies where the dialog should be displayed. Possible values: Two values containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. 350, 100)
SetPosition ( string position ) : Options	Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( string x, string y ) : Options	Specifies where the dialog should be displayed. Possible values: Two strings containing x,y position string values (e.g. ['right','top'] for top right corner)
SetResizable ( bool resizable ) : Options	If set to true, the dialog will be resizable.
SetShowEffect ( Core effect ) : Options	The effect to be used when the dialog is opened.
SetShowEffect ( string show ) : Options	The effect to be used when the dialog is opened.
SetShowMethod ( string showMethod ) : Options	The effect to be used when the dialog is opened.
SetStack ( bool stack ) : Options	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.
SetTitle ( string title ) : Options	Specifies the title of the dialog. Any valid HTML may be set as the title. The title can also be specified by the title attribute on the dialog source element.
SetWidth ( int width ) : Options	The width of the dialog, in pixels.
SetZIndex ( int zIndex ) : Options	The starting z-index for the dialog.

Method Details

AddButton() public method

Adds a button onto the dialog.

public AddButton ( string label, string methodSource ) : Options
label	string	Label on the button the user will see.
methodSource	string	JavaScript to call when the button is clicked.
return	Options

SetAutoOpen() public method

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.

public SetAutoOpen ( bool autoOpen ) : Options
autoOpen	bool
return	Options

SetCloseOnEscape() public method

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

public SetCloseOnEscape ( bool closeOnEscape ) : Options
closeOnEscape	bool
return	Options

SetCloseText() public method

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

public SetCloseText ( string closeText ) : Options
closeText	string
return	Options

SetDialogClass() public method

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

public SetDialogClass ( string dialogClass ) : Options
dialogClass	string
return	Options

SetDisabled() public method

Disables (true) or enables (false) the dialog. Can be set when initialising (first creating) the dialog.

public SetDisabled ( bool disable ) : Options
disable	bool
return	Options

SetDraggable() public method

If set to true, the dialog will be draggable will be draggable by the titlebar.

public SetDraggable ( bool draggable ) : Options
draggable	bool
return	Options

SetHeight() public method

The height of the dialog, in pixels. Specifying 'auto' is also supported to make the dialog adjust based on its content.

public SetHeight ( int height ) : Options
height	int
return	Options

SetHeight() public method

The height of the dialog, in pixels. Specifying 'auto' is also supported to make the dialog adjust based on its content.

public SetHeight ( string height ) : Options
height	string
return	Options

SetHideEffect() public method

The effect to be used when the dialog is closed.

public SetHideEffect ( Core effect ) : Options
effect	Core
return	Options

SetHideEffect() public method

The effect to be used when the dialog is closed.

public SetHideEffect ( string hide ) : Options
hide	string
return	Options

SetHideMethod() public method

Function to use when the dialog is closed.

public SetHideMethod ( string hideMethod ) : Options
hideMethod	string
return	Options

SetMaxHeight() public method

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

public SetMaxHeight ( int maxHeight ) : Options
maxHeight	int
return	Options

SetMaxHeight() public method

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

public SetMaxHeight ( string maxHeight ) : Options
maxHeight	string
return	Options

SetMaxWidth() public method

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

public SetMaxWidth ( int maxWidth ) : Options
maxWidth	int
return	Options

SetMaxWidth() public method

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

public SetMaxWidth ( string maxWidth ) : Options
maxWidth	string
return	Options

SetMinHeight() public method

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

public SetMinHeight ( int minHeight ) : Options
minHeight	int
return	Options

SetMinWidth() public method

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

public SetMinWidth ( int minWidth ) : Options
minWidth	int
return	Options

SetModal() public method

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

public SetModal ( bool modal ) : Options
modal	bool
return	Options

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.

public SetPosition ( Core position ) : Options
position	Core
return	Options

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: Two strings containing x,y position string values (e.g. ['right','top'] for top right corner)

public SetPosition ( Core x, Core y ) : Options
x	Core
y	Core
return	Options

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: Two values containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. 350, 100)

public SetPosition ( int x, int y ) : Options
x	int
y	int
return	Options

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.

public SetPosition ( string position ) : Options
position	string
return	Options

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: Two strings containing x,y position string values (e.g. ['right','top'] for top right corner)

public SetPosition ( string x, string y ) : Options
x	string
y	string
return	Options

SetResizable() public method

If set to true, the dialog will be resizable.

public SetResizable ( bool resizable ) : Options
resizable	bool
return	Options

SetShowEffect() public method

The effect to be used when the dialog is opened.

public SetShowEffect ( Core effect ) : Options
effect	Core
return	Options

SetShowEffect() public method

The effect to be used when the dialog is opened.

public SetShowEffect ( string show ) : Options
show	string
return	Options

SetShowMethod() public method

The effect to be used when the dialog is opened.

public SetShowMethod ( string showMethod ) : Options
showMethod	string
return	Options

SetStack() public method

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.

public SetStack ( bool stack ) : Options
stack	bool
return	Options

SetTitle() public method

Specifies the title of the dialog. Any valid HTML may be set as the title. The title can also be specified by the title attribute on the dialog source element.

public SetTitle ( string title ) : Options
title	string
return	Options

SetWidth() public method

The width of the dialog, in pixels.

public SetWidth ( int width ) : Options
width	int
return	Options

SetZIndex() public method

The starting z-index for the dialog.

public SetZIndex ( int zIndex ) : Options
zIndex	int
return	Options