Pdf |
Inheritance HierarchySautinSoft.Pdf.AnnotationsPdfAppearance
SautinSoft.Pdf.FormsPdfFieldAppearance
SautinSoft.Pdf.FormsPdfSignatureAppearance
Namespace: SautinSoft.Pdf.Forms
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2025.3.13
SyntaxThe PdfSignatureAppearance type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BackgroundColor | Gets or sets the background color of the signature appearance. Default value: . |
| BackgroundLayer | Gets or sets the background layer. This layer renders the background and border of the signature field. The properties that specify the background and border exist in the PdfSignatureAppearance. Default value: a PdfForm instance that renders the background and border of the signature field as specified by the background and border properties from this PdfSignatureAppearance. |
| BorderColor | Gets or sets the border color of the signature appearance. Default value: . |
| BorderDashPattern | Gets or sets the border dash pattern of the signature appearance. Default value: Solid. |
| BorderStyle | Gets or sets the border style of the signature appearance. Default value: Solid. |
| BorderWidth | Gets or sets the border thickness of the signature appearance. Default value: 1 point. |
| ComponentVersionLabel | Gets or sets the component version label. This property can be used to localize the label. Default value: "SautinSoft.Pdf version: ". |
| Date | Gets or sets the time of signing. Default value: Date. |
| DateFormat | Gets or sets the Date format string. Default value: . |
| DateFormatProvider | Gets or sets the Date culture-specific formatting provider. Default value: . |
| DateLabel | Gets or sets the Date label. This property can be used to localize the label. Default value: "Date: ". |
| DistinguishedName | Gets or sets the distinguished name of the person or authority signing the document. Default value: . |
| DistinguishedNameLabel | Gets or sets the DistinguishedName label. This property can be used to localize the label. Default value: "DN: ". |
| Font | Gets or sets the font of the signature appearance text. Default value: Helvetica of size 10 points. |
| FontColor | Gets or sets the font color of the signature appearance text. Default value: Black. |
| FontFace | Gets or sets the font face of the signature appearance text. Default value: Helvetica. |
| FontFamily | Gets or sets the font family of the signature appearance text. Default value: Helvetica. |
| FontSize | Gets or sets the font size of the signature appearance text. A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle. Default value: 10 points. |
| FontStretch | Gets or sets the font stretch of the signature appearance text. Default value: Normal. |
| FontStyle | Gets or sets the font style of the signature appearance text. Default value: Normal. |
| FontWeight | Gets or sets the font weight of the signature appearance text. Default value: Normal. |
| Icon | Gets or sets the optional signature icon. Default value: . |
| IconAlignment | Gets or sets the two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the Icon. A value of (0.0, 0.0) shall position the icon at the bottom-left corner of the annotation rectangle. A value of (0.5, 0.5) shall center it within the rectangle. This entry shall be used only if the icon is scaled proportionally. Default value: (0.5, 0.5). |
| IconScaleCondition | Gets or sets the condition under which the Icon shall be scaled inside the annotation rectangle. Default value: Always. |
| IconScaleProportional | Gets or sets a value indicating whether to scale the Icon to fit the width or height of the annotation rectangle while maintaining the icon's original aspect ratio. If the required horizontal and vertical scaling factors are different, the smaller of the two is used, centering the icon within the annotation rectangle in the other dimension. If , the Icon is scaled to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height). Default value: . |
| IncludeComponentVersion | Gets or sets a value indicating whether to include component version in the signature's appearance. Default value: . |
| IncludeLabels | Gets or sets a value indicating whether to include labels in the signature's appearance. Default value: . |
| LineHeight | Gets or sets the line height, or line spacing, between lines of the signature appearance text. Default value: 11.56 points. |
| Location | Gets or sets the CPU host name or physical location of the signing. Default value: Location. |
| LocationLabel | Gets or sets the Location label. This property can be used to localize the label. Default value: "Location: ". |
| MaxTextWidth | Gets or sets the maximum text width for a line of the signature appearance text. Default value: 0. This formats the text into an infinite width without any implicit text wrapping. |
| Name | Gets or sets the name of the person or authority signing the document. Default value: Name. |
| NameLabel | Gets or sets the Name label. This property can be used to localize the label. Default value: "Digitally signed by ". |
| Position | Gets or sets the position of the top-left corner of the signature appearance text. Default value: (1.66, 0). |
| Reason | Gets or sets the reason for the signing. Default value: Reason. |
| ReasonLabel | Gets or sets the Reason label. This property can be used to localize the label. Default value: "Reason: ". |
| ShrinkTextOnOverflow | Gets or sets a value indicating whether the signature appearance text should be auto-fit to the bounding box of the widget annotation associated with the signature field. Default value: . |
| SignatureInvalidLayer | Gets or sets the validity layer used for the 'Signature invalid' state. If this property is set to a non- value, then also SignatureValidLayer property must be set to a non- value for Adobe Reader to show the run-time created signature validity icon. At runtime, Adobe Reader replaces the SignatureInvalidLayer with the dynamically created 100 pt x 100 pt layer that shows 'Signature invalid' icon if the signature is invalid. Default value: . |
| SignatureInvalidLayerTransform | Gets or sets the transformation applied to the SignatureInvalidLayer. Useful to reposition and resize the SignatureInvalidLayer. Default value: Identity. |
| SignatureLayer | Gets or sets the signature appearance layer, containing information about the signature. This layer renders the information about the signature. The properties that specify the font, color and the rest of the information exist in the PdfSignatureAppearance and the associated PdfSigner. Default value: if Value is not null, a PdfForm instance that renders the information about the signature as specified by the font, color, and other properties from this PdfSignatureAppearance and the associated PdfSigner; otherwise, null. |
| SignatureValidLayer | Gets or sets the validity layer used for 'Signature valid' and 'Validity unknown' states. If this property is set to a non- value, then also SignatureInvalidLayer property must be set to a non- value for Adobe Reader to show the run-time created signature validity icon. At runtime, Adobe Reader replaces the SignatureValidLayer with the dynamically created 100 pt x 100 pt layer that shows either 'Signature valid' icon or 'Validity unknown' icon, depending on the state of the signature validity. Default value: . |
| SignatureValidLayerTransform | Gets or sets the transformation applied to the SignatureValidLayer. Useful to reposition and resize the SignatureValidLayer. Default value: Identity. |
| TextAlignment | Gets or sets the text alignment of the signature appearance text. Default value: Left. |
| TextBoundsAlignment | Gets or sets the two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the signature appearance text bounds. A value of (0.0, 0.0) shall position the signature appearance text bounds at the bottom-left corner of the annotation rectangle. A value of (0.5, 0.5) shall center it within the rectangle. If FontSize is 0 or if ShrinkTextOnOverflow is true and the signature appearance text overflows then the scaled signature appearance text might allocate the entire leftover space at the left or at the bottom (or both) of the signature appearance text bounds and the alignment specified in that direction won't have any effect. Default value: (0, 1). This positions the signature appearance text bounds at the top-left corner of the annotation rectangle. |
| TextExtent | Gets or sets the number that shall be between 0.0 and 1.0 indicating the fraction of the annotation rectangle size to allocate for the text. The rest is allocated for the Icon. Applicable only if Icon is not . Default value: 0.5. |
| TextPlacement | Gets or sets the placement of the signature text relative to the Icon. Default value: TextOnly. |
| ValidityTextLayer | Gets or sets the text layer used for a text representation of the state of the signature. If this property is set to a non- value, then also SignatureValidLayer and SignatureInvalidLayer properties must be set to a non- value for Adobe Reader to show the run-time created signature validity text message. At runtime, Adobe Reader replaces the ValidityTextLayer with the dynamically created layer of the same size that shows the signature validity text message. Default value: . |
| ValidityTextLayerTransform | Gets or sets the transformation applied to the ValidityTextLayer. Useful to reposition and resize the ValidityTextLayer. Default value: Identity. |
Methods| Name | Description | |
|---|---|---|
 | ToString |
Returns a Unicode text contained in this PdfSignatureAppearance.
(Overrides ObjectToString) |
| Update | Updates the appearance of widget annotation associated with the current PdfSignatureField based on the specified signer, Value, and properties of this PdfSignatureAppearance. |
See Also