SignatureAppearance

Defines the visual appearance of a signature in a PDF document. Used for both digital signatures (with certificate) and electronic signatures (visual only).

from nutrient_sdk import SignatureAppearance

Construction

SignatureAppearance()

Creates a new SignatureAppearance instance with default settings.

Properties

font_name

@property
def font_name(self) -> str

@font_name.setter
def font_name(self, value: str) -> None

The name of the font to use for text in the signature appearance.

Type: str

font_size

@property
def font_size(self) -> float

@font_size.setter
def font_size(self, value: float) -> None

The font size in points for text in the signature appearance.

Type: float

image_path

@property
def image_path(self) -> str

@image_path.setter
def image_path(self, value: str) -> None

The file path to an image to display in the signature appearance.

Type: str

show_validation_mark

@property
def show_validation_mark(self) -> bool

@show_validation_mark.setter
def show_validation_mark(self, value: bool) -> None

When true, displays a validation mark icon in the signature appearance. Only applicable for digital signatures (with certificate).

Type: bool

text

@property
def text(self) -> str

@text.setter
def text(self, value: str) -> None

Custom text to display in the signature appearance. When set, this overrides .

Type: str

text_color

@property
def text_color(self) -> Color

@text_color.setter
def text_color(self, value: Color) -> None

The color of the text in the signature appearance.

Type: Color

use_auto_generated_text

@property
def use_auto_generated_text(self) -> bool

@use_auto_generated_text.setter
def use_auto_generated_text(self, value: bool) -> None

When true, automatically generates text from signature metadata (signer name, reason, location, date). This is the default behavior when no custom text or image is provided.

Type: bool