SetFormFieldBorderStyle(Int32,Int32,Single,PdfAnnotationBorderStyle,Single,Single) Method

In This Topic

Sets the style of the line used to draw the border of a required form field, here a child radio button in a group. The radio button group is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As said, this method is only applicable to radio buttons.

The border's line dimensions need to be set in the current units defined in the PDF document. You can use the GdPicturePDF.GetMeasurementUnit method to determine the currently defined units and you can use the GdPicturePDF.SetMeasurementUnit method to reset the units according to your preference. Please note that every single child radio button in a group of radio buttons within a radio button field can have its own border's line style defined.

Syntax

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

'Declaration
 
Public Overloads Function SetFormFieldBorderStyle( _
   ByVal FieldId As Integer, _
   ByVal ChildIdx As Integer, _
   ByVal BorderWidth As Single, _
   ByVal BorderStyle As PdfAnnotationBorderStyle, _
   ByVal DashOn As Single, _
   ByVal DashOff As Single _
) As GdPictureStatus

public GdPictureStatus SetFormFieldBorderStyle( 
   int FieldId,
   int ChildIdx,
   float BorderWidth,
   PdfAnnotationBorderStyle BorderStyle,
   float DashOn,
   float DashOff
)

public function SetFormFieldBorderStyle( 
    FieldId: Integer;
    ChildIdx: Integer;
    BorderWidth: Single;
    BorderStyle: PdfAnnotationBorderStyle;
    DashOn: Single;
    DashOff: Single
): GdPictureStatus;

public function SetFormFieldBorderStyle( 
   FieldId : int,
   ChildIdx : int,
   BorderWidth : float,
   BorderStyle : PdfAnnotationBorderStyle,
   DashOn : float,
   DashOff : float
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldBorderStyle( 
   int FieldId,
   int ChildIdx,
   float BorderWidth,
   PdfAnnotationBorderStyle BorderStyle,
   float DashOn,
   float DashOff
)

public:
GdPictureStatus SetFormFieldBorderStyle( 
   int FieldId,
   int ChildIdx,
   float BorderWidth,
   PdfAnnotationBorderStyle BorderStyle,
   float DashOn,
   float DashOff
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddRadioButtonFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
ChildIdx: The index of the required child radio button in a group. It must be a value from 0 to GdPicturePDF.GetFormFieldChildCount-1.
It is simply a sequence index of a radio button in a group, it does not correspond to the unique form field's identifier.
BorderWidth: The width of the line used to draw the form field's border, expressed in the current units specified by the SetMeasurementUnit method.
BorderStyle: A member of the PdfAnnotationBorderStyle enumeration. The style of the line used to draw the form field's border.
DashOn: If the style of the border's line (the BorderStyle parameter) is dashed, this value defines the width of the dashes in the dash pattern used to draw the border's line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.
DashOff: If the style of the border's line (the BorderStyle parameter) is dashed, this value defines the width of the gaps in the dash pattern used to draw the border's line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.

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. At the same, this method is only meaningful for radio buttons, otherwise it will fail.

Likewise, be aware that both DashOn and DashOff parameters are valid only if the specified value of the BorderStyle parameter is PdfAnnotationBorderStyle.PdfAnnotationBorderStyleDashed, otherwise they are ignored.

Just to remind you that the values of dimensions need to be set in the current units defined by the GdPicturePDF.SetMeasurementUnit method.

Example

How to set the different border style for checked and unchecked child radio buttons in a group.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldBorderStyle"
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, childCount As Integer = 0
        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
        Dim hasRB As Boolean = False, isChecked As Boolean = False
        Dim status As GdPictureStatus = GdPictureStatus.OK
        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.PdfFormFieldTypeRadioButton Then
                        hasRB = True
                        childCount = gdpicturePDF.GetFormFieldChildCount(formID)
                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                            For j As Integer = 0 To childCount - 1
                                isChecked = gdpicturePDF.GetFormFieldChecked(formID, j)
                                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                                    If isChecked Then
                                        status = gdpicturePDF.SetFormFieldBorderStyle(formID, j, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleBeveled, 0, 0)
                                    Else
                                        status = gdpicturePDF.SetFormFieldBorderStyle(formID, j, 1, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleInset, 0, 0)
                                    End If
                                    If status <> GdPictureStatus.OK Then
                                        MessageBox.Show("The SetFormFieldBorderStyle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                                        Exit For
                                    End If
                                Else
                                    MessageBox.Show("The GetFormFieldChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                                    Exit For
                                End If
                            Next
                        Else
                            MessageBox.Show("The GetFormFieldChildCount() 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 count = 0 Then
                MessageBox.Show("This file doesn't include forms.", caption)
            Else
                If Not hasRB Then
                    MessageBox.Show("This file doesn't include radio button form fields.", 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 example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption)
                    End If
                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: SetFormFieldBorderStyle";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetFormFieldsCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        int formID = 0, childCount = 0;
        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
        bool hasRB = false, isChecked = false;
        GdPictureStatus status = GdPictureStatus.OK;
        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.PdfFormFieldTypeRadioButton)
                    {
                        hasRB = true;
                        childCount = gdpicturePDF.GetFormFieldChildCount(formID);
                        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                        {
                            for (int j = 0; j < childCount; j++)
                            {
                                isChecked = gdpicturePDF.GetFormFieldChecked(formID, j);
                                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                                {
                                    if (isChecked)
                                        status = gdpicturePDF.SetFormFieldBorderStyle(formID, j, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleBeveled, 0, 0);
                                    else
                                        status = gdpicturePDF.SetFormFieldBorderStyle(formID, j, 1, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleInset, 0, 0);
                                    if (status != GdPictureStatus.OK)
                                    {
                                        MessageBox.Show("The SetFormFieldBorderStyle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                                        break;
                                    }
                                }
                                else
                                {
                                    MessageBox.Show("The GetFormFieldChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                                    break;
                                }
                            }
                        }
                        else
                        {
                            MessageBox.Show("The GetFormFieldChildCount() 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 (count == 0) MessageBox.Show("This file doesn't include forms.", caption);
            else
            {
                if (!hasRB) MessageBox.Show("This file doesn't include radio button form fields.", 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 example has been followed successfully, but the file can't be saved. 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);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetFormFieldBorderStyle(Int32,Int32,Single,PdfAnnotationBorderStyle,Single,Single) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,GdPictureColor) Method