Poppler-0.18 ▶ Poppler ▶ SigningData

constructor

• new SigningData(properties?: Partial<{}>): SigningData

  Parameters

  • Optionalproperties: Partial<{}>

  Returns SigningData

Static$gtype

Since 23.07.0copy

• copy(): SigningData

  Copies signing_data, creating an identical Poppler.SigningData.

  Returns SigningData

  a new Poppler.SigningData structure identical to signing_data

  Since

  23.07.0

Since 23.07.0free

• free(): void

  Frees signing_data

  Returns void

  Since

  23.07.0

Since 23.07.0get_background_color

• get_background_color(): Poppler.Color

  Get signature background color.

  Returns Poppler.Color

  a Poppler.Color

  Since

  23.07.0

Since 23.07.0get_border_color

• get_border_color(): Poppler.Color

  Get signature border color.

  Returns Poppler.Color

  a Poppler.Color

  Since

  23.07.0

Since 23.07.0get_border_width

• get_border_width(): number

  Get signature border width.

  Returns number

  border width

  Since

  23.07.0

Since 23.07.0get_certificate_info

• get_certificate_info(): CertificateInfo

  Get certification information.

  Returns CertificateInfo

  a Poppler.CertificateInfo

  Since

  23.07.0

Since 23.07.0get_destination_filename

• get_destination_filename(): string

  Get destination file name.

  Returns string

  destination filename

  Since

  23.07.0

Since 23.07.0get_document_owner_password

• get_document_owner_password(): string

  Get document owner password.

  Returns string

  document owner password (for encrypted files)

  Since

  23.07.0

Since 23.07.0get_document_user_password

• get_document_user_password(): string

  Get document user password.

  Returns string

  document user password (for encrypted files)

  Since

  23.07.0

Since 23.07.0get_field_partial_name

• get_field_partial_name(): string

  Get field partial name.

  Returns string

  field partial name

  Since

  23.07.0

Since 23.07.0get_font_color

• get_font_color(): Poppler.Color

  Get signature font color.

  Returns Poppler.Color

  a Poppler.Color

  Since

  23.07.0

Since 23.07.0get_font_size

• get_font_size(): number

  Get signature font size.

  Returns number

  font size

  Since

  23.07.0

Since 23.07.0get_image_path

• get_image_path(): string

  Get image path.

  Returns string

  image path

  Since

  23.07.0

Since 23.07.0get_left_font_size

• get_left_font_size(): number

  Get signature left font size.

  Returns number

  left font size

  Since

  23.07.0

Since 23.07.0get_location

• get_location(): string

  Get location.

  Returns string

  location

  Since

  23.07.0

Since 23.07.0get_page

• get_page(): number

  Get page.

  Returns number

  page number

  Since

  23.07.0

Since 23.07.0get_password

• get_password(): string

  Get signing key password.

  Returns string

  password

  Since

  23.07.0

Since 23.07.0get_reason

• get_reason(): string

  Get reason.

  Returns string

  reason

  Since

  23.07.0

Since 23.07.0get_signature_rectangle

• get_signature_rectangle(): Poppler.Rectangle

  Get signature rectangle.

  Returns Poppler.Rectangle

  a Poppler.Rectangle

  Since

  23.07.0

Since 23.07.0get_signature_text

• get_signature_text(): string

  Get signature text.

  Returns string

  signature text

  Since

  23.07.0

Since 23.07.0get_signature_text_left

• get_signature_text_left(): string

  Get signature text left.

  Returns string

  signature text left

  Since

  23.07.0

Since 23.07.0set_background_color

• set_background_color(background_color: Poppler.Color): void

  Set signature background color.

  Parameters

  • background_color: Poppler.Color

    a Poppler.Color to be used for signature background

  Returns void

  Since

  23.07.0

Since 23.07.0set_border_color

• set_border_color(border_color: Poppler.Color): void

  Set signature border color.

  Parameters

  • border_color: Poppler.Color

    a Poppler.Color to be used for signature border

  Returns void

  Since

  23.07.0

Since 23.07.0set_border_width

• set_border_width(border_width: number): void

  Set signature border width.

  Parameters

  • border_width: number

    border width

  Returns void

  Since

  23.07.0

Since 23.07.0set_certificate_info

• set_certificate_info(certificate_info: CertificateInfo): void

  Set certification information.

  Parameters

  • certificate_info: CertificateInfo

    a Poppler.CertificateInfo

  Returns void

  Since

  23.07.0

Since 23.07.0set_destination_filename

• set_destination_filename(filename: string): void

  Set destination file name.

  Parameters

  • filename: string

    destination filename

  Returns void

  Since

  23.07.0

Since 23.07.0set_document_owner_password

• set_document_owner_password(document_owner_password: string): void

  Set document owner password (for encrypted files).

  Parameters

  • document_owner_password: string

    document owner password

  Returns void

  Since

  23.07.0

Since 23.07.0set_document_user_password

• set_document_user_password(document_user_password: string): void

  Set document user password (for encrypted files).

  Parameters

  • document_user_password: string

    document user password

  Returns void

  Since

  23.07.0

Since 23.07.0set_field_partial_name

• set_field_partial_name(field_partial_name: string): void

  Set field partial name (existing field id or a new one) where signature is placed.

  Parameters

  • field_partial_name: string

    a field partial name

  Returns void

  Since

  23.07.0

Since 23.07.0set_font_color

• set_font_color(font_color: Poppler.Color): void

  Set signature font color.

  Parameters

  • font_color: Poppler.Color

    a Poppler.Color to be used as signature font color

  Returns void

  Since

  23.07.0

Since 23.07.0set_font_size

• set_font_size(font_size: number): void

  Set signature font size (>0).

  Parameters

  • font_size: number

    signature font size

  Returns void

  Since

  23.07.0

Since 23.07.0set_image_path

• set_image_path(image_path: string): void

  Set signature background (watermark) image path.

  Parameters

  • image_path: string

    signature image path

  Returns void

  Since

  23.07.0

Since 23.07.0set_left_font_size

• set_left_font_size(font_size: number): void

  Set signature left font size (> 0).

  Parameters

  • font_size: number

    signature font size

  Returns void

  Since

  23.07.0

Since 23.07.0set_location

• set_location(location: string): void

  Set signature location (e.g. "At my desk").

  Parameters

  • location: string

    a location

  Returns void

  Since

  23.07.0

Since 23.07.0set_page

• set_page(page: number): void

  Set page (>=0).

  Parameters

  • page: number

    a page number

  Returns void

  Since

  23.07.0

Since 23.07.0set_password

• set_password(password: string): void

  Set password for the signing key.

  Parameters

  • password: string

    a password

  Returns void

  Since

  23.07.0

Since 23.07.0set_reason

• set_reason(reason: string): void

  Set reason for signature (e.g. I'm approver).

  Parameters

  • reason: string

    a reason

  Returns void

  Since

  23.07.0

Since 23.07.0set_signature_rectangle

• set_signature_rectangle(signature_rect: Poppler.Rectangle): void

  Set signature rectangle.

  Parameters

  • signature_rect: Poppler.Rectangle

    a Poppler.Rectangle where signature should be shown

  Returns void

  Since

  23.07.0

Since 23.07.0set_signature_text

• set_signature_text(signature_text: string): void

  Set signature text.

  Parameters

  • signature_text: string

    text to show as main signature

  Returns void

  Since

  23.07.0

Since 23.07.0set_signature_text_left

• set_signature_text_left(signature_text_left: string): void

  Set small signature text on the left hand.

  Parameters

  • signature_text_left: string

    text to show as small left signature

  Returns void

  Since

  23.07.0

Staticnew

• new(): SigningData

  Returns SigningData