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 import SignatureAppearance

Methods

set_font_name 

def set_font_name(self, value: str) -> None

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

Parameters:

NameTypeDescription
valuestrThe value to set for the FontName property.

set_font_size 

def set_font_size(self, value: float) -> None

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

Parameters:

NameTypeDescription
valuefloatThe value to set for the FontSize property.

set_image_path 

def set_image_path(self, value: str) -> None

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

Parameters:

NameTypeDescription
valuestrThe value to set for the ImagePath property.

set_show_validation_mark 

def set_show_validation_mark(self, value: bool) -> None

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

Parameters:

NameTypeDescription
valueboolThe value to set for the ShowValidationMark property.

set_text 

def set_text(self, value: str) -> None

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

Parameters:

NameTypeDescription
valuestrThe value to set for the Text property.

set_text_color 

def set_text_color(self, value: Color) -> None

Sets the color of the text in the signature appearance.

Parameters:

NameTypeDescription
valueColorThe value to set for the TextColor property.

set_use_auto_generated_text 

def set_use_auto_generated_text(self, value: bool) -> None

Sets 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.

Parameters:

NameTypeDescription
valueboolThe value to set for the UseAutoGeneratedText property.

Properties

font_name 

@property
def font_name(self) -> str

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

Type: str

Read-only property.

font_size 

@property
def font_size(self) -> float

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

Type: float

Read-only property.

image_path 

@property
def image_path(self) -> str

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

Type: str

Read-only property.

show_validation_mark 

@property
def show_validation_mark(self) -> bool

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

Type: bool

Read-only property.

text 

@property
def text(self) -> str

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

Type: str

Read-only property.

text_color 

@property
def text_color(self) -> Color

Gets the color of the text in the signature appearance.

Type: Color

Read-only property.

use_auto_generated_text 

@property
def use_auto_generated_text(self) -> bool

Gets 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

Read-only property.