Class InkControl

The HybridForms InkControl. Users can draw on a canvas. Optional a background image can be included. The drawn sketch is stored.

Hierarchy

Constructors

constructor

Properties

clearButton defaultColor defaultValue disposed element enabled height image isfMode label labelEl logSigning onChanged options required tooltip visiting width

Methods

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

Constructors

constructor

Properties

clearButton

clearButton: boolean

Sets a clear button in the left bottom corner if set to true. Default: false.

defaultColor

defaultColor: string

Sets the colour the user draws on the canvas.

defaultValue

defaultValue: any

Protected disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

height

height: number

Sets the height of the canvas.

image

image: string

Sets the background image of the control.

isfMode

isfMode: boolean = false

Deprecated

For compatibility reasons to Win10 app.

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

logSigning

logSigning: boolean

If set to true, signatures gets logged.

onChanged

onChanged: Function

Protected options

options: any

required

required: boolean

tooltip

tooltip: string

visiting

visiting: boolean = false

width

width: number

Sets the width of the canvas.

Methods

deleteFields

  • Deletes all fields that are linked to the InkControl:

      1. FieldId
      1. FieldId + _HFInkImage
      1. FieldId + '_HFInkImageMerged'

    Returns Promise<void>

disable

  • Disables the form control.

    Returns void

dispose

  • Disposes the form control.

    Returns void

enable

  • Enables the form control.

    Returns void

get

getAllValues

  • Returns

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

    Returns any

getDefault

  • Gets the default value auf the form control, if it is set.

    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

  • Checks if the form control is included in a repeating unit.

    Returns boolean

save

  • Stores the images and sets the fields with the names of the images.

    Parameters

    • Optional progress: Progress

      [optional] Adds a Progress control.

    Returns Promise<void>

set

  • Sets the field value of the form control. Be careful: This does not update the UI. In most cases it is better to use the val() method, see: val

    Parameters

    • value: any

      The value of the field

    Returns number

setLabel

  • Sets a new label value.

    Parameters

    • value: string

      The value to set.

    Returns void

setWithId

  • Sets any field value by providing its id.

    Parameters

    • id: string

      The id of the field.

    • val: any

      The value of the field. Data type is an object. Its structure depends on the specific field type.

    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 on the InkControl. Use instead the save method to save the InkControl. To get the file names of the stored images use the getById method.

    Parameters

    • value: any

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc