SetFormFieldVisibility Method (GdPicturePDF)

In This Topic

Sets the specified visibility, either on screen or in print, of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

Syntax

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

'Declaration
 
Public Function SetFormFieldVisibility( _
   ByVal FieldId As Integer, _
   ByVal Visibility As PdfFormFieldVisibility _
) As GdPictureStatus

public GdPictureStatus SetFormFieldVisibility( 
   int FieldId,
   PdfFormFieldVisibility Visibility
)

public function SetFormFieldVisibility( 
    FieldId: Integer;
    Visibility: PdfFormFieldVisibility
): GdPictureStatus;

public function SetFormFieldVisibility( 
   FieldId : int,
   Visibility : PdfFormFieldVisibility
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldVisibility( 
   int FieldId,
   PdfFormFieldVisibility Visibility
)

public:
GdPictureStatus SetFormFieldVisibility( 
   int FieldId,
   PdfFormFieldVisibility Visibility
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GetFormFieldId, GetFormFieldChildID or methods intended to add form fields.
Visibility: A member of the PdfFormFieldVisibility enumeration. A new value of the visibility flag for the specified form field to be set.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method is only allowed for use with non-encrypted documents.

Example

How to set all currently hidden form fields to become visible.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldVisibility"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If gdpicturePDF.LoadFromFile("forms.pdf", False) = GdPictureStatus.OK Then
    Dim count As Integer = gdpicturePDF.GetFormFieldsCount()
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim formID As Integer = 0
        Dim visible As PdfFormFieldVisibility = PdfFormFieldVisibility.PdfFormFieldVisible
        For i As Integer = 0 To count - 1
            formID = gdpicturePDF.GetFormFieldId(i)
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                visible = gdpicturePDF.GetFormFieldVisibility(formID)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    If visible = PdfFormFieldVisibility.PdfFormFieldHidden Then
                        If gdpicturePDF.SetFormFieldVisibility(formID, PdfFormFieldVisibility.PdfFormFieldVisible) <> GdPictureStatus.OK Then
                            MessageBox.Show("The SetFormFieldVisibility() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                            Exit For
                        End If
                    End If
                Else
                    MessageBox.Show("The GetFormFieldVisibility() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    Exit For
                End If
            Else
                MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                Exit For
            End If
        Next
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            If (count = 0) Then
                MessageBox.Show("This file doesn't include forms.", caption)
            Else
                If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then
                    MessageBox.Show("The example has been followed successfully and the file has been saved.", caption)
                Else
                    MessageBox.Show("The file can't be saved.", caption)
                End If
            End If
        End If
    Else
        MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: SetFormFieldVisibility";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetFormFieldsCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        int formID = 0;
        PdfFormFieldVisibility visible = PdfFormFieldVisibility.PdfFormFieldVisible;
        for (int i = 0; i < count; i++)
        {
            formID = gdpicturePDF.GetFormFieldId(i);
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                visible = gdpicturePDF.GetFormFieldVisibility(formID);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    if (visible == PdfFormFieldVisibility.PdfFormFieldHidden)
                    {
                        if (gdpicturePDF.SetFormFieldVisibility(formID, PdfFormFieldVisibility.PdfFormFieldVisible) != GdPictureStatus.OK)
                        {
                            MessageBox.Show("The SetFormFieldVisibility() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                            break;
                        }
                    }
                }
                else
                {
                    MessageBox.Show("The GetFormFieldVisibility() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                    break;
                }
            }
            else
            {
                MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                break;
            }
        }
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            if (count == 0)
                MessageBox.Show("This file doesn't include forms.", caption);
            else
            {
                if (gdpicturePDF.SaveToFile("forms_updated.pdf") == GdPictureStatus.OK)
                    MessageBox.Show("The example has been followed successfully and the file has been saved.", caption);
                else
                    MessageBox.Show("The file can't be saved.", caption);
            }
        }
    }
    else
        MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
    MessageBox.Show("The file can't be loaded.", caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetFormFieldVisibility Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method