Class UpEmailEditControl

Hierarchy

  • UpTextMainEditControl
    • UpEmailEditControl

Accessors

maxLength pattern required

Methods

checkValidity getValue setValue

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

pattern

  • get pattern(): string

  • Returns string

  • set pattern(value): void

  • Parameters

    • value: string

    Returns void

required

  • get required(): boolean

  • Gets the control's required state.

    Returns boolean

  • set required(value): void

  • Sets the control's required state

    Parameters

    • value: boolean

    Returns void

Methods

checkValidity

  • Checks control validity.

    Returns Promise<ValidationInfo>

    Example

    const validityResult = await ix.util.getUp("<GUID>").checkValidity();

    // example of `validityResult` - no valid email address
    ValidationInfo {
      valStatus: false,
      valMessage: 'Invalid email format',
      valType: 'pattern'
    }

getValue

  • Returns the value of the field.

    Returns string

setValue

  • Sets a value for the control.

    Parameters

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

    Returns void

Settings

Member Visibility

Theme

On This Page