Class PdfSignatureAppearance

Namespace

MiPdf.Signatures

Assembly

MiPdf.dll

Appearance of a visible signature.

public sealed class PdfSignatureAppearance

Inheritance

object

PdfSignatureAppearance

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Background

Fill color of the whole appearance; null (default) = transparent.

public PdfColor? Background { get; set; }

Property Value

PdfColor?

Border

Color of a 1-point border around the appearance; null (default) = no border.

public PdfColor? Border { get; set; }

Property Value

PdfColor?

DateFormat

Format for {date}.

public string DateFormat { get; set; }

Property Value

string

Draw

Custom drawing into the appearance, called after background and image and before the text. Arguments: canvas, width, height (origin bottom-left, points). Set Text to "" for no text, e.g. to draw handwritten ink with InkRenderer.

public Action<PdfCanvas, double, double>? Draw { get; set; }

Property Value

Action<PdfCanvas, double, double>

Font

Font of the text (default Helvetica; use an embedded font for PDF/A or non-Latin text).

public PdfFont Font { get; set; }

Property Value

PdfFont

FontSize

Font size; 0 = fit the text into the rectangle.

public double FontSize { get; set; }

Property Value

double

Image

Optional image, e.g. a logo or a scanned handwritten signature (placed according to ImagePosition).

public PdfImage? Image { get; set; }

Property Value

PdfImage

ImagePosition

Where the Image is placed (default Left).

public SignatureImagePosition ImagePosition { get; set; }

Property Value

SignatureImagePosition

KeepUpright

Draw the appearance upright as seen in viewers when the page is rotated (/Rotate), or rotated by the /MK /R of an existing signature field (default true). The rectangle stays in unrotated page coordinates; on a page rotated by 90 or 270 degrees the visible width is the rectangle's height. false = draw in unrotated page orientation.

public bool KeepUpright { get; set; }

Property Value

bool

Text

Text template. Placeholders: {name}, {date}, {reason}, {location}, {contact}. Lines whose placeholders are empty are omitted. Default: signer, date, reason and location.

public string? Text { get; set; }

Property Value

string

TextColor

Color of the text (default black).

public PdfColor TextColor { get; set; }

Property Value

PdfColor

TextStripRatio

Share of the height used by the text strip for Top (default 0.3).

public double TextStripRatio { get; set; }

Property Value

double