FindField Method

In This Topic

Finds a field by specified fully qualified field name.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function FindField( _
   ByVal fullyQualifiedFieldName As String _
) As PdfInteractiveFormField

public PdfInteractiveFormField FindField( 
   string fullyQualifiedFieldName
)

public: PdfInteractiveFormField* FindField( 
   string* fullyQualifiedFieldName
)

public:
PdfInteractiveFormField^ FindField( 
   String^ fullyQualifiedFieldName
)

Parameters

fullyQualifiedFieldName: The fully qualified field name.

Return Value

An PdfInteractiveFormField object instance if field is found; otherwise, null.

Example

Here is an example that shows how to find a field with the specified name and change the field value:

VB.NET

''' <summary>
''' Changes the text field value.
''' </summary>
''' <param name="document">The PDF document.</param>
''' <param name="fieldFullName">Full name of the field.</param>
''' <param name="newValue">The new value of the field.</param>
''' <returns>
''' <b>true</b> - field value is changed successfully;
''' <b>false</b> - field value is NOT changed.
''' </returns>
Public Shared Function ChangeTextFieldValue(document As Vintasoft.Imaging.Pdf.PdfDocument, fieldFullName As String, newValue As String) As Boolean
    ' if PDF document has PDF interactive form
    If document.InteractiveForm IsNot Nothing Then
        ' find field by name
        Dim field As Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormField = document.InteractiveForm.FindField(fieldFullName)
        ' if field is found
        If field IsNot Nothing Then
            Dim textField As Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormTextField = TryCast(field, Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormTextField)
            ' if field is text field
            If textField IsNot Nothing Then
                ' set new value of the field
                textField.Value = New Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormTextFieldStringValue(document, newValue)
            
                Return True
            End If
        End If
    End If
    Return False
End Function

/// <summary>
/// Changes the text field value.
/// </summary>
/// <param name="document">The PDF document.</param>
/// <param name="fieldFullName">Full name of the field.</param>
/// <param name="newValue">The new value of the field.</param>
/// <returns>
/// <b>true</b> - field value is changed successfully;
/// <b>false</b> - field value is NOT changed.
/// </returns>
public static bool ChangeTextFieldValue(
    Vintasoft.Imaging.Pdf.PdfDocument document,
    string fieldFullName,
    string newValue)
{
    // if PDF document has PDF interactive form
    if (document.InteractiveForm != null)
    {
        // find field by name
        Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormField field = 
            document.InteractiveForm.FindField(fieldFullName);
        // if field is found
        if (field != null)
        {
            Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormTextField textField = 
                field as Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormTextField;
            // if field is text field
            if (textField != null)
            {
                // set new value of the field
                textField.Value = 
                    new Vintasoft.Imaging.Pdf.Tree.InteractiveForms.PdfInteractiveFormTextFieldStringValue(document, newValue);
            
                return true;
            }
        }
    }
    return false;
}

Requirements

Target Platforms: .NET 6; .NET 5; .NET Core 3.1; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

PdfDocumentInteractiveForm Class
PdfDocumentInteractiveForm Members
FullyQualifiedName Property

Send Feedback