Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PushButtonField

Hierarchy

Index

Methods

Methods

buttonGetAlignX

  • buttonGetAlignX(): Promise<number>

  • Get Controls how space is distributed from the left of the button face with respect to the icon.

    Returns Promise<number>

    .

buttonGetAlignY

  • buttonGetAlignY(): Promise<number>

  • Get Controls AlignY.

    Returns Promise<number>

buttonGetBehavior

buttonGetCaption

  • buttonGetCaption(state: FieldState): Promise<undefined | string>

  • Gets the caption associated with a button.

    see

    FieldState

    Parameters

    Returns Promise<undefined | string>

buttonGetFitBounds

  • buttonGetFitBounds(): Promise<boolean>

  • Get the bounds of the button filed.

    Returns Promise<boolean>

    • If true, the extent to which the icon may be scaled.

buttonGetScaleHow

  • buttonGetScaleHow(): Promise<boolean>

  • Get Controls how the icon is scaled (if necessary) to fit inside the button face

    Returns Promise<boolean>

buttonGetScaleWhen

buttonSetAlignX

  • buttonSetAlignX(x: number): Promise<void>

  • Set Controls how space is distributed from the left of the button face with respect to the icon.

    Parameters

    • x: number

      The new alignment.
      It is expressed as a percentage between 0 and 100, inclusive. The default value is 50.

    Returns Promise<void>

    unidefined

buttonSetAlignY

  • buttonSetAlignY(y: number): Promise<void>

  • Set Controls AlignY.

    Parameters

    • y: number

    Returns Promise<void>

    void

buttonSetBehavior

  • Defines how a button reacts when a user clicks it. The four highlight modes supported are:
    none — No visual indication that the button has been clicked.
    invert — The region encompassing the button’s rectangle inverts momentarily.
    push — The down face for the button (if any) is displayed momentarily.
    outline — The border of the rectangleinverts momentarily

    see

    Highlighting

    Parameters

    Returns Promise<void>

    void

buttonSetCaption

  • buttonSetCaption(state: FieldState, label: string): Promise<void>

  • Sets the caption associated with a button. label : caption associated with button.

    Parameters

    Returns Promise<void>

buttonSetFitBounds

  • buttonSetFitBounds(isFitBound: boolean): Promise<void>

  • Set to the bounds of the button field

    Parameters

    • isFitBound: boolean

      If true, the extent to which the icon may be scaled.

    Returns Promise<void>

    unidefined

buttonSetScaleHow

  • buttonSetScaleHow(isProportionally: boolean): Promise<void>

  • Set Controls how the icon is scaled (if necessary) to fit inside the button face

    Parameters

    • isProportionally: boolean

      true if it's proportional, otherwise false.

    Returns Promise<void>

    unidefined

buttonSetScaleWhen

  • Controls when an icon is scaled to fit inside the button face

    see

    ScaleWayType

    Parameters

    Returns Promise<void>

    void

getBorderColor

  • getBorderColor(): Promise<number>

  • Get field's border color.

    see

    Field

    Returns Promise<number>

    • An integer indicated border color will be returned.

getBorderStyle

  • getBorderStyle(): Promise<string>

  • Get field's border style.

    see

    Field

    Returns Promise<string>

    • Border style, should be one of 'solid','dashed','inset','beveled','underline'. Nothing will be done with invalid string

getControlsCount

  • getControlsCount(): Promise<number>

  • Get the count of field's controls.

    see

    Field

    Returns Promise<number>

    • Count of field's controls.

getFillColor

  • getFillColor(): Promise<number>

  • Get field's fill color.

    note

    Load all relative annotations before call this function, or wrong value will return.

    see

    [[setFilColor]]

    Returns Promise<number>

    • An integer indicated border color will be returned.

getFlags

  • Get field's flags. For more information.

    see

    FieldFlags

    Returns Promise<FieldFlags>

    • An integer indicated field's flags will be returned.

getName

  • getName(): Promise<string>

  • Get form field's name(aka title).

    Returns Promise<string>

    • Form field's name

getNumItems

  • getNumItems(): Promise<number>

getType

getValue

  • getValue(): Promise<string>

  • Get field value.

    Returns Promise<string>

    • Field's value

setBorderColor

  • setBorderColor(color: number): Promise<undefined | boolean>

  • Set field's border color.

    see

    Field

    Parameters

    • color: number

    Returns Promise<undefined | boolean>

    void

setBorderStyle

  • Set field's border style(Not support signature field).

    see

    Field

    Parameters

    • style: FieldBorderStyle

      Border style, should be one of 'solid','dashed','inset','beveled'. Nothing will be done with invalid string

    Returns Promise<boolean>

setFillColor

  • setFillColor(color: any): Promise<boolean>

  • Set field's fill color.

    Parameters

    • color: any

      An interge indecated fill color (alpha is not supported). Supported color format
      0 or ['T'] for transparent
      number, such as 0xff0000, 16711680
      PDF color array, such as ['RGB',1,1,1] which means white.
      HTML color format, such as '#ff0000', 'rgb(255,0,0)', 'rgba(255,0,0,1)'

    Returns Promise<boolean>

    boolean

setFlags

setLayout

  • Button Position,Controls how the text and the icon of the button are positioned with respect to each other within the button face.

    see

    LayoutOption

    Parameters

    Returns Promise<void>

    void

setValue

  • setValue(value: string): Promise<void>

  • Set field's value.

    Parameters

    • value: string

      Field's value to be set.

    Returns Promise<void>

    void or the set value.