Class PdfTextBoxField

Represents text box field in the PDF form.

Inheritance

System.Object

PdfField

PdfStyledField

PdfAppearanceField

PdfTextBoxField

Implements

System.ComponentModel.INotifyPropertyChanged

Inherited Members

PdfAppearanceField.Appearance

PdfField.DisableAutoFormat

PdfField.Export

PdfField.Flatten

PdfField.Form

PdfField.GetValue(String)

PdfField.Layer

PdfField.MappingName

PdfField.Name

PdfField.Page

PdfField.PdfTag

PdfField.PropertyChanged

PdfField.ReadOnly

PdfField.Required

PdfField.SetValue(String, String)

PdfField.TabIndex

PdfField.ToolTip

PdfStyledField.Actions

PdfStyledField.BackColor

PdfStyledField.BorderColor

PdfStyledField.BorderStyle

PdfStyledField.BorderWidth

PdfStyledField.Bounds

PdfStyledField.DefineDefaultAppearance()

PdfStyledField.Font

PdfStyledField.ForeColor

PdfStyledField.HighlightMode

PdfStyledField.Location

PdfStyledField.ObtainFont()

PdfStyledField.RotationAngle

PdfStyledField.Size

PdfStyledField.TextAlignment

PdfStyledField.Visibility

PdfStyledField.Visible

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Pdf.Interactive

Assembly: Syncfusion.Pdf.Base.dll

Syntax

public class PdfTextBoxField : PdfAppearanceField, IPdfWrapper, INotifyPropertyChanged

Remarks

This PdfTextBoxField class is used to create the text box field in PDF forms. Please refer the UG docuemntation link https://help.syncfusion.com/file-formats/pdf/working-with-forms#adding-the-text-box-field for more details.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");  
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")   
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

Constructors

PdfTextBoxField(PdfPageBase, String)

Initializes a new instance of the PdfTextBoxField class with the provided page and name.

Declaration

public PdfTextBoxField(PdfPageBase page, string name)

Parameters

Type	Name	Description
PdfPageBase	page	Page which the field to be placed on.
System.String	name	The name of the text box field.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");  
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")   
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")

See Also

PdfDocument

PdfPage

PdfFont

Properties

AutoResizeText

Gets or sets a value indicating whether this is AutoResizeText.

Declaration

public bool AutoResizeText { get; set; }

Property Value

Type	Description
System.Boolean	true if AutoResizeText field; otherwise, false.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();      
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
//Create a text box
PdfTextBoxField textBoxField = new PdfTextBoxField(page, "firstNameTextBox");
textBoxField.AutoResizeText = true;
textBoxField.Flatten = false;
//Set text.
textBoxField.Text = "Syncfusion provides the best third-party UI components for WinForms, WPF, ASP.NET Web Forms, MVC, Core, UWP, WinUI (Preview), Xamarin, JavaScript";
textBoxField.Bounds = new RectangleF(0, 0, 300, 20);
textBoxField.ToolTip = "Company Products";
//Add the textbox in document
document.Form.Fields.Add(textBoxField);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
'Create a text box
Dim firstNameTextBox As textBoxField = New PdfTextBoxField(page, "firstNameTextBox")
textBoxField.AutoResizeText = true
textBoxField.Flatten = false
//Set text.
textBoxField.Text = "Syncfusion provides the best third-party UI components for WinForms, WPF, ASP.NET Web Forms, MVC, Core, UWP, WinUI (Preview), Xamarin, JavaScript"
textBoxField.Bounds = New RectangleF(100, 20, 200, 20)
textBoxField.ToolTip = "Company Products"
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

ComplexScript

Gets or sets the complex script language support.

Declaration

public bool ComplexScript { get; set; }

Property Value

Type
System.Boolean

Examples

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a new PDF page.
PdfPage page = document.Pages.Add();
//Create font.
Font font = new Font("Tahoma", 10f);
//Create a new PDF font instance.
PdfFont pdfFont = new PdfTrueTypeFont(font, FontStyle.Regular, 10f, true, true);
//Create a new text box field.
PdfTextBoxField textBox = new PdfTextBoxField(page, "textBox");
//Set bounds
textBox.Bounds = new RectangleF(0, 0, 300, 20);
//Set font.
textBox.Font = pdfFont;
//Set text.
textBox.Text = "สวัสดีชาวโลก";
//Enable complex script.
textBox.ComplexScript = true;
//Add field to form.
document.Form.Fields.Add(textBox);
document.Form.SetDefaultAppearance(false)
//Save the document.
document.Save("output.pdf");
//Close the document.
document.Close(true);

'Create a new PDF document.
Dim document As New PdfDocument()
'Add a new PDF page.
Dim page As PdfPage = document.Pages.Add()
'Create font.
Dim font As New Font("Tahoma", 10F)
'Create a new PDF font instance.
Dim pdfFont As PdfFont = New PdfTrueTypeFont(font, FontStyle.Regular, 10F, True, True)
'Create a new text box field.
Dim textBox As New PdfTextBoxField(page, "textBox")
'Set bounds
textBox.Bounds = New RectangleF(0, 0, 300, 20)
'Set font.
textBox.Font = pdfFont
'Set text.
textBox.Text = "สวัสดีชาวโลก"
'Enable complex script.
textBox.ComplexScript = True
'Add field to form.
document.Form.Fields.Add(textBox)
document.Form.SetDefaultAppearance(False)
'Save the document.
document.Save("output.pdf")
'Close the document.
document.Close(True)

DefaultValue

Gets or sets the default value.

Declaration

public string DefaultValue { get; set; }

Property Value

Type	Description
System.String	The default value of the text box field.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.DefaultValue = "Cris";
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.DefaultValue = "Cris"
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

InsertSpaces

Meaningful only if the MaxLength property is set and the Multiline, Password properties are false. If set, the field is automatically divided into as many equally spaced positions, or combs, as the value of MaxLength, and the text is laid out into those combs.

Declaration

public bool InsertSpaces { get; set; }

Property Value

Type	Description
System.Boolean	true if need to insert spaces; otherwise, false.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.InsertSpaces = true;
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.InsertSpaces = True
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

MaxLength

Gets or sets the maximum number of characters that can be entered in the text box.

Declaration

public int MaxLength { get; set; }

Property Value

Type	Description
System.Int32	An integer value specifying the maximum number of characters that can be entered in the text box.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.MaxLength = 8;
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.MaxLength = 8
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

Multiline

Gets or sets a value indicating whether this PdfTextBoxField is multiline.

Declaration

public bool Multiline { get; set; }

Property Value

Type	Description
System.Boolean	true if multiline; otherwise, false.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.Multiline = true;
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.Multiline = True
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

Password

Gets or sets a value indicating whether this PdfTextBoxField is password field.

Declaration

public bool Password { get; set; }

Property Value

Type	Description
System.Boolean	true if password field; otherwise, false.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.Password = true;
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.Password = True
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

Scrollable

Gets or sets a value indicating whether this PdfTextBoxField is scrollable.

Declaration

public bool Scrollable { get; set; }

Property Value

Type	Description
System.Boolean	true if scrollable; otherwise, false.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.Scrollable = true;
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.Scrollable = True
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

SpellCheck

Gets or sets a value indicating whether to check spelling.

Declaration

public bool SpellCheck { get; set; }

Property Value

Type	Description
System.Boolean	true if check spelling; otherwise, false.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.SpellCheck = true;
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.SpellCheck = True
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

Text

Gets or sets the text in the text box.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The text of the text box field.

Examples

//Create a new PDf document
PdfDocument document = new PdfDocument();           
//Creates a new page and adds it as the last page of the document
PdfPage page = document.Pages.Add();
PdfFont font = new PdfStandardFont(PdfFontFamily.Courier, 12f);
//Create a text box
PdfTextBoxField firstNameTextBox = new PdfTextBoxField(page, "firstNameTextBox");
firstNameTextBox.Text = "Cris";
firstNameTextBox.Bounds = new RectangleF(100, 20, 200, 20);
firstNameTextBox.Font = font;
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55);
//Add the textbox in document
document.Form.Fields.Add(firstNameTextBox);                      
document.Save("Form.pdf");
document.Close(true);

'Create a new PDf document
Dim document As PdfDocument = New PdfDocument()
'Create a page
Dim page As PdfPage = document.Pages.Add()
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Courier, 12f)
'Create a text box
Dim firstNameTextBox As PdfTextBoxField = New PdfTextBoxField(page, "firstNameTextBox")
firstNameTextBox.Text = "Cris"
firstNameTextBox.Bounds = New RectangleF(100, 20, 200, 20)
firstNameTextBox.Font = font
page.Graphics.DrawString("First Name", font, PdfBrushes.Black, 10, 55)
'Add the textbox in document
document.Form.Fields.Add(firstNameTextBox)
document.Save("Form.pdf")
document.Close(True)

See Also

PdfDocument

PdfPage

PdfFont

Methods

DrawAppearance(PdfTemplate)

Draws the appearance.

Declaration

protected override void DrawAppearance(PdfTemplate template)

Parameters

Type	Name	Description
PdfTemplate	template	The template.

Overrides

PdfAppearanceField.DrawAppearance(PdfTemplate)

Initialize()

Initializes an instance.

Declaration

protected override void Initialize()

Overrides

PdfStyledField.Initialize()

Implements

System.ComponentModel.INotifyPropertyChanged

See Also

PdfAppearanceField

PdfDocument

PdfPage

PdfFont