Class PushButtonWidget
An object representing a push button used in a PDF Form.
Implements
Inherited Members
Namespace: pdftron.PDF.Annots
Assembly: PDFNet.dll
Syntax
public class PushButtonWidget : Widget, IDisposableConstructors
PushButtonWidget(Annot)
Creates a Push Button Widget annotation and initialize it using given annotation object.
Declaration
public PushButtonWidget(Annot ann)Parameters
| Type | Name | Description |
|---|---|---|
| Annot | ann | the annotation from which to create a Push Button Widget |
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 |
PushButtonWidget(Obj)
Creates a Push Button Widget annotation and initialize it using given Cos/SDF object.
Declaration
public PushButtonWidget(Obj d)Parameters
| Type | Name | Description |
|---|---|---|
| Obj | d | The object to use to initialize the PushButtonWidget |
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 PushButton widget annotation, in the specified document.
Declaration
public static PushButtonWidget Create(PDFDoc doc, Rect pos)Parameters
| Type | Name | Description |
|---|---|---|
| PDFDoc | doc | The document to which the annotation is added. |
| Rect | pos | A rectangle specifying the annotation's bounds, specified in user space coordinates. |
Returns
| Type | Description |
|---|---|
| PushButtonWidget | A newly created default Push Button Widget annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Create(PDFDoc, Rect, string)
Creates a new Push Button Widget annotation, in the specified document.
Declaration
public static PushButtonWidget Create(PDFDoc doc, Rect pos, string field_name)Parameters
| Type | Name | Description |
|---|---|---|
| PDFDoc | doc | The document to which the annotation is added. |
| Rect | pos | A rectangle specifying the annotation's bounds, specified in user space coordinates. |
| string | field_name | The name of the field for which to create a PushButton widget |
Returns
| Type | Description |
|---|---|
| PushButtonWidget | A newly created default Push Button Widget annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Create(PDFDoc, Rect, Field)
Creates a new Push Button Widget annotation, in the specified document.
Declaration
public static PushButtonWidget Create(PDFDoc doc, Rect pos, Field field)Parameters
| Type | Name | Description |
|---|---|---|
| PDFDoc | doc | A document to which the annotation is added. |
| Rect | pos | A rectangle specifying the annotation's bounds, specified in user space coordinates. |
| Field | field | the field for which to create a Push Button Widget |
Returns
| Type | Description |
|---|---|
| PushButtonWidget | A newly created default Push Button Widget annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Dispose(bool)
Declaration
[HandleProcessCorruptedStateExceptions]
protected override void Dispose(bool A_0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | A_0 |
Overrides
~PushButtonWidget()
Declaration
protected ~PushButtonWidget()