officefileapi-devexpress-dot-pdf-dot-pdfdocumentfacade.md
Obtains a set of methods used to organize interactive forms.
Namespace : DevExpress.Pdf
Assembly : DevExpress.Pdf.v25.2.Core.dll
NuGet Package : DevExpress.Pdf.Core
public PdfAcroFormFacade AcroForm { get; }
Public ReadOnly Property AcroForm As PdfAcroFormFacade
| Type | Description |
|---|---|
| PdfAcroFormFacade |
An object that exposes methods used to organize AcroForms.
|
Utilize one of the following methods to get form field properties:
| Method | Description |
|---|---|
| PdfAcroFormFacade.GetFields() | Retrieves all AcroForm fields. |
| GetFormField() | Obtains properties of a field with a specific name. |
| GetButtonFormField() | |
| GetCheckBoxFormField() | |
| GetComboBoxFormField() | |
| and so on | Returns properties of a specific form field type. |
Call the PdfAcroFormFacade.GetNames() method to get a list of form field names.
The code sample below retrieves all fields and changes their appearance:
using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf");
PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
PdfAcroFormFacade acroForm = documentFacade.AcroForm;
//Change all form fields' color settings:
var fields = acroForm.GetFields();
foreach (PdfFormFieldFacade field in fields)
{
ChangeFormFieldColor(field);
}
pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf");
}
private static void ChangeFormFieldColor(PdfFormFieldFacade field)
{
foreach (PdfWidgetFacade pdfWidget in field)
{
//Change color and border settings
//for all form fields:
pdfWidget.BorderWidth = 1;
pdfWidget.BackgroundColor = new PdfRGBColor(0.81, 0.81, 0.81);
pdfWidget.BorderColor = new PdfRGBColor(0.47, 0.44, 0.67);
pdfWidget.FontColor = new PdfRGBColor(0.34, 0.25, 0.36);
//Change border style for text form fields:
if (field.Type == PdfFormFieldType.Text)
{
pdfWidget.BorderStyle = PdfBorderStyle.Underline;
}
}
}
Using pdfDocumentProcessor As New PdfDocumentProcessor()
pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf")
Dim documentFacade As PdfDocumentFacade = pdfDocumentProcessor.DocumentFacade
Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm
'Change all form fields' color settings:
Dim fields = acroForm.GetFields()
For Each field As PdfFormFieldFacade In fields
ChangeFormFieldColor(field)
Next field
pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf")
End Using
private static void ChangeFormFieldColor(PdfFormFieldFacade field)
For Each pdfWidget As PdfWidgetFacade In field
'Change color and border settings
'for all form fields:
pdfWidget.BorderWidth = 1
pdfWidget.BackgroundColor = New PdfRGBColor(0.81, 0.81, 0.81)
pdfWidget.BorderColor = New PdfRGBColor(0.47, 0.44, 0.67)
pdfWidget.FontColor = New PdfRGBColor(0.34, 0.25, 0.36)
'Change border style for text form fields:
If field.Type = PdfFormFieldType.Text Then
pdfWidget.BorderStyle = PdfBorderStyle.Underline
End If
Next pdfWidget
The following code snippets (auto-collected from DevExpress Examples) contain references to the AcroForm 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-get-checked-appearance-name-for-check-box/CS/GetCheckboxCheckedValue/Program.cs#L16
PdfDocumentFacade documentFacade = processor.DocumentFacade;
PdfAcroFormFacade acroForm = documentFacade.AcroForm;
pdf-document-api-get-checked-appearance-name-for-radio-button/CS/Program.cs#L17
PdfDocumentFacade documentFacade = processor.DocumentFacade;
PdfAcroFormFacade acroFormFacade = documentFacade.AcroForm;
pdf-document-api-replace-form-field-with-image/CS/ReplaceFormFieldWithImage/Program.cs#L17
PdfDocumentFacade documentFacade = processor.DocumentFacade;
PdfAcroFormFacade acroForm = documentFacade.AcroForm;
string fieldName = "Address";
pdf-document-api-fill-interactive-form-fields/CS/PdfFormFilling/PdfFormFilling.cs#L51
PdfDocumentFacade documentFacade = documentProcessor.DocumentFacade;
PdfAcroFormFacade acroForm = documentFacade.AcroForm;
pdf-document-api-get-checked-appearance-name-for-check-box/VB/GetCheckboxCheckedValue/Program.vb#L12
Dim documentFacade As PdfDocumentFacade = processor.DocumentFacade
Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm
' Obtain the check box form field:
pdf-document-api-get-checked-appearance-name-for-radio-button/VB/Program.vb#L13
Dim documentFacade As PdfDocumentFacade = processor.DocumentFacade
Dim acroFormFacade As PdfAcroFormFacade = documentFacade.AcroForm
' Specify a checked appearance name for the Female radio button:
pdf-document-api-replace-form-field-with-image/VB/ReplaceFormFieldWithImage/Program.vb#L17
Dim documentFacade As PdfDocumentFacade = processor.DocumentFacade
Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm
Dim fieldName As String = "Address"
pdf-document-api-fill-interactive-form-fields/VB/PdfFormFilling/PdfFormFilling.vb#L45
Dim documentFacade As PdfDocumentFacade = documentProcessor.DocumentFacade
Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm
See Also