Class MailButton

The MailButton control places a button to open system mail application.

Hierarchy

Constructors

constructor

Properties

buttonHeading buttonLabel buttonType defaultValue disposed element enabled icon label labelEl mailId mailSubject onChanged options required tooltip visiting

Methods

deleteFields disable dispose enable get getAllValues getDefault getPostfixFieldId getWithId hide isRepeatingUnit set setLabel setWithId show val

Constructors

constructor

Properties

buttonHeading

buttonHeading: string

The label of the button.

buttonLabel

buttonLabel: string

The label of the button.

buttonType

buttonType: string

The type of the button. Go to FormButtonType to get all possibilities.

defaultValue

defaultValue: any

Protected disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

icon

icon: string

The button icon; SVG or fontawesome icon

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

mailId

mailId: string

The id of the mail address input form control

mailSubject

mailSubject: string

The subject line for the mail

onChanged

onChanged: Function

Protected options

options: any

required

required: boolean

tooltip

tooltip: string

visiting

visiting: boolean = false

Methods

deleteFields

  • Does nothing. Overwrites the inherited method from FormControl. This form control do not have saved data in fields.

    Returns Promise<any>

disable

dispose

enable

get

getAllValues

  • Returns

    all fields and values that are connected with the the form control.

    Returns any

getDefault

  • Does nothing. Overwrites the inherited method from FormControl. This form control do not have saved data in fields.

    Returns any

getPostfixFieldId

  • Gets the PostfixFieldId. Relevant for operations in repeating units. Check first, if the form control is contained in a repeating unit, see: isRepeatingUnit.

    Returns string

getWithId

hide

  • Hide FormControl

    Parameters

    • animate: boolean = false

      En/Disable animation

    • lock: boolean = true

      Enable lock of hidden FormControl to not process control with condition

    Returns void

isRepeatingUnit

set

  • Does nothing. Overwrites the inherited method from FormControl. This form control do not have saved data in fields.

    Returns number

setLabel

  • Does nothing. Overwrites the inherited method from FormControl. This form control do not have saved data in fields.

    Parameters

    • value: any

    Returns void

setWithId

  • Does nothing. Overwrites the inherited method from FormControl. This form control do not have saved data in fields.

    Returns number

show

  • Show hidden FormControl

    Parameters

    • animate: boolean = false

      En/Disable animation

    • unlock: boolean = true

      Disable lock of hidden state to process control with condition

    Returns void

val

  • Does nothing. Overwrites the inherited method from FormControl. This form control only set values of other form controls.

    Parameters

    • Optional value: any

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc