SetFormFieldOnStateName(Int32,Int32,String) Method

In This Topic

Sets the string representation of the normal appearance (the On state, same as the radio button's choice attribute) of a required form field, here a child radio button in a group, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The normal appearance represents the checked state of a radio button and it is used when a radio button is not interacting with the user and for printing. As said, this method is only applicable to radio buttons.

If this attribute is not defined for the specified child radio button, then the predefined value for the On state is "On" by default.

Syntax

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

'Declaration

 

Public Overloads Function SetFormFieldOnStateName( _

   ByVal FieldId As Integer, _

   ByVal ChildIdx As Integer, _

   ByVal OnStateName As String _

) As GdPictureStatus

public GdPictureStatus SetFormFieldOnStateName( 

   int FieldId,

   int ChildIdx,

   string OnStateName

)

public function SetFormFieldOnStateName( 

    FieldId: Integer;

    ChildIdx: Integer;

    OnStateName: String

): GdPictureStatus;

public function SetFormFieldOnStateName( 

   FieldId : int,

   ChildIdx : int,

   OnStateName : String

) : GdPictureStatus;

public: GdPictureStatus SetFormFieldOnStateName( 

   int FieldId,

   int ChildIdx,

   string* OnStateName

)

public:

GdPictureStatus SetFormFieldOnStateName( 

   int FieldId,

   int ChildIdx,

   String^ OnStateName

)

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.
OnStateName: A string representation of the On state (radio button's choice attribute) of the specified child radio button in a group.

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 remind you that this method is only meaningful for radio buttons, otherwise it will fail. If this attribute is undefined for the specified child radio button, then the resulting value is "On" by default. The value for the opposite state used internally is always "Off".

In other words, the On state name represents so called radio button's choice attribute.

Example

How to specify the value representing the On state attribute of the newly added radio buttons.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldOnStateName"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso

   (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then

    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)

    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)

    'Please always select the required page before adding a form field.

    If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then

        Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic)

        If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso

           (gdpicturePDF.DrawText(fontResName, 1, 0.8F, "What color do you prefer for your T-shirt?") = GdPictureStatus.OK) Then

            Dim formID As Integer = 0

            Dim buttonName As String = "RadioButton"

            Dim colors As String() = New String() {"white", "yellow", "red", "blue", "green", "black"}

            For i As Integer = 0 To colors.Length - 1

                formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, Color.Black)

                If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse

                   (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) <> GdPictureStatus.OK) OrElse

                   (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) <> GdPictureStatus.OK) OrElse

                   (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors(i)) <> GdPictureStatus.OK) OrElse

                   (gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors(i)) <> GdPictureStatus.OK) Then

                    MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                    Exit For

                End If

            Next

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                If gdpicturePDF.SaveToFile("forms_radiobutton.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

        Else

            MessageBox.Show("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

        End If

    Else

        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

    End If

Else

    MessageBox.Show("The file can't be created.", caption)

End If

gdpicturePDF.Dispose()

string caption = "Example: SetFormFieldOnStateName";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) &&

    (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))

{

    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);

    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);

    //Please always select the required page before adding a form field.

    if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK)

    {

        string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic);

        if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&

            (gdpicturePDF.DrawText(fontResName, 1, 0.8f, "What colour do you prefer for your T-shirt?") == GdPictureStatus.OK))

        {

            int formID = 0;

            string buttonName = "RadioButton";

            string[] colors = new string[] { "white", "yellow", "red", "blue", "green", "black" };

            for (int i = 0; i < colors.Length; i++)

            {

                formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, Color.Black);

                if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||

                    (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) != GdPictureStatus.OK) ||

                    (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) != GdPictureStatus.OK) ||

                    (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors[i]) != GdPictureStatus.OK) ||

                    (gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors[i]) != GdPictureStatus.OK))

                {

                    MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                    break;

                }

            }

            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

            {

                if (gdpicturePDF.SaveToFile("forms_radiobutton.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("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

    }

    else

        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

}

else

    MessageBox.Show("The file can't be created.", caption);

gdpicturePDF.Dispose();

Example

How to specify the value representing the On state attribute of the newly added radio buttons. Dim caption As String = "Example: SetFormFieldOnStateName" Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF() If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft) gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter) 'Please always select the required page before adding a form field. If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic) If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (gdpicturePDF.DrawText(fontResName, 1, 0.8F, "What color do you prefer for your T-shirt?") = GdPictureStatus.OK) Then Dim formID As Integer = 0 Dim buttonName As String = "RadioButton" Dim colors As String() = New String() {"white", "yellow", "red", "blue", "green", "black"} For i As Integer = 0 To colors.Length - 1 formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, Color.Black) If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors(i)) <> GdPictureStatus.OK) OrElse (gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors(i)) <> GdPictureStatus.OK) Then MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If Next If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If gdpicturePDF.SaveToFile("forms_radiobutton.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 Else MessageBox.Show("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The file can't be created.", caption) End If gdpicturePDF.Dispose() string caption = "Example: SetFormFieldOnStateName"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) && (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK)) { gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft); gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter); //Please always select the required page before adding a form field. if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK) { string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic); if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (gdpicturePDF.DrawText(fontResName, 1, 0.8f, "What colour do you prefer for your T-shirt?") == GdPictureStatus.OK)) { int formID = 0; string buttonName = "RadioButton"; string[] colors = new string[] { "white", "yellow", "red", "blue", "green", "black" }; for (int i = 0; i < colors.Length; i++) { formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, Color.Black); if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors[i]) != GdPictureStatus.OK) || (gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors[i]) != GdPictureStatus.OK)) { MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } } if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if (gdpicturePDF.SaveToFile("forms_radiobutton.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("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The file can't be created.", caption); gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldChildCount Method
GetFormFieldOnStateName(Int32,Int32) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildCount Method
GetFormFieldType Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,GdPictureColor) Method