Show / Hide Table of Contents

# Class SignatureWidget

An object representing a Signature used in a PDF Form. These Widgets can be signed directly, or signed using a DigitalSignatureField.

##### Inheritance

object
Annot
Widget
SignatureWidget

##### Implements

IDisposable

##### Inherited Members

Widget.Create(SDFDoc, Rect, Field)
Widget.GetField()
Widget.GetHighlightingMode()
Widget.SetHighlightingMode(Widget.HighlightingMode)
Widget.GetAction()
Widget.SetAction(Action)
Widget.GetBorderColorCompNum()
Widget.GetBorderColor()
Widget.SetBorderColor(ColorPt, int)
Widget.GetBackgroundColorCompNum()
Widget.GetBackgroundColor()
Widget.SetBackgroundColor(ColorPt, int)
Widget.GetStaticCaptionText()
Widget.SetStaticCaptionText(string)
Widget.GetRolloverCaptionText()
Widget.SetRolloverCaptionText(string)
Widget.GetMouseDownCaptionText()
Widget.SetMouseDownCaptionText(string)
Widget.GetStaticIcon()
Widget.SetStaticIcon(Obj)
Widget.GetRolloverIcon()
Widget.SetRolloverIcon(Obj)
Widget.GetMouseDownIcon()
Widget.SetMouseDownIcon(Obj)
Widget.GetScaleType()
Widget.SetScaleType(Widget.ScaleType)
Widget.GetIconCaptionRelation()
Widget.SetIconCaptionRelation(Widget.IconCaptionRelation)
Widget.GetScaleCondition()
Widget.SetScaleCondition(Widget.ScaleCondition)
Widget.GetHIconLeftOver()
Widget.SetHIconLeftOver(double)
Widget.GetVIconLeftOver()
Widget.SetVIconLeftOver(double)
Widget.GetFitFull()
Widget.SetFitFull(bool)
Widget.GetTextColor()
Widget.GetTextColorCompNum()
Widget.SetTextColor(ColorPt, int)
Widget.GetFontSize()
Widget.SetFontSize(double)
Widget.GetFont()
Widget.SetFont(Font)
Annot.GetTriggerAction(Annot.EventType)
Annot.Create(SDFDoc, Annot.Type, Rect)
Annot.op_Assign(Annot)
Annot.Equals(object)
Annot.IsValid()
Annot.GetSDFObj()
Annot.GetType()
Annot.IsMarkup()
Annot.GetRect()
Annot.GetVisibleContentBox()
Annot.SetRect(Rect)
Annot.GetContents()
Annot.SetContents(string)
Annot.GetPage()
Annot.SetPage(Page)
Annot.GetUniqueID()
Annot.SetUniqueID(string)
Annot.GetDate()
Annot.SetDate(Date)
Annot.GetFlag(Annot.Flag)
Annot.SetFlag(Annot.Flag, bool)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance(Annot.AnnotationState, string)
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance()
Annot.SetAppearance(Obj, Annot.AnnotationState, string)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj)
Annot.RemoveAppearance(Annot.AnnotationState, string)
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance()
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(string)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt)
Annot.SetColor(ColorPt, int)
Annot.GetStructParent()
Annot.SetStructParent(int)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(int)
Annot.RefreshAppearance(RefreshOptions)
Annot.RefreshAppearance()
Annot.GetCustomData(string)
Annot.SetCustomData(string, string)
Annot.DeleteCustomData(string)
Annot.Dispose()
object.ToString()
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.MemberwiseClone()

###### Namespace: pdftron.PDF.Annots

###### Assembly: PDFNet.dll

##### Syntax

    public class SignatureWidget : Widget, IDisposable

### Constructors

#### SignatureWidget(Annot)

Creates a SignatureWidget annotation and initialize it using given annotation object.

##### Declaration

    public SignatureWidget(Annot ann)

##### Parameters

Type | Name | Description
--- | --- | ---
Annot | ann | The input annotation

##### Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### SignatureWidget(Obj)

Creates a SignatureWidget annotation and initializes it using given Cos/SDF object.

##### Declaration

    public SignatureWidget(Obj d)

##### Parameters

Type | Name | Description
--- | --- | ---
Obj | d | the object to use to initialize the SignatureWidget

##### Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

### Methods

#### Create(PDFDoc, Rect)

Creates a new SignatureWidget annotation in the specified document, and adds an associated signature form field to the document with a default Field name.

##### Declaration

    public static SignatureWidget Create(PDFDoc doc, Rect pos)

##### Parameters

Type | Name | Description
--- | --- | ---
PDFDoc | doc | The document to which the widget is to be added.
Rect | pos | A rectangle specifying the widget's bounds in default user space units.

##### Returns

Type | Description
--- | ---
SignatureWidget | A newly-created blank SignatureWidget annotation.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### Create(PDFDoc, Rect, string)

Creates a new SignatureWidget annotation in the specified document, and adds a signature form field to the document.

##### Declaration

    public static SignatureWidget Create(PDFDoc doc, Rect pos, string field_name)

##### Parameters

Type | Name | Description
--- | --- | ---
PDFDoc | doc | The document to which the widget is to be added.
Rect | pos | A rectangle specifying the widget's bounds in default user space units.
string | field_name | The name of the digital signature field to create.

##### Returns

Type | Description
--- | ---
SignatureWidget | A newly-created blank SignatureWidget annotation.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### Create(PDFDoc, Rect, DigitalSignatureField)

Creates a new SignatureWidget annotation associated with a particular DigitalSignatureField object (representing a signature-type form field) in the specified document.

##### Declaration

    public static SignatureWidget Create(PDFDoc doc, Rect pos, DigitalSignatureField field)

##### Parameters

Type | Name | Description
--- | --- | ---
PDFDoc | doc | The document to which the widget is to be added.
Rect | pos | A rectangle specifying the widget's bounds in default user space units.
DigitalSignatureField | field | The digital signature field for which to create a signature widget.

##### Returns

Type | Description
--- | ---
SignatureWidget | A newly-created blank SignatureWidget annotation.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### Create(PDFDoc, Rect, Field)

Creates a new SignatureWidget annotation associated with a particular form field in the specified document.

##### Declaration

    public static SignatureWidget Create(PDFDoc doc, Rect pos, Field field)

##### Parameters

Type | Name | Description
--- | --- | ---
PDFDoc | doc | The document to which the widget is to be added.
Rect | pos | A rectangle specifying the widget's bounds in default user space units.
Field | field | The digital signature field for which to create a signature widget.

##### Returns

Type | Description
--- | ---
SignatureWidget | A newly-created blank SignatureWidget annotation.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### CreateSignatureAppearance(Image)

A function that will create and add an appearance to this widget by centering an image within it.

##### Declaration

    public void CreateSignatureAppearance(Image img)

##### Parameters

Type | Name | Description
--- | --- | ---
Image | img | An Image object representing the image to use.

#### Dispose(bool)

##### Declaration

    [HandleProcessCorruptedStateExceptions]
    protected override void Dispose(bool A_0)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | A_0 |

##### Overrides

Widget.Dispose(bool)

#### ~SignatureWidget()

##### Declaration

    protected ~SignatureWidget()

#### GetDigitalSignatureField()

Retrieves the DigitalSignatureField associated with this SignatureWidget.

##### Declaration

    public DigitalSignatureField GetDigitalSignatureField()

##### Returns

Type | Description
--- | ---
DigitalSignatureField | A DigitalSignatureField object representing the digital signature form field associated with this signature widget annotation.

### Implements

IDisposable