PSPDFSignatureAppearance

Objective-C


@interface PSPDFSignatureAppearance
    : PSPDFBaseConfiguration <PSPDFSignatureAppearanceBuilder *>

Swift

class PDFSignatureAppearance : BaseConfiguration<PDFSignatureAppearanceBuilder>

This class configures the appearance that a PSPDFSignatureElement will have in a document when signed.

By default, a digital signature form element will show information from the signing certificate, like the signer’s name, the date when the document was signed, and so on. Use a PSPDFSignatureAppearance instance when you want to configure further how this information is presented to the user.

  • The appearance style that is configured (signature and description, description only, signature only). Defaults to PSPDFSignatureAppearanceModeSignatureAndDescription.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFSignatureAppearanceMode appearanceMode;

    Swift

    var appearanceMode: PDFSignatureAppearance.Mode { get }

  • Whether to show or not the person who signed the PSPDFSignatureElement. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL showSignerName;

    Swift

    var showSignerName: Bool { get }

  • Whether to show or not the date when the document was signed. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL showSigningDate;

    Swift

    var showSigningDate: Bool { get }

  • Whether to show or not the reason why the document was signed (ie. “Contract agreement”). Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL showSignatureReason;

    Swift

    var showSignatureReason: Bool { get }

  • Whether to show or not the place where the document was signed. Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL showSignatureLocation;

    Swift

    var showSignatureLocation: Bool { get }

  • The signature graphic to show on the left part of a signature when mode is PSPDFSignatureAppearanceModeSignatureAndDescription. Defaults to nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) PSPDFAnnotationAppearanceStream *signatureGraphic;

    Swift

    var signatureGraphic: PSPDFAnnotationAppearanceStream? { get }

  • The signature watermark to show in the centre of the signature when mode is PSPDFSignatureAppearanceModeSignatureAndDescription. If PSPDFSignatureAppearanceModeSignatureOnly is set, this is the entire appearance stream. Apperance is centered by default but can fill the entire signature if width/height are the same as the signature form element. Defaults to nil which renders the pspdfkit logo.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) PSPDFAnnotationAppearanceStream *signatureWatermark;

    Swift

    var signatureWatermark: PSPDFAnnotationAppearanceStream? { get }

  • Configures whether the existing signature appearance is kept after the document is signed. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL reuseExistingAppearance;

    Swift

    var reuseExistingAppearance: Bool { get }

  • Whether to show or not the signature watermark. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showWatermark;

    Swift

    var showWatermark: Bool { get set }