Class SignatureAppearance

Namespace

SimpleSign.PAdES.Signing

Assembly

SimpleSign.PAdES.dll

Visual appearance settings for a visible signature annotation.

public sealed class SignatureAppearance

Inheritance

object

SignatureAppearance

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AutoPosition

When true, the library automatically positions the signature at the bottom of the page, left-to-right, wrapping to a new row above when the current row is full.

public bool AutoPosition { get; init; }

Property Value

bool

BackgroundImageJpeg

Background image bytes (JPEG format). Rendered behind the text in the signature stamp. If both JPEG and PNG are set, PNG takes precedence.

public ReadOnlyMemory<byte>? BackgroundImageJpeg { get; init; }

Property Value

ReadOnlyMemory<byte>?

BackgroundImagePng

Background image bytes (PNG format, RGB/Gray, 8-bit, non-interlaced). Rendered behind the text in the signature stamp. If both JPEG and PNG are set, PNG takes precedence.

public ReadOnlyMemory<byte>? BackgroundImagePng { get; init; }

Property Value

ReadOnlyMemory<byte>?

BaseFontName

Base14 font name used by the appearance text (default: Helvetica). Examples: Helvetica, Times-Roman, Courier, Helvetica-Bold.

public string? BaseFontName { get; init; }

Property Value

string

BorderColor

Border color as RGB triplet (0.0–1.0 each). When null, no border is drawn.

public (float R, float G, float B)? BorderColor { get; init; }

Property Value

(float R, float G, float B)?

BorderWidth

Border width in points. Only used when BorderColor is set. Default: 0.5.

public float BorderWidth { get; init; }

Property Value

float

CustomFontSize

Custom font size for the signer name. Default: 7pt.

public float? CustomFontSize { get; init; }

Property Value

float?

CustomLabelFontSize

Custom font size for labels ("Signed by", date, reason, location). Default: 6pt.

public float? CustomLabelFontSize { get; init; }

Property Value

float?

ExtraLines

Extra text lines rendered after the standard fields (date, reason, location). Useful for AEA manifesto data (CPF, e-mail, IP). Each entry is rendered as a separate line in the stamp.

public IReadOnlyList<string>? ExtraLines { get; init; }

Property Value

IReadOnlyList<string>

Page

Page number (1-based) where the signature annotation is placed.

public int Page { get; init; }

Property Value

int

ShowDate

Whether to display the signing date/time. Default true.

public bool ShowDate { get; init; }

Property Value

bool

ShowLocation

Whether to display the signing location.

public bool ShowLocation { get; init; }

Property Value

bool

ShowReason

Whether to display the signing reason.

public bool ShowReason { get; init; }

Property Value

bool

TextColor

Text color as RGB triplet (0.0–1.0 each). Default: black (0, 0, 0).

public (float R, float G, float B)? TextColor { get; init; }

Property Value

(float R, float G, float B)?

VerificationUrl

URL for a verification endpoint. When set, a QR code encoding this URL is rendered on the left side of the visual signature stamp.

public string? VerificationUrl { get; init; }

Property Value

string

X

X coordinate of the annotation rectangle (lower-left corner, in points). Ignored when AutoPosition is true.

public float X { get; init; }

Property Value

float

Y

Y coordinate of the annotation rectangle (lower-left corner, in points). Ignored when AutoPosition is true.

public float Y { get; init; }

Property Value

float

Methods

Auto()

Creates an auto-positioned signature appearance. Signatures are placed left-to-right at the bottom of the page, wrapping to a new row when the line is full.

public static SignatureAppearance Auto()

Returns

SignatureAppearance

Auto(bool, bool)

Creates an auto-positioned signature appearance with reason and location visible.

public static SignatureAppearance Auto(bool showReason, bool showLocation)

Parameters

showReason bool

showLocation bool

Returns

SignatureAppearance