Class TextWidget
An object representing a Text Box used in a PDF Form.
Implements
Inherited Members
Namespace: pdftron.PDF.Annots
Assembly: PDFTronDotNet.dll
Syntax
public class TextWidget : Widget, IDisposableConstructors
TextWidget(Annot)
Creates a Text Widget annotation and initialize it using given annotation object.
Declaration
public TextWidget(Annot ann)Parameters
| Type | Name | Description |
|---|---|---|
| Annot | ann | the annot |
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 |
TextWidget(Obj)
Creates a Text Widget annotation and initialize it using given Cos/SDF object.
Declaration
public TextWidget(Obj d)Parameters
| Type | Name | Description |
|---|---|---|
| Obj | d | The object to use to initialize the Text Widget |
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 Text Widget annotation, in the specified document.
Declaration
public static TextWidget 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 |
|---|---|
| TextWidget | A newly created blank Text Widget annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Create(PDFDoc, Rect, Field)
Creates a new Text Widget annotation, in the specified document.
Declaration
public static TextWidget Create(PDFDoc doc, Rect pos, Field field)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. |
| Field | field | the field for which to create a Text Widget |
Returns
| Type | Description |
|---|---|
| TextWidget | A newly created blank Widget annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Create(PDFDoc, Rect, String)
Creates a new Text Widget annotation, in the specified document.
Declaration
public static TextWidget Create(PDFDoc doc, Rect pos, string field_name)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. |
| System.String | field_name | The name of the field for which to create a Text widget |
Returns
| Type | Description |
|---|---|
| TextWidget | A newly created blank Text Widget annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
GetText()
Retrieves the text content of the Text Widget.
Declaration
public string GetText()Returns
| Type | Description |
|---|---|
| System.String | The Text Widget contents |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
SetText(String)
Set the text content of the Text Widget.
Declaration
public void SetText(string text)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | text | The text tp be displayed in the Text Widget |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |