SetFormFieldFontResName Method (GdPicturePDF)

In This Topic

Sets the resource name of the font used to display text in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The usage of this attribute is not restricted to any form fields, even if the form field's appearance doesn't display text. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".

Syntax

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

'Declaration
 
Public Function SetFormFieldFontResName( _
   ByVal FieldId As Integer, _
   ByVal FontResName As String _
) As GdPictureStatus

public GdPictureStatus SetFormFieldFontResName( 
   int FieldId,
   string FontResName
)

public function SetFormFieldFontResName( 
    FieldId: Integer;
    FontResName: String
): GdPictureStatus;

public function SetFormFieldFontResName( 
   FieldId : int,
   FontResName : String
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldFontResName( 
   int FieldId,
   string* FontResName
)

public:
GdPictureStatus SetFormFieldFontResName( 
   int FieldId,
   String^ FontResName
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GdPicturePDF.GetFormFieldId, GdPicturePDF.GetFormFieldChildID or methods intended to add form fields.
FontResName: The new resource name of the font you prefer for displaying text in the form field. You can obtain this name using the GdPicturePDF.AddStandardFont method or any of the AddTrueTypeFont...() methods. For further assistance, please see the Fonts section of the GdPicturePDF class in the Reference Guide.

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.

Just to inform you, that the attributes representing the font and its resources are defined for all form field objects by default, even if the form field's appearance doesn't display text. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".

Example

How to change the font and its size, which is used to display the push button's caption for all push buttons in the current document.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldFontResName"
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
        If count = 0 Then
            MessageBox.Show("This file doesn't include forms.", caption)
            GoTo finish
        End If
        Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontCourierBold)
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            Dim formID As Integer = 0
            Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
            Dim found As Boolean = False
            For i As Integer = 0 To count - 1
                formID = gdpicturePDF.GetFormFieldId(i)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    type = gdpicturePDF.GetFormFieldType(formID)
                    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                        If type = PdfFormFieldType.PdfFormFieldTypePushButton Then
                            If (gdpicturePDF.SetFormFieldFontResName(formID, fontResName) = GdPictureStatus.OK) AndAlso
                            (gdpicturePDF.SetFormFieldFontSize(formID, 24) = GdPictureStatus.OK) Then
                                found = True
                            Else
                                MessageBox.Show("The SetFormFieldFontResName() method or the SetFormFieldFontSize() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                                Exit For
                            End If
                        End If
                    Else
                        MessageBox.Show("The GetFormFieldType() 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 found Then
                    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 example has been followed successfully, but the file can't be saved.", caption)
                    End If
                Else
                    MessageBox.Show("This file doesn't include push buttons, so it has not been saved.", caption)
                End If
            End If
        Else
            MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        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
finish:
gdpicturePDF.Dispose()

string caption = "Example: SetFormFieldFontResName";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetFormFieldsCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        if (count == 0)
        {
            MessageBox.Show("This file doesn't include forms.", caption);
            goto finish;
        }
        string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontCourierBold);
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            int formID = 0;
            PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
            bool found = false;
            for (int i = 0; i < count; i++)
            {
                formID = gdpicturePDF.GetFormFieldId(i);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    type = gdpicturePDF.GetFormFieldType(formID);
                    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                    {
                        if (type == PdfFormFieldType.PdfFormFieldTypePushButton)
                        {
                            if ((gdpicturePDF.SetFormFieldFontResName(formID, fontResName) == GdPictureStatus.OK) &&
                                (gdpicturePDF.SetFormFieldFontSize(formID, 24) == GdPictureStatus.OK))
                            {
                                found = true;
                            }
                            else
                            {
                                MessageBox.Show("The SetFormFieldFontResName() method or the SetFormFieldFontSize() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                                break;
                            }
                        }
                    }
                    else
                    {
                        MessageBox.Show("The GetFormFieldType() 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 (found)
                {
                    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 example has been followed successfully, but the file can't be saved.", caption);
                }
                else
                    MessageBox.Show("This file doesn't include push buttons, so it has not been saved.", caption);
            }
        }
        else
            MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), 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);
finish:
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetFormFieldFontName Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldFontProperties Method