PdfGraphicsAcroFormCommonField.TextAlignment Property

Specifies the horizontal alignment of the interactive form field’s text.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v19.1.Drawing.dll

Declaration

C#

public PdfAcroFormStringAlignment TextAlignment { get; set; }

VB.NET

Public Property TextAlignment As PdfAcroFormStringAlignment

Property Value

Type	Description
PdfAcroFormStringAlignment	A PdfAcroFormStringAlignment enumeration value that specifies how the text is horizontally aligned within the interactive form field.

Available values:

Name	Description
Near	Specifies that text is aligned near to the origin position of the field rectangle.
Center	Specifies that text is aligned in the center of the field rectangle.
Far	Specifies that text is aligned far from the origin position of the field rectangle.

Example

This example shows how to create a text box field and add it to a document.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-a-text-box-field-to-a-document-t494157

Program.cs

using DevExpress.Pdf;
using System.Drawing;

namespace AddTextBoxField {
    class Program {
        static void Main(string[] args) {
            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {

                // Create an empty document. 
                processor.CreateEmptyDocument("..\\..\\Result.pdf");

                // Create and draw a text box field.
                using (PdfGraphics graphics = processor.CreateGraphics()) {
                    DrawTextBoxField(graphics);

                    // Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics);
                }
            }
        }

        static void DrawTextBoxField(PdfGraphics graphics) {

            // Create a text box field and specify its location on the page using a RectangleF object.
            PdfGraphicsAcroFormTextBoxField textBox = new PdfGraphicsAcroFormTextBoxField("text box", new RectangleF(0, 10, 200, 30));

            // Specify text box properties.
            textBox.Text = "Text Box";           
            textBox.TextAlignment = PdfAcroFormStringAlignment.Near;
            textBox.Appearance.FontSize = 12;
            textBox.Appearance.BackgroundColor = Color.AliceBlue;          

            // Add the field to graphics.
            graphics.AddFormField(textBox);
        }
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing

Namespace AddTextBoxField
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Using processor As New PdfDocumentProcessor()

                ' Create an empty document. 
                processor.CreateEmptyDocument("..\..\Result.pdf")

                ' Create and draw a text box field.
                Using graphics As PdfGraphics = processor.CreateGraphics()
                    DrawTextBoxField(graphics)

                    ' Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics)
                End Using
            End Using
        End Sub

        Private Shared Sub DrawTextBoxField(ByVal graphics As PdfGraphics)

            ' Create a text box field and specify its location on the page using a RectangleF object.
            Dim textBox As New PdfGraphicsAcroFormTextBoxField("text box", New RectangleF(0, 10, 200, 30))

            ' Specify text box properties.
            textBox.Text = "Text Box"
            textBox.TextAlignment = PdfAcroFormStringAlignment.Near
            textBox.Appearance.FontSize = 12
            textBox.Appearance.BackgroundColor = Color.AliceBlue

            ' Add the field to graphics.
            graphics.AddFormField(textBox)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TextAlignment property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-create-combo-box-field/CS/AddComboBoxField/Program.cs#L36

comboBox.SelectValue("Red");
comboBox.TextAlignment = PdfAcroFormStringAlignment.Far;
comboBox.Appearance.BackgroundColor = Color.Beige;

pdf-document-api-create-list-box-field/CS/AddListBoxField/Program.cs#L36

listBox.Appearance.BackgroundColor = Color.Aqua;
listBox.TextAlignment = PdfAcroFormStringAlignment.Far;
listBox.SelectValue("Blue");

pdf-document-api-create-text-box-field/CS/AddTextBoxField/Program.cs#L29

textBox.Text = "Text Box";
textBox.TextAlignment = PdfAcroFormStringAlignment.Near;
textBox.Appearance.FontSize = 12;

VB.NET

pdf-document-api-create-combo-box-field/VB/AddComboBoxField/Program.vb#L31

comboBox.SelectValue("Red")
comboBox.TextAlignment = PdfAcroFormStringAlignment.Far
comboBox.Appearance.BackgroundColor = Color.Beige

pdf-document-api-create-list-box-field/VB/AddListBoxField/Program.vb#L31

listBox.Appearance.BackgroundColor = Color.Aqua
listBox.TextAlignment = PdfAcroFormStringAlignment.Far
listBox.SelectValue("Blue")

pdf-document-api-create-text-box-field/VB/AddTextBoxField/Program.vb#L26

textBox.Text = "Text Box"
textBox.TextAlignment = PdfAcroFormStringAlignment.Near
textBox.Appearance.FontSize = 12