C# Class Fluqi.Widget.jDialog.Methods

The "Methods" are called after the control has been initialised. If for instance you want to change the value of a property, or invoke "some" action on the control (e.g. "open" or "close") you call the "Method" rather than through the "Options" (as Options is about the initialisation of the control).

Inheritance: Core.Methods

Datei anzeigen Open project: toepoke/Fluqi

Public Methods

Method	Description
Close ( ) : void	Closes the dialog.
Destroy ( ) : void	Remove the dialog functionality completely. This will return the element back to its pre-init state.
Disable ( ) : void	Disable the dialog.
Enable ( ) : void	Enable the dialog.
GetCloseOnEscape ( ) : void	Returns [in JavaScript] the current "closeOnEscape" setting.
GetCloseText ( ) : void	Returns [in JavaScript] the current "closeText" setting.
GetDialogClass ( ) : void	Returns [in JavaScript] the current "dialogClass" setting.
GetDraggable ( ) : void	Returns [in JavaScript] the current "draggable" setting.
GetHeight ( ) : void	Returns [in JavaScript] the current "height" setting.
GetHideEffect ( ) : void	Returns [in JavaScript] the current "hide" setting.
GetMaxHeight ( ) : void	Returns [in JavaScript] the current "maxHeight" setting.
GetMaxWidth ( ) : void	Returns [in JavaScript] the current "maxWidth" setting.
GetMinHeight ( ) : void	Returns [in JavaScript] the current "minHeight" setting.
GetMinWidth ( ) : void	Returns [in JavaScript] the current "minWidth" setting.
GetModal ( ) : void	Returns [in JavaScript] the current "modal" setting.
GetPosition ( ) : void	Returns [in JavaScript] the current "position" setting.
GetResizable ( ) : void	Returns [in JavaScript] the current "reisizable" setting.
GetShowEffect ( ) : void	Returns [in JavaScript] the current "show" setting.
GetStack ( ) : void	Returns [in JavaScript] the current "stack" setting.
GetTitle ( ) : void	Returns [in JavaScript] the current "title" setting.
GetWidth ( ) : void	Returns [in JavaScript] the current "width" setting.
GetZIndex ( ) : void	Returns [in JavaScript] the current "zIndex" setting.
IsOpen ( ) : void	Returns true if the dialog is currently open.
Methods ( Fluqi.Widget.jDialog.Dialog dlg ) : System	Constructor
MoveToTop ( ) : void	Moves the dialog to the top of the dialog stack.
Open ( ) : void	Opens the dialog.
SetCloseOnEscape ( bool newValue ) : void	Specifies whether the dialog should close when it has focus and the user presses the esacpe (ESC) key.
SetCloseText ( string newValue ) : void	Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.
SetCloseText ( string newValue, bool inDoubleQuotes ) : void	Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.
SetCloseTextJS ( string newValue ) : void	Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetDialogClass ( string newValue ) : void	The specified class name(s) will be added to the dialog, for additional theming.
SetDialogClass ( string newValue, bool inDoubleQuotes ) : void	The specified class name(s) will be added to the dialog, for additional theming.
SetDialogClassJS ( string newValue ) : void	The specified class name(s) will be added to the dialog, for additional theming. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetDraggable ( bool newValue ) : void	If set to true, the dialog will be draggable will be draggable by the titlebar.
SetHeight ( int newValue ) : void	The height of the dialog, in pixels.
SetHeightToAuto ( ) : void	The height of the dialog, in pixels. Specifying 'auto' is also supported to make the dialog adjust based on its content.
SetHideEffect ( Core newValue ) : void	The effect to be used when the dialog is closed.
SetHideEffect ( string newValue ) : void	The effect to be used when the dialog is closed.
SetHideEffect ( string newValue, bool inDoubleQuotes ) : void	The effect to be used when the dialog is closed.
SetHideEffectJS ( string newValue ) : void	The effect to be used when the dialog is closed. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetMaxHeight ( int newValue ) : void	The maximum height to which the dialog can be resized, in pixels.
SetMaxWidth ( int newValue ) : void	The maximum width to which the dialog can be resized, in pixels
SetMinHeight ( int newValue ) : void	The minimum height to which the dialog can be resized, in pixels.
SetMinWidth ( int newValue ) : void	The minimum width to which the dialog can be resized, in pixels.
SetModal ( bool newValue ) : void	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 ) : void	Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( Core pos1, Core pos2 ) : void	Specifies where the dialog should be displayed. Possible values: An array containing x,y position string values (e.g. ['right','top'] for top right corner)
SetPosition ( int pos1, int pos2 ) : void	Specifies where the dialog should be displayed. Possible values: An array containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. [350,100])
SetPosition ( string position ) : void	Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( string position, bool inDoubleQuotes ) : void	Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( string pos1, string pos2 ) : void	Specifies where the dialog should be displayed. Possible values: An array containing x,y position string values (e.g. ['right','top'] for top right corner)
SetPositionJS ( string position ) : void	Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetResizable ( bool newValue ) : void	If set to true, the dialog will be resizeable.
SetShowEffect ( Core newValue ) : void	The effect to be used when the dialog is opened.
SetShowEffect ( string newValue ) : void	The effect to be used when the dialog is opened.
SetShowEffect ( string newValue, bool inDoubleQuotes ) : void	The effect to be used when the dialog is opened.
SetShowEffectJS ( string newValue ) : void	The effect to be used when the dialog is opened. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetStack ( bool newValue ) : void	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 newValue ) : void	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.
SetTitle ( string newValue, bool inDoubleQuotes ) : void	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.
SetTitleJS ( string newValue ) : void	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. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetWidth ( int newValue ) : void	The width of the dialog, in pixels.
SetZIndex ( int newValue ) : void	The starting z-index for the dialog.
Widget ( ) : void	Returns the .ui-dialog element.

Method Details

Close() public method

Closes the dialog.

public Close ( ) : void
return	void

Destroy() public method

Remove the dialog functionality completely. This will return the element back to its pre-init state.

public Destroy ( ) : void
return	void

Disable() public method

Disable the dialog.

public Disable ( ) : void
return	void

Enable() public method

Enable the dialog.

public Enable ( ) : void
return	void

GetCloseOnEscape() public method

Returns [in JavaScript] the current "closeOnEscape" setting.

public GetCloseOnEscape ( ) : void
return	void

GetCloseText() public method

Returns [in JavaScript] the current "closeText" setting.

public GetCloseText ( ) : void
return	void

GetDialogClass() public method

Returns [in JavaScript] the current "dialogClass" setting.

public GetDialogClass ( ) : void
return	void

GetDraggable() public method

Returns [in JavaScript] the current "draggable" setting.

public GetDraggable ( ) : void
return	void

GetHeight() public method

Returns [in JavaScript] the current "height" setting.

public GetHeight ( ) : void
return	void

GetHideEffect() public method

Returns [in JavaScript] the current "hide" setting.

public GetHideEffect ( ) : void
return	void

GetMaxHeight() public method

Returns [in JavaScript] the current "maxHeight" setting.

public GetMaxHeight ( ) : void
return	void

GetMaxWidth() public method

Returns [in JavaScript] the current "maxWidth" setting.

public GetMaxWidth ( ) : void
return	void

GetMinHeight() public method

Returns [in JavaScript] the current "minHeight" setting.

public GetMinHeight ( ) : void
return	void

GetMinWidth() public method

Returns [in JavaScript] the current "minWidth" setting.

public GetMinWidth ( ) : void
return	void

GetModal() public method

Returns [in JavaScript] the current "modal" setting.

public GetModal ( ) : void
return	void

GetPosition() public method

Returns [in JavaScript] the current "position" setting.

public GetPosition ( ) : void
return	void

GetResizable() public method

Returns [in JavaScript] the current "reisizable" setting.

public GetResizable ( ) : void
return	void

GetShowEffect() public method

Returns [in JavaScript] the current "show" setting.

public GetShowEffect ( ) : void
return	void

GetStack() public method

Returns [in JavaScript] the current "stack" setting.

public GetStack ( ) : void
return	void

GetTitle() public method

Returns [in JavaScript] the current "title" setting.

public GetTitle ( ) : void
return	void

GetWidth() public method

Returns [in JavaScript] the current "width" setting.

public GetWidth ( ) : void
return	void

GetZIndex() public method

Returns [in JavaScript] the current "zIndex" setting.

public GetZIndex ( ) : void
return	void

IsOpen() public method

Returns true if the dialog is currently open.

public IsOpen ( ) : void
return	void

Methods() public method

Constructor

public Methods ( Fluqi.Widget.jDialog.Dialog dlg ) : System
dlg	Fluqi.Widget.jDialog.Dialog	Dialog object to call
return	System

MoveToTop() public method

Moves the dialog to the top of the dialog stack.

public MoveToTop ( ) : void
return	void

Open() public method

Opens the dialog.

public Open ( ) : void
return	void

SetCloseOnEscape() public method

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

public SetCloseOnEscape ( bool newValue ) : void
newValue	bool	New closeOnEscape setting
return	void

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 newValue ) : void
newValue	string	New closeText setting
return	void

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 newValue, bool inDoubleQuotes ) : void
newValue	string	New closeText setting
inDoubleQuotes	bool	/// true - double quotes (") /// false - single quotes (') ///
return	void

SetCloseTextJS() public method

Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).

public SetCloseTextJS ( string newValue ) : void
newValue	string	New closeText setting
return	void

SetDialogClass() public method

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

public SetDialogClass ( string newValue ) : void
newValue	string	New dialogClass setting
return	void

SetDialogClass() public method

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

public SetDialogClass ( string newValue, bool inDoubleQuotes ) : void
newValue	string	New dialogClass setting
inDoubleQuotes	bool	/// true - double quotes (") /// false - single quotes (') ///
return	void

SetDialogClassJS() public method

The specified class name(s) will be added to the dialog, for additional theming. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).

public SetDialogClassJS ( string newValue ) : void
newValue	string	New dialogClass setting
return	void

SetDraggable() public method

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

public SetDraggable ( bool newValue ) : void
newValue	bool	New draggable setting
return	void

SetHeight() public method

The height of the dialog, in pixels.

public SetHeight ( int newValue ) : void
newValue	int	New height setting
return	void

SetHeightToAuto() public method

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

public SetHeightToAuto ( ) : void
return	void

SetHideEffect() public method

The effect to be used when the dialog is closed.

public SetHideEffect ( Core newValue ) : void
newValue	Core	New hide setting
return	void

SetHideEffect() public method

The effect to be used when the dialog is closed.

public SetHideEffect ( string newValue ) : void
newValue	string	New hide setting
return	void

SetHideEffect() public method

The effect to be used when the dialog is closed.

public SetHideEffect ( string newValue, bool inDoubleQuotes ) : void
newValue	string	New hide setting
inDoubleQuotes	bool	/// true - double quotes (") /// false - single quotes (') ///
return	void

SetHideEffectJS() public method

The effect to be used when the dialog is closed. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).

public SetHideEffectJS ( string newValue ) : void
newValue	string	New hide setting
return	void

SetMaxHeight() public method

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

public SetMaxHeight ( int newValue ) : void
newValue	int	New maxHeight setting
return	void

SetMaxWidth() public method

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

public SetMaxWidth ( int newValue ) : void
newValue	int	New maxWidth setting
return	void

SetMinHeight() public method

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

public SetMinHeight ( int newValue ) : void
newValue	int	New minHeight setting
return	void

SetMinWidth() public method

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

public SetMinWidth ( int newValue ) : void
newValue	int	New minWidth setting
return	void

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 newValue ) : void
newValue	bool	New modal setting
return	void

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 ) : void
position	Core	New position setting
return	void

SetPosition() public method

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

public SetPosition ( Core pos1, Core pos2 ) : void
pos1	Core	First position setting
pos2	Core	Second position setting
return	void

SetPosition() public method

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

public SetPosition ( int pos1, int pos2 ) : void
pos1	int	First position setting
pos2	int	Second position setting
return	void

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 ) : void
position	string	New position setting
return	void

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, bool inDoubleQuotes ) : void
position	string	New position setting
inDoubleQuotes	bool	/// true - double quotes (") /// false - single quotes (') ///
return	void

SetPosition() public method

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

public SetPosition ( string pos1, string pos2 ) : void
pos1	string	First position setting
pos2	string	Second position setting
return	void

SetPositionJS() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).

public SetPositionJS ( string position ) : void
position	string	New position setting
return	void

SetResizable() public method

If set to true, the dialog will be resizeable.

public SetResizable ( bool newValue ) : void
newValue	bool	New reisizable setting
return	void

SetShowEffect() public method

The effect to be used when the dialog is opened.

public SetShowEffect ( Core newValue ) : void
newValue	Core	New show setting
return	void

SetShowEffect() public method

The effect to be used when the dialog is opened.

public SetShowEffect ( string newValue ) : void
newValue	string	New show setting
return	void

SetShowEffect() public method

The effect to be used when the dialog is opened.

public SetShowEffect ( string newValue, bool inDoubleQuotes ) : void
newValue	string	New show setting
inDoubleQuotes	bool	/// true - double quotes (") /// false - single quotes (') ///
return	void

SetShowEffectJS() public method

The effect to be used when the dialog is opened. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).

public SetShowEffectJS ( string newValue ) : void
newValue	string	New show setting
return	void

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 newValue ) : void
newValue	bool	New stack setting
return	void

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 newValue ) : void
newValue	string	New title setting
return	void

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 newValue, bool inDoubleQuotes ) : void
newValue	string	New title setting
inDoubleQuotes	bool	/// true - double quotes (") /// false - single quotes (') ///
return	void

SetTitleJS() 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. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).

public SetTitleJS ( string newValue ) : void
newValue	string	New title setting
return	void

SetWidth() public method

The width of the dialog, in pixels.

public SetWidth ( int newValue ) : void
newValue	int	New width setting
return	void

SetZIndex() public method

The starting z-index for the dialog.

public SetZIndex ( int newValue ) : void
newValue	int	New zIndex setting
return	void

Widget() public method

Returns the .ui-dialog element.

public Widget ( ) : void
return	void