pspdfkit/com.pspdfkit.signatures/SignatureAppearance

SignatureAppearance

data class SignatureAppearance(val signatureAppearanceMode: SignatureAppearance.SignatureAppearanceMode = SignatureAppearanceMode.SIGNATURE_AND_DESCRIPTION, val showSignerName: Boolean = true, val showSignDate: Boolean = true, val showSignatureReason: Boolean = false, val showSignatureLocation: Boolean = false, val signatureGraphic: SignatureGraphic? = null, val signatureWatermark: SignatureGraphic? = null, val reuseExistingSignatureAppearanceStream: Boolean = true, val showWatermark: Boolean = true, val showDateTimezone: Boolean = true) : Parcelable

Configures the appearance of digital signatures that are added to the document.

Constructors

SignatureAppearance

constructor(signatureAppearanceMode: SignatureAppearance.SignatureAppearanceMode = SignatureAppearanceMode.SIGNATURE_AND_DESCRIPTION, showSignerName: Boolean = true, showSignDate: Boolean = true, showSignatureReason: Boolean = false, showSignatureLocation: Boolean = false, signatureGraphic: SignatureGraphic? = null, signatureWatermark: SignatureGraphic? = null, reuseExistingSignatureAppearanceStream: Boolean = true, showWatermark: Boolean = true, showDateTimezone: Boolean = true)

Types

SignatureAppearanceMode

enum SignatureAppearanceMode : Enum<SignatureAppearance.SignatureAppearanceMode>

Controls how the digital signature will appear after signing.

Properties

reuseExistingSignatureAppearanceStream

val reuseExistingSignatureAppearanceStream: Boolean = true

Controls whether or not an existing appearance stream for the signature should be used.

showDateTimezone

val showDateTimezone: Boolean = true

Indicates whether the date will include the timezone, if showSignDate is true.

showSignatureLocation

val showSignatureLocation: Boolean = false

Indicates whether or not the location where the signature was created will be shown.

showSignatureReason

val showSignatureReason: Boolean = false

Indicates whether or not the reason for the signature will be shown.

showSignDate

val showSignDate: Boolean = true

Indicates whether the date of the signature will be shown or not.

showSignerName

val showSignerName: Boolean = true

Indicates whether the name of the signer will be shown or not.

showWatermark

val showWatermark: Boolean = true

Indicates whether the PSPDFKit watermark will be shown.

signatureAppearanceMode

val signatureAppearanceMode: SignatureAppearance.SignatureAppearanceMode

The SignatureAppearanceMode controls how the signature will be displayed.

signatureGraphic

val signatureGraphic: SignatureGraphic? = null

The SignatureGraphic can be displayed instead of the signer name. If no SignatureGraphic is set the signer name will be displayed. If you want to disable the default PSPDFKit watermark that is shown use showWatermark.

signatureWatermark

val signatureWatermark: SignatureGraphic? = null

Gets the signature watermark that will be shown unless showWatermark is false.