Class UpTextareaEditControl

element

required

• get required(): boolean

• Gets the required state of the control.

  Returns boolean

  Example

  var textarea = ix.util.getUp("<GUID>");
  textarea.required;
  Copy

• set required(value): void

• Sets the required state of the control.

  Parameters

  • value: boolean

  Returns void

  Example

  var textarea = ix.util.getUp("<GUID>");
  textarea.required = <true|false>;
  Copy

checkValidity

• checkValidity(): Promise<ValidationInfo>

• Checks the elements validity.

  Returns Promise<ValidationInfo>

  Example

  const validityResult = await ix.util.getUp("<GUID>").checkValidity();
  
  // example of `validityResult` - the entered value has wrong format
  ValidationInfo {
    valStatus: false,
    valMessage: 'The field must not be empty.',
    valType: 'required'
  }
  Copy

disableMarkdownEditor

• disableMarkdownEditor(): void

• Disable the Markdown editor GUI.

  Returns void

  Deprecated

  The function will be replaced with a new Markdown editor during the next silent/steady track synchronization.
  The new editor will offer improved functionality and a better user experience, but users should note that the old function will no longer be available.

getValue

• getValue(): string

• Gets the value of the control.

  Returns string

  Example

  var textarea = ix.util.getUp("<GUID>");
  textarea.getValue();
  Copy

reportValidity

• reportValidity(): Promise<void>

• Checks and reports validity.
  Useful if the field's value was changed without triggering changes.

  Returns Promise<void>

setValue

• setValue(value, settings?): void

• Sets the value of the control.

  Parameters

  • value: string

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

    • triggerOnchange: "disabled" | "strict" | "always"

  Returns void

  Example

  var textarea = ix.util.getUp("<GUID>");
  textarea.setValue("my value");
  Copy