Back to Devexpress

PdfGraphicsAcroFormCommonField.TextAlignment Property

officefileapi-devexpress-dot-pdf-dot-pdfgraphicsacroformcommonfield.md

latest5.1 KB
Original Source

PdfGraphicsAcroFormCommonField.TextAlignment Property

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

Namespace : DevExpress.Pdf

Assembly : DevExpress.Pdf.v25.2.Drawing.dll

NuGet Package : DevExpress.Pdf.Drawing

Declaration

csharp
public PdfAcroFormStringAlignment TextAlignment { get; set; }
vb
Public Property TextAlignment As PdfAcroFormStringAlignment

Property Value

TypeDescription
PdfAcroFormStringAlignment

An enumeration value that indicates the text alignment type.

|

Available values:

NameDescription
Near

Text is aligned near to the origin position of a field rectangle.

| | Center |

Text is aligned in the center of a field rectangle.

| | Far |

Text is aligned far from the origin position of a field rectangle.

|

Example

This example uses PDF Graphics API to create a text box field and add it to a new page.

csharp
using DevExpress.Pdf;
using System.Drawing;
//...
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.CreateGraphicsPageSystem())
        {
            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.
    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);
}
vb
Imports DevExpress.Pdf
Imports System.Drawing
'...

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.CreateGraphicsPageSystem()
            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.
    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

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

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

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

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

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

See Also

PdfGraphicsAcroFormCommonField Class

PdfGraphicsAcroFormCommonField Members

DevExpress.Pdf Namespace