menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfXfaTextBoxField - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PdfXfaTextBoxField

    Represents textbox field in the XFA form.

    Inheritance
    System.Object
    PdfXfaField
    PdfXfaStyledField
    PdfXfaTextBoxField
    Implements
    ICloneable
    Inherited Members
    PdfXfaField.Margins
    PdfXfaField.Name
    PdfXfaField.Visibility
    PdfXfaStyledField.Border
    PdfXfaStyledField.Font
    PdfXfaStyledField.ForeColor
    PdfXfaStyledField.Height
    PdfXfaStyledField.HorizontalAlignment
    PdfXfaStyledField.ReadOnly
    PdfXfaStyledField.Rotate
    PdfXfaStyledField.ToolTip
    PdfXfaStyledField.VerticalAlignment
    PdfXfaStyledField.Width
    Namespace: Syncfusion.Pdf.Xfa
    Assembly: Syncfusion.Pdf.UWP.dll
    Syntax
    public class PdfXfaTextBoxField : PdfXfaStyledField, ICloneable
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Constructors

    PdfXfaTextBoxField(String, SizeF)

    Initializes a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, SizeF minimumSize)
    Parameters
    Type Name Description
    System.String fieldName

    Name of the text box field.

    System.Drawing.SizeF minimumSize

    Minimum size of the text box field.

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, SizeF, PdfXfaTextBoxType)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, SizeF minimumSize, PdfXfaTextBoxType fieldType)
    Parameters
    Type Name Description
    System.String fieldName

    Name of the text box field

    System.Drawing.SizeF minimumSize

    Minimum size of the text box

    PdfXfaTextBoxType fieldType

    Text box field type

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20), PdfXfaTextBoxType.SingleLine);
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20), PdfXfaTextBoxType.SingleLine)
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, SizeF, String)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, SizeF minimumSize, string defaultText)
    Parameters
    Type Name Description
    System.String fieldName

    Name of the text box field

    System.Drawing.SizeF minimumSize

    Minimum size of the text box

    System.String defaultText

    Default value of the text box

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20), "John");
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20), "John")
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, SizeF, String, PdfXfaTextBoxType)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, SizeF minimumSize, string defaultText, PdfXfaTextBoxType fieldType)
    Parameters
    Type Name Description
    System.String fieldName

    Name of the text box field

    System.Drawing.SizeF minimumSize

    Minimum size of the text box

    System.String defaultText

    Default value of the text box

    PdfXfaTextBoxType fieldType

    Text box field type

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20), "John", PdfXfaTextBoxType.SingleLine);
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20), "John", PdfXfaTextBoxType.SingleLine)
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, Single, Single)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, float minWidth, float minHeight)
    Parameters
    Type Name Description
    System.String fieldName

    Name of the text box field

    System.Single minWidth

    Minimum width of the text box field.

    System.Single minHeight

    Minimum height of the text box field.

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", 200, 20);
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", 200,20)
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, Single, Single, PdfXfaTextBoxType)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, float minWidth, float minHeight, PdfXfaTextBoxType fieldType)
    Parameters
    Type Name Description
    System.String fieldName
    System.Single minWidth

    Minimum width of the text box field.

    System.Single minHeight

    Minimum height of the text box field.

    PdfXfaTextBoxType fieldType

    ext box field type

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", 200, 20, PdfXfaTextBoxType.SingleLine);
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", 200, 20, PdfXfaTextBoxType.SingleLine)
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, Single, Single, String)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, float minWidth, float minHeight, string defaultText)
    Parameters
    Type Name Description
    System.String fieldName
    System.Single minWidth

    Minimum width of the text box field.

    System.Single minHeight

    Minimum height of the text box field.

    System.String defaultText

    Default value of the text box

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", 200, 20, "John");
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", 200, 20, "John")
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PdfXfaTextBoxField(String, Single, Single, String, PdfXfaTextBoxType)

    Initialize a new instance of the PdfXfaTextBoxField class.

    Declaration
    public PdfXfaTextBoxField(string fieldName, float minWidth, float minHeight, string defaultText, PdfXfaTextBoxType fieldType)
    Parameters
    Type Name Description
    System.String fieldName
    System.Single minWidth

    Minimum width of the text box field.

    System.Single minHeight

    Minimum height of the text box field.

    System.String defaultText

    Default value of the text box

    PdfXfaTextBoxType fieldType

    Text box field type

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", 200, 20, "John", PdfXfaTextBoxType.SingleLine);
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", 200, 20, "John", PdfXfaTextBoxType.SingleLine)
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Properties

    Caption

    Gets or sets the caption of the field

    Declaration
    public PdfXfaCaption Caption { get; set; }
    Property Value
    Type
    PdfXfaCaption
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    CombLength

    Gets or sets the comb cell

    Declaration
    public int CombLength { get; set; }
    Property Value
    Type
    System.Int32
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    textBoxField.Type = PdfXfaTextBoxType.Comb;
    textBoxField.CombLength = 5;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    textBoxField.Type = PdfXfaTextBoxType.Comb
    //Set comb length.
    textBoxField.CombLength = 5
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    MaximumHeight

    Gets or sets maximum height of the text box field

    Declaration
    public float MaximumHeight { get; set; }
    Property Value
    Type
    System.Single
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set maxium height.
    textBoxField.MaximumHeight = 30;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set maximum height.
    textBoxField.MaximumHeight = 30;
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    MaximumLength

    Gets or sets the character limit

    Declaration
    public int MaximumLength { get; set; }
    Property Value
    Type
    System.Int32
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set maxium length.
    textBoxField.MaximumLength = 10;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set maximum length.
    textBoxField.MaximumLength = 10
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    MaximumWidth

    Gets or sets maximum width of the text box field

    Declaration
    public float MaximumWidth { get; set; }
    Property Value
    Type
    System.Single
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set maximum width.
    textBoxField.MaximumWidth = 300;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set maximum width.
    textBoxField.MaximumWidth = 300;
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    MinimumHeight

    Gets or sets minimum height of the text box, this will be expandable

    Declaration
    public float MinimumHeight { get; set; }
    Property Value
    Type
    System.Single
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set minimum height.
    textBoxField.MinimumHeight = 30;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set minimum height.
    textBoxField.MinimumHeight = 30;
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    MinimumWidth

    Gets or sets the minimum width of the text box, this will be expandable

    Declaration
    public float MinimumWidth { get; set; }
    Property Value
    Type
    System.Single
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set minimum width.
    textBoxField.MinumWidth = 220;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set minum width.
    textBoxField.MinimumWidth = 220
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Padding

    Gets or sets the padding

    Declaration
    public PdfPaddings Padding { get; set; }
    Property Value
    Type
    PdfPaddings
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set padding.
    textBoxField.Padding.All = 2;
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set padding.
    textBoxField.Padding.All = 2
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    PasswordCharacter

    Gets or sets the password character

    Declaration
    public char PasswordCharacter { get; set; }
    Property Value
    Type
    System.Char
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    textBoxField.Type = PdfXfaTextBoxType.Password;
    //Set password character.
    textBoxField.PasswordCharacter = "*";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    textBoxField.Type = PdfXfaTextBoxField.Password
    //Set password character.
    textBoxField.PasswordCharacter = "*"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Text

    Gets or sets the value of the text box field

    Declaration
    public string Text { get; set; }
    Property Value
    Type
    System.String
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Set text.
    textBoxField.Text = "John";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Set text.
    textBoxField.Text = "John"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Type

    Gets or sets the field type of the text box

    Declaration
    public PdfXfaTextBoxType Type { get; set; }
    Property Value
    Type
    PdfXfaTextBoxType
    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("Address", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "Address";
    //Set the text box type.
    textBoxField.Type = PdfXfaTextBoxType.Multiline;
    //Set the tool tip.
    textBoxField.ToolTip = "Address";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("Address", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "Address"
    'Set the text box type.
    textBoxField.Type = PdfXfaTextBoxType.Multiline
    'Set the tool tip.
    textBoxField.ToolTip = "Address"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Methods

    Clone()

    Creates a new object that is a copy of the current instance.

    Declaration
    public object Clone()
    Returns
    Type Description
    System.Object

    The copy of the new object for this instance.

    Examples
    //Create a new PDF XFA document.
    PdfXfaDocument document = new PdfXfaDocument();
    //Add a new XFA page.
    PdfXfaPage xfaPage = document.Pages.Add();
    //Create a new PDF XFA form
    PdfXfaForm mainForm = new PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width);
    //Create a textbox field and add the properties.
    PdfXfaTextBoxField textBoxField = new PdfXfaTextBoxField("FirstName", new SizeF(200, 20));
    //Set the caption text.
    textBoxField.Caption.Text = "First Name";
    //Set the tool tip.
    textBoxField.ToolTip = "First Name";
    //Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField);
    //Clone the text box field.
    mainForm.Fields.Add(textBoxField.Clone() as PdfXfaTextBoxField);
    //Add the XFA form to the document.
    document.XfaForm = mainForm;
    //Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic);
    //close the document
    document.Close();
    'Create a new PDF XFA document.
    Dim document As New PdfXfaDocument()
    'Add a new XFA page.
    Dim xfaPage As PdfXfaPage = document.Pages.Add()
    'Create a new PDF XFA form
    Dim mainForm As New PdfXfaForm("subform1", xfaPage, xfaPage.GetClientSize().Width)
    'Create a textbox field and add the properties.
    Dim textBoxField As New PdfXfaTextBoxField("FirstName", New SizeF(200,20))
    'Set the caption text.
    textBoxField.Caption.Text = "First Name"
    'Set the tool tip.
    textBoxField.ToolTip = "First Name"
    'Add the field to the XFA form.
    mainForm.Fields.Add(textBoxField)
    'Clone the text box field.
    mainForm.Fields.Add(TryCast(textBoxField.Clone(), PdfXfaTextBoxField)
    'Add the XFA form to the document.
    document.XfaForm = mainForm
    'Save the document.
    document.Save("XfaForm.pdf",PdfXfaType.Dynamic)
    'close the document
    document.Close()

    Implements

    ICloneable

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved