Class SignatureOptions
Defines specific configuration options related to the electronic signatures feature.
Inheritance
Namespace: PSPDFKit.Pdf.ElectronicSignatures
Assembly: PSPDFKit.dll
Syntax
public sealed class SignatureOptions : objectProperties
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; }Property Value
| Type | Description |
|---|---|
| IEnumerable<ElectronicSignatureCreationMode> |
DefaultCreationModes
These are the ElectronicSignatureCreationModes set by default.
Declaration
public static IEnumerable<ElectronicSignatureCreationMode> DefaultCreationModes { get; }Property Value
| Type | Description |
|---|---|
| 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 |
|---|---|
| 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; }Property Value
| Type | Description |
|---|---|
| IEnumerable<Font> |
ForceLegacySignaturesFeature
This property allows you to use the old ui for signatures even if the Electronic Signatures component is enabled.
Note that the CreationModes and Fonts lists will be ignored if this is true.
It is false by default.
Declaration
public bool ForceLegacySignaturesFeature { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Create()
Creates a SignatureOptions instance with default values.
See DefaultCreationModes and DefaultFonts for a list.
Declaration
public static SignatureOptions Create()Returns
| Type | Description |
|---|---|
| SignatureOptions | The SignatureOptions instance. |
Create(IEnumerable<ElectronicSignatureCreationMode>)
Creates a SignatureOptions instance with custom ElectronicSignatureCreationModes enabled.
Declaration
public static SignatureOptions Create(IEnumerable<ElectronicSignatureCreationMode> creationModes)Parameters
| Type | Name | Description |
|---|---|---|
| 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
public static SignatureOptions Create(IEnumerable<ElectronicSignatureCreationMode> creationModes, IEnumerable<Font> fonts)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<ElectronicSignatureCreationMode> | creationModes | |
| 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
public static SignatureOptions Create(IEnumerable<Font> fonts)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<Font> | fonts |
Returns
| Type | Description |
|---|---|
| SignatureOptions | The SignatureOptions instance. |