C# Class Fluqi.Widget.jSpinner.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
Destroy ( ) : void	Removes the spinner functionality completely. This will return the element back to its pre-init state.
Disable ( ) : void	Disables the spinner.
Enable ( ) : void	Enable the spinner.
GetCulture ( ) : void	Returns [in JavaScript] the current "culture" setting.
GetDisabled ( ) : void	Returns [in JavaScript] the current "disabled" setting.
GetIcons ( ) : void	Returns [in JavaScript] the current "icons" setting.
GetIncremental ( ) : void	Returns [in JavaScript] the current "incremental" setting.
GetIsValid ( ) : void	Returns whether the Spinner's value is valid given its min, max, and step.
GetMax ( ) : void	Returns [in JavaScript] the current "max" setting.
GetMin ( ) : void	Returns [in JavaScript] the current "min" setting.
GetNumberFormat ( ) : void	Returns [in JavaScript] the current "numberFormat" setting.
GetPage ( ) : void	Returns [in JavaScript] the current "page" setting.
GetStep ( ) : void	Returns [in JavaScript] the current "step" setting.
GetValue ( ) : void	Gets the current value as a number. The value is parsed based on the numberFormat and culture options.
Methods ( Fluqi.Widget.jSpinner.Spinner spinner ) : System	Constructor
PageDown ( int value = 1 ) : void	Decrements the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is decremented.
PageUp ( int value = 1 ) : void	Decrements the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is decremented.
SetCulture ( string culture ) : void	Sets the culture to use for parsing and formatting the value. If null, the currently set culture in Globalize is used, see Globalize docs for available cultures. Only relevant if the SetNumberFormat option is set. Requires Globalize to be included.
SetDisabled ( bool disabled ) : void	Disables the spinner.
SetIcons ( Core downIcon, Core upIcon ) : void	Icons to use for buttons, matching an icon defined by the jQuery UI CSS Framework.
SetIcons ( string downIcon, string upIcon ) : void	Icons to use for buttons, matching an icon defined by the jQuery UI CSS Framework.
SetIncremental ( bool inc ) : void	Controls the number of steps taken when holding down a spin button. - When set to true, the stepping delta will increase when spun incessantly. - When set to false, all steps are equal (as defined by the step option).
SetIncremental ( string incMethod ) : void	Controls the number of steps taken when holding down a spin button. - Receives one parameter: the number of spins that have occurred. Must return the number of steps that should occur for the current spin.
SetMax ( int value ) : void	The maximum allowed value
SetMax ( string value ) : void	The maximum allowed value
SetMin ( int value ) : void	The minimum allowed value
SetMin ( string value ) : void	The minimum allowed value
SetNumberFormat ( string value ) : void	Format of numbers passed to Globalize, if available.
SetPage ( int value ) : void	The number of steps to take when paging via the pageUp/pageDown methods.
SetStep ( int value ) : void	The size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods. The element's step attribute is used if it exists and the option is not explicitly set.
SetStep ( string value ) : void	The size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods. The element's step attribute is used if it exists and the option is not explicitly set.
SetValue ( int value ) : void	Sets the value
SetValue ( string value ) : void	Sets the value
StepDown ( int value = 1 ) : void	Decrements the value by the specified number of steps. Without the parameter, a single step is decremented. If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.
StepUp ( int value = 1 ) : void	Increments the value by the specified number of steps. Without the parameter, a single step is incremented. If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.
Widget ( ) : void	Returns a jQuery object containing the generated wrapper.

Method Details

Destroy() public method

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

public Destroy ( ) : void
return	void

Disable() public method

Disables the spinner.

public Disable ( ) : void
return	void

Enable() public method

Enable the spinner.

public Enable ( ) : void
return	void

GetCulture() public method

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

public GetCulture ( ) : void
return	void

GetDisabled() public method

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

public GetDisabled ( ) : void
return	void

GetIcons() public method

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

public GetIcons ( ) : void
return	void

GetIncremental() public method

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

public GetIncremental ( ) : void
return	void

GetIsValid() public method

Returns whether the Spinner's value is valid given its min, max, and step.

public GetIsValid ( ) : void
return	void

GetMax() public method

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

public GetMax ( ) : void
return	void

GetMin() public method

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

public GetMin ( ) : void
return	void

GetNumberFormat() public method

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

public GetNumberFormat ( ) : void
return	void

GetPage() public method

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

public GetPage ( ) : void
return	void

GetStep() public method

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

public GetStep ( ) : void
return	void

GetValue() public method

Gets the current value as a number. The value is parsed based on the numberFormat and culture options.

public GetValue ( ) : void
return	void

Methods() public method

Constructor

public Methods ( Fluqi.Widget.jSpinner.Spinner spinner ) : System
spinner	Fluqi.Widget.jSpinner.Spinner	Spinner object to call
return	System

PageDown() public method

Decrements the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is decremented.

public PageDown ( int value = 1 ) : void
value	int
return	void

PageUp() public method

Decrements the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is decremented.

public PageUp ( int value = 1 ) : void
value	int
return	void

SetCulture() public method

Sets the culture to use for parsing and formatting the value. If null, the currently set culture in Globalize is used, see Globalize docs for available cultures. Only relevant if the SetNumberFormat option is set. Requires Globalize to be included.

public SetCulture ( string culture ) : void
culture	string
return	void

SetDisabled() public method

Disables the spinner.

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

SetIcons() public method

Icons to use for buttons, matching an icon defined by the jQuery UI CSS Framework.

public SetIcons ( Core downIcon, Core upIcon ) : void
downIcon	Core	Icon to use for the down
upIcon	Core	Icon to use for the up
return	void

SetIcons() public method

Icons to use for buttons, matching an icon defined by the jQuery UI CSS Framework.

public SetIcons ( string downIcon, string upIcon ) : void
downIcon	string	Icon to use for the down
upIcon	string	Icon to use for the up
return	void

SetIncremental() public method

Controls the number of steps taken when holding down a spin button. - When set to true, the stepping delta will increase when spun incessantly. - When set to false, all steps are equal (as defined by the step option).

public SetIncremental ( bool inc ) : void
inc	bool
return	void

SetIncremental() public method

Controls the number of steps taken when holding down a spin button. - Receives one parameter: the number of spins that have occurred. Must return the number of steps that should occur for the current spin.

public SetIncremental ( string incMethod ) : void
incMethod	string
return	void

SetMax() public method

The maximum allowed value

public SetMax ( int value ) : void
value	int	The maximum value
return	void

SetMax() public method

The maximum allowed value

public SetMax ( string value ) : void
value	string	/// If Globalize is included, the min option can be passed as a string which will be parsed based on the /// numberFormat and culture options; otherwise it will fall back to the native parseFloat() method. ///
return	void

SetMin() public method

The minimum allowed value

public SetMin ( int value ) : void
value	int	The minimum value
return	void

SetMin() public method

The minimum allowed value

public SetMin ( string value ) : void
value	string	/// If Globalize is included, the min option can be passed as a string which will be parsed based on the /// numberFormat and culture options; otherwise it will fall back to the native parseFloat() method. ///
return	void

SetNumberFormat() public method

Format of numbers passed to Globalize, if available.

public SetNumberFormat ( string value ) : void
value	string	/// Most common are "n" for a decimal number and "C" for a currency value. /// Also see the culture option. ///
return	void

SetPage() public method

The number of steps to take when paging via the pageUp/pageDown methods.

public SetPage ( int value ) : void
value	int	New value
return	void

SetStep() public method

The size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods. The element's step attribute is used if it exists and the option is not explicitly set.

public SetStep ( int value ) : void
value	int	The size of the step
return	void

SetStep() public method

The size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods. The element's step attribute is used if it exists and the option is not explicitly set.

public SetStep ( string value ) : void
value	string	/// If Globalize is included, the step option can be passed as a string which will be parsed based on /// the numberFormat and culture options, otherwise it will fall back to the native parseFloat. ///
return	void

SetValue() public method

Sets the value

public SetValue ( int value ) : void
value	int	The value to set
return	void

SetValue() public method

Sets the value

public SetValue ( string value ) : void
value	string	The value is parsed based on the numberFormat and culture options.
return	void

StepDown() public method

Decrements the value by the specified number of steps. Without the parameter, a single step is decremented. If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.

public StepDown ( int value = 1 ) : void
value	int
return	void

StepUp() public method

Increments the value by the specified number of steps. Without the parameter, a single step is incremented. If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.

public StepUp ( int value = 1 ) : void
value	int
return	void

Widget() public method

Returns a jQuery object containing the generated wrapper.

public Widget ( ) : void
return	void