C# Class Fluqi.Widget.jToolTip.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 a tooltip. This is only intended to be called for non-delegated tooltips.
Destroy ( ) : void	Removes the ToolTip functionality completely. This will return the element back to its pre-init state.
Disable ( ) : void	Disables the tooltip.
DisabledHideEffect ( ) : void	Hide by Boolean: When set to false, no animation will be used and the tooltip will be hidden immediately. When set to true, the tooltip will fade out with the default duration and the default easing.
DisabledShowEffect ( ) : void	Show by Boolean: When set to false, no animation will be used and the tooltip will be hidden immediately. When set to true, the tooltip will fade out with the default duration and the default easing.
Enable ( ) : void	Enable the tooltip.
GetContent ( ) : void	Returns [in JavaScript] the current "content" setting.
GetDisabled ( ) : void	Returns [in JavaScript] the current "disabled" setting.
GetHide ( ) : void	Returns [in JavaScript] the current "hide" setting.
GetItems ( ) : void	A selector indicating which items should show tooltips. Customize if you're using something other then the title attribute for the tooltip content, or if you need a different selector for event delegation.
GetPosition ( ) : void	Returns [in JavaScript] the current "position" setting.
GetShow ( ) : void	Returns [in JavaScript] the current "show" setting.
GetTooltipClass ( ) : void	Returns [in JavaScript] the current "tooltipClass" setting.
GetTrack ( ) : void	Returns [in JavaScript] the current "track" setting.
Methods ( ToolTip tooltip ) : System	Constructor
Open ( ) : void	Programmatically open a tooltip. This is only intended to be called for non-delegated tooltips.
SetContentByFunction ( string content ) : void	The content of the tooltip.
SetContentByString ( string content ) : void	The content of the tooltip.
SetDisabled ( bool disabled ) : void	Disables the tooltip.
SetHide ( Core effect, Core easing, int duration ) : void	Hide by Number: The tooltip will fade out with the specified duration and the default easing.
SetHide ( int duration ) : void	Hide by Number: The tooltip will fade out with the specified duration and the default easing.
SetHide ( string json ) : void	Hide by Number: The tooltip will fade out with the specified duration and the default easing.
SetItems ( ) : void	A selector indicating which items should show tooltips. Customize if you're using something other then the title attribute for the tooltip content, or if you need a different selector for event delegation.
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).
SetShow ( Core effect, Core easing, int duration ) : void	Show by Number: The tooltip will fade out with the specified duration and the default easing.
SetShow ( int duration ) : void	Show by Number: The tooltip will fade out with the specified duration and the default easing.
SetShow ( string json ) : void	Show by Object:
SetTooltipClass ( string tooltipClass ) : void	Tooltip class to add
SetTrack ( bool track ) : void	Whether the tooltip should track the mouse
Widget ( ) : void	Returns a jQuery object containing the generated wrapper.

Protected Methods

Method	Description
BuildMethodCall ( string methodName ) : string	Builds up the JavaScript required to call a given method.

Method Details

BuildMethodCall() protected method

Builds up the JavaScript required to call a given method.

protected BuildMethodCall ( string methodName ) : string
methodName	string	Name of the method to call (as define in the jQuery UI documentation for the control.
return	string

Close() public method

Closes a tooltip. This is only intended to be called for non-delegated tooltips.

public Close ( ) : void
return	void

Destroy() public method

Removes the ToolTip functionality completely. This will return the element back to its pre-init state.

public Destroy ( ) : void
return	void

Disable() public method

Disables the tooltip.

public Disable ( ) : void
return	void

DisabledHideEffect() public method

Hide by Boolean: When set to false, no animation will be used and the tooltip will be hidden immediately. When set to true, the tooltip will fade out with the default duration and the default easing.

public DisabledHideEffect ( ) : void
return	void

DisabledShowEffect() public method

Show by Boolean: When set to false, no animation will be used and the tooltip will be hidden immediately. When set to true, the tooltip will fade out with the default duration and the default easing.

public DisabledShowEffect ( ) : void
return	void

Enable() public method

Enable the tooltip.

public Enable ( ) : void
return	void

GetContent() public method

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

public GetContent ( ) : void
return	void

GetDisabled() public method

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

public GetDisabled ( ) : void
return	void

GetHide() public method

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

public GetHide ( ) : void
return	void

GetItems() public method

A selector indicating which items should show tooltips. Customize if you're using something other then the title attribute for the tooltip content, or if you need a different selector for event delegation.

public GetItems ( ) : void
return	void

GetPosition() public method

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

public GetPosition ( ) : void
return	void

GetShow() public method

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

public GetShow ( ) : void
return	void

GetTooltipClass() public method

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

public GetTooltipClass ( ) : void
return	void

GetTrack() public method

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

public GetTrack ( ) : void
return	void

Methods() public method

Constructor

public Methods ( ToolTip tooltip ) : System
tooltip	ToolTip	ToolTip object to call
return	System

Open() public method

Programmatically open a tooltip. This is only intended to be called for non-delegated tooltips.

public Open ( ) : void
return	void

SetContentByFunction() public method

The content of the tooltip.

public SetContentByFunction ( string content ) : void
content	string
return	void

SetContentByString() public method

The content of the tooltip.

public SetContentByString ( string content ) : void
content	string
return	void

SetDisabled() public method

Disables the tooltip.

public SetDisabled ( bool disabled ) : void
disabled	bool
return	void

SetHide() public method

Hide by Number: The tooltip will fade out with the specified duration and the default easing.

public SetHide ( Core effect, Core easing, int duration ) : void
effect	Core
easing	Core
duration	int
return	void

SetHide() public method

Hide by Number: The tooltip will fade out with the specified duration and the default easing.

public SetHide ( int duration ) : void
duration	int
return	void

SetHide() public method

Hide by Number: The tooltip will fade out with the specified duration and the default easing.

public SetHide ( string json ) : void
json	string
return	void

SetItems() public method

public SetItems ( ) : void
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

SetShow() public method

Show by Number: The tooltip will fade out with the specified duration and the default easing.

public SetShow ( Core effect, Core easing, int duration ) : void
effect	Core
easing	Core
duration	int
return	void

SetShow() public method

Show by Number: The tooltip will fade out with the specified duration and the default easing.

public SetShow ( int duration ) : void
duration	int
return	void

SetShow() public method

Show by Object:

public SetShow ( string json ) : void
json	string
return	void

SetTooltipClass() public method

Tooltip class to add

public SetTooltipClass ( string tooltipClass ) : void
tooltipClass	string
return	void

SetTrack() public method

Whether the tooltip should track the mouse

public SetTrack ( bool track ) : void
track	bool
return	void

Widget() public method

Returns a jQuery object containing the generated wrapper.

public Widget ( ) : void
return	void