TextField
Represents the text field of a interactive forms. Text fields are boxes or spaces in which the user can enter text from the keyboard.
public class TextField : FormElement, ISerializable
Public Class TextField
Inherits FormElement
Implements ISerializable
Inheritance: ObjectPageElementTaggablePageElementFormElementTextField
Implements: ISerializable
Derived: RichTextField
Licensing Info
This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:
- An active DynamicPDF Ultimate Subscription
- An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
- A DynamicPDF Core Suite for .NET v12.X Developer License.
Examples
This example shows how to create an Text Field and Add it to the page.Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements.Forms
Imports ceTe.DynamicPDF.Text
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a PDF Page
Dim MyPage As Page = New Page(PageSize.Letter)
' Create an Text Field
Dim MyTextField As TextField = New TextField("txt", 50, 75, 150, 100)
MyTextField.TextAlign = Align.Center
MyTextField.BackgroundColor = RgbColor.AliceBlue
MyTextField.BorderColor = RgbColor.DeepPink
Dim MyFont As OpenTypeFont = new OpenTypeFont("fontname")
MyTextField.Font = MyFont
MyTextField.FontSize = 16.0f
MyTextField.TextColor = RgbColor.Brown
MyTextField.DefaultValue = "Hello World."
MyTextField.MultiLine = true
MyTextField.ToolTip = "Text"
' Add the Text Field to the page
MyPage.Elements.Add(MyTextField)
' Add pages to the document
MyDocument.Pages.Add(MyPage)
' Save the PDF document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
using ceTe.DynamicPDF.PageElements.Forms;
using ceTe.DynamicPDF.Text;
public class Example
{
public static void CreatePDF(string outputPath, string fontPath)
{
// Create a PDF Document
Document document = new Document();
//Set PDF version to 1.6
document.PdfVersion = PdfVersion.v1_6;
// Create a PDF Page
Page page = new Page(PageSize.Letter);
// Create an Text Field
TextField textField = new TextField("txt", 50, 75, 150, 100);
textField.TextAlign = Align.Center;
textField.BackgroundColor = RgbColor.AliceBlue;
textField.BorderColor = RgbColor.DeepPink;
OpenTypeFont myFont = new OpenTypeFont(fontPath);
textField.Font = myFont;
textField.FontSize = 16.0f;
textField.TextColor = RgbColor.Brown;
textField.DefaultValue = "Hello World.";
textField.MultiLine = true;
textField.ToolTip = "Text";
// Add the Text Field to the page
page.Elements.Add(textField);
// Add pages to the document
document.Pages.Add(page);
// Save the PDF document
document.Draw(outputPath);
}
}
Remarks
For more details on text fields take a look at the Interactive Forms topic.
Constructors
TextField(String, Single, Single, Single, Single) | Creates a new instance of TextField class. |
Properties
BackgroundColor | Gets or Sets the fill/background color of a form field. (Inherited from FormElement) |
BorderColor | Gets or Sets the border color of a form field. (Inherited from FormElement) |
BorderStyle | Gets or Sets the BorderStyle . (Inherited from FormElement) |
Comb | Gets or Sets the text field to be comb. |
DefaultValue | Gets or Sets the text field's default value. |
Font | Gets or Sets the font for the field. |
FontSize | Gets or Sets the font size for the field. |
Height | Gets or Sets the height of a form field. (Inherited from FormElement) |
ID | Gets or sets the ID of the page element. (Inherited from PageElement) |
IgnoreMargins | Gets or sets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property. (Inherited from PageElement) |
MappingName | Gets or Sets an mapping name, of a form field. (Inherited from FormElement) |
MaxLength | Gets or Sets the maximum length of characters in a text field. |
MultiLine | Gets or Sets the text field to contain multiple lines. If set, the field may contain multiple lines of text; if clear, the field?s text is restricted to a single line. |
Name | Gets or Sets the name of a form field. (Inherited from FormElement) |
NoExport | Gets or Sets the export state for the field. If set, the field will not be exported by a submit-form action. |
Output | Gets or sets output options for the field. (Inherited from FormElement) |
Password | Gets or Sets the text field intended for entering a secure password that should not be echoed visibly to the screen. |
Printable | Gets or Sets the form field printable on Pdf. By default its true. (Inherited from FormElement) |
ReaderEvents | Gets the reader events of the annotation. (Inherited from FormElement) |
ReadOnly | Gets or Sets the read only property status of the form field. (Inherited from FormElement) |
RelativeTo | Gets and sets placement of the page element on the page. (Inherited from PageElement) |
Required | Gets or Sets the required state for the field. If set, the field must have a value at the time it is exported by a submit-form action. |
Rotate | Gets or Sets the angle of a form field.
Rotation angle should be multiple of 90, default is 0. (Inherited from FormElement) |
Tag | Gets or sets the structure element of the form element. (Inherited from FormElement) |
TagOrder | Gets or sets the tag order of the taggable element. (Inherited from TaggablePageElement) |
TextAlign | Sets the text align. |
TextColor | Gets or Sets the color of the text for the field. (Inherited from FormElement) |
ToolTip | Gets or Sets an alternate field name, of a form field. (Inherited from FormElement) |
Visible | Gets or Sets the form field visible on Pdf. By default its true. (Inherited from FormElement) |
Width | Gets or Sets the width of a form field. (Inherited from FormElement) |
X | Gets or Sets the X coordinate of a form field. (Inherited from FormElement) |
Y | Gets or Sets the Y coordinate of a form field. (Inherited from FormElement) |
Methods
Draw(PageWriter) | Draws the text field to the given PageWriter object. |
Equals(Object) | Determines whether the specified Object is equal to the current Object . (Inherited from Object) |
GetHashCode() | Serves as a hash function for a particular type. (Inherited from Object) |
GetType() | Gets the Type of the current instance. (Inherited from Object) |
ToString() | Returns a String that represents the current Object . (Inherited from Object) |