Class UpCurrencyControl

Hierarchy

  • UpNumberEditControl
    • UpCurrencyControl

Accessors

maxLength required

Methods

checkValidity getMaxValue getMinValue getValue isInRange isValid setMaxValue setMinValue setValue toLocalFormat

Accessors

maxLength

  • get maxLength(): number

  • Gets the maximum length of the control.

    Returns number

  • set maxLength(value): void

  • Sets the maximum length of the control.

    Parameters

    • value: number

    Returns void

required

  • get required(): boolean

  • Can get required status.

    Returns boolean

  • set required(value): void

  • Sets required status.

    Parameters

    • value: boolean

    Returns void

Methods

checkValidity

  • Checks if the value matches the regex and is in range of values.

    Returns Promise<ValidationInfo>

getMaxValue

  • Gets the fields maximum value.

    Returns undefined | string

getMinValue

  • Gets the fields minimum value.

    Returns undefined | string

getValue

  • Returns the fields value.

    Returns string

isInRange

  • Checks if the value is in range of values the user gives.

    Parameters

    • Optional input: string

      The value to check

    Returns boolean

isValid

  • Checks if the value is valid

    Parameters

    • Optional value: string | number

      value to check

    Returns boolean

    boolean if value is valid

setMaxValue

  • Sets the fields maximum value.

    Parameters

    • value: string | number
    • options: {
          checkValidity: boolean;
      } = ...

      An object of possible options to pass

      • checkValidity: boolean

        Whether to run and report the validation (default: true)

    Returns void

setMinValue

  • Sets the fields minimum value.

    Parameters

    • value: string | number
    • options: {
          checkValidity: boolean;
      } = ...

      An object of possible options to pass

      • checkValidity: boolean

        Whether to run and report the validation (default: true)

    Returns void

setValue

  • Creates a local formatted string from a number object or string and writes it as value into a HTML control.

    Parameters

    • Optional input: string | number

      The local formatted string

    • Optional settings: {
          triggerOnchange?: "disabled" | "strict" | "always";
      }
      • Optional triggerOnchange?: "disabled" | "strict" | "always"

    Returns void

    Important

    The conversion uses the fields localization. A string must have the matching format for a propper result!

toLocalFormat

  • Converts a number or string to a local formatted string.

    Parameters

    • input: string | number

      The given input string/number to convert to the local format

    Returns string

    string with local formatted number or NaN

Settings

Member Visibility

Theme

On This Page