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
System.Object
Annot
Widget
SignatureWidget
Implements
System.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, Int32)
Widget.GetBackgroundColorCompNum()
Widget.GetBackgroundColor()
Widget.SetBackgroundColor(ColorPt, Int32)
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(Boolean)
Widget.SetTextColor(ColorPt, Int32)
Widget.GetTextColor()
Widget.GetTextColorCompNum()
Widget.SetFontSize(Double)
Widget.GetFontSize()
Widget.SetFont(Font)
Widget.GetFont()
Annot.Dispose()
Annot.Dispose(Boolean)
Annot.GetHandleInternal()
Annot.GetRefHandleInternal()
Annot.CreateInternal(IntPtr, Object)
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, Boolean)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance()
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance(Annot.AnnotationState, String)
Annot.SetAppearance(Obj)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj, Annot.AnnotationState, String)
Annot.RemoveAppearance()
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance(Annot.AnnotationState, String)
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(String)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt, Int32)
Annot.SetColor(ColorPt)
Annot.GetStructParent()
Annot.SetStructParent(Int32)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(Int32)
Annot.RefreshAppearance()
Annot.GetCustomData(String)
Annot.SetCustomData(String, String)
Annot.DeleteCustomData(String)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: pdftron.PDF.Annots
Assembly: PDFTronDotNet.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, 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

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.

System.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

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.

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

System.IDisposable
Back to top Generated by DocFX