Class SignatureOptions

Defines specific configuration options related to the electronic signatures feature.

Inheritance

System.Object

SignatureOptions

Namespace: PSPDFKit.Pdf.ElectronicSignatures

Assembly: PSPDFKit.dll

Syntax

public sealed class SignatureOptions

Properties

ColorPresets

A list containing the color presets available for electronic signatures.
Defaults to DefaultColorPresets.

Declaration

public IEnumerable<ColorPreset> ColorPresets { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ColorPreset>

CreationModes

A list containing the enabled modes for creating electronic signatures. Note that the order of the tabs is tied to the order of the items.
Defaults to showing all three ElectronicSignatureCreationMode options.

Declaration

public IEnumerable<ElectronicSignatureCreationMode> CreationModes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ElectronicSignatureCreationMode>

DefaultColorPresets

These are the color presets set by default.

Declaration

public static IEnumerable<ColorPreset> DefaultColorPresets { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ColorPreset>

DefaultCreationModes

These are the ElectronicSignatureCreationModes set by default.

Declaration

public static IEnumerable<ElectronicSignatureCreationMode> DefaultCreationModes { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ElectronicSignatureCreationMode>

DefaultFonts

These are the fonts available by default on the typing tab.
For customizing these, refer to Font and Fonts.

Declaration

public static IEnumerable<Font> DefaultFonts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Font>

Fonts

A list containing the Fonts available to the user on the typing tab.
Defaults to showing DefaultFonts.

Declaration

public IEnumerable<Font> Fonts { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Font>

Methods

Create()

Creates a SignatureOptions instance with default values.
See DefaultCreationModes and DefaultFonts for a list.

Declaration

[Obsolete("Marked obsolete in the favor of default public constructor.", true)]
public static SignatureOptions Create()

Returns

Type	Description
SignatureOptions	The SignatureOptions instance.

Create(IEnumerable<ElectronicSignatureCreationMode>)

Creates a SignatureOptions instance with custom ElectronicSignatureCreationModes enabled.

Declaration

[DefaultOverload]
[Obsolete("Marked obsolete in the favor of default public constructor and property setters.", true)]
public static SignatureOptions Create(IEnumerable<ElectronicSignatureCreationMode> creationModes)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ElectronicSignatureCreationMode>	creationModes

Returns

Type	Description
SignatureOptions	The SignatureOptions instance.

Create(IEnumerable<ElectronicSignatureCreationMode>, IEnumerable<Font>)

Creates a SignatureOptions instance with custom fonts and ElectronicSignatureCreationModes enabled.
See DefaultCreationModes and DefaultFonts for a list of the defaults.
Moreover, for setting custom fonts, see Font. Your list can be a mix of default and custom fonts.

Declaration

[Obsolete("Marked obsolete in the favor of default public constructor and property setters..", true)]
public static SignatureOptions Create(IEnumerable<ElectronicSignatureCreationMode> creationModes, IEnumerable<Font> fonts)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ElectronicSignatureCreationMode>	creationModes
System.Collections.Generic.IEnumerable<Font>	fonts

Returns

Type	Description
SignatureOptions	The SignatureOptions instance.

Create(IEnumerable<Font>)

Creates a SignatureOptions instance with a custom fonts list.
See DefaultFonts for a list of default fonts, and Font for loading in custom ones.
Your list can be a mix of default and custom fonts.

Declaration

[Obsolete("Marked obsolete in the favor of default public constructor and property setters..", true)]
public static SignatureOptions Create(IEnumerable<Font> fonts)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<Font>	fonts

Returns

Type	Description
SignatureOptions	The SignatureOptions instance.