SetFormFieldCheckBoxStyle(Int32,Int32,PdfCheckBoxStyle) Method
In This Topic
Sets the graphical style of a checkmark used to represent the checked state 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 checkmark is a shape, that appears in the specified radio button field, when it is checked/selected. Please note that every single child radio button in a group of radio buttons within a radio button field can have its own checkmark defined. This method doesn't alter the form field's visual appearance in any way.
Syntax
'Declaration
Public Overloads Function SetFormFieldCheckBoxStyle( _
ByVal As Integer, _
ByVal As Integer, _
ByVal As PdfCheckBoxStyle _
) As GdPictureStatus
public GdPictureStatus SetFormFieldCheckBoxStyle(
int ,
int ,
PdfCheckBoxStyle
)
public function SetFormFieldCheckBoxStyle(
: Integer;
: Integer;
: PdfCheckBoxStyle
): GdPictureStatus;
public function SetFormFieldCheckBoxStyle(
: int,
: int,
: PdfCheckBoxStyle
) : GdPictureStatus;
public: GdPictureStatus SetFormFieldCheckBoxStyle(
int ,
int ,
PdfCheckBoxStyle
)
public:
GdPictureStatus SetFormFieldCheckBoxStyle(
int ,
int ,
PdfCheckBoxStyle
)
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.
- CheckStyle
- A member of the PdfCheckBoxStyle enumeration. A graphical style of a checkmark to be used when checking/selecting the required 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.
Example
How to set a different style of the checkmark for each child radio button in a group.
Dim caption As String = "Example: SetFormFieldCheckBoxStyle"
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 colour do you prefer for your T-shirt?") = GdPictureStatus.OK) Then
Dim formID As Integer = 0
Dim buttonName As String = "RadioButton"
Dim colors1 As String() = New String() {"white", "yellow", "red", "blue", "green", "black"}
Dim colors2 As Byte()() = New Byte(5)() {New Byte(2) {255, 255, 255}, New Byte(2) {255, 255, 0}, New Byte(2) {255, 0, 0}, New Byte(2) {0, 0, 255}, New Byte(2) {0, 255, 0}, New Byte(2) {0, 0, 0}}
For i As Integer = 0 To colors1.Length - 1
formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCheck, 0, 0, 0)
If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBackgroundColor(formID, CByte(255), CByte(228), CByte(196)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, CByte(165), CByte(42), CByte(42)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldCheckBoxStyle(formID, i, CType(i, PdfCheckBoxStyle)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldFontColor(formID, i, colors2(i)(0), colors2(i)(1), colors2(i)(2)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldOnStateName(formID, i, colors1(i)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors1(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: SetFormFieldCheckBoxStyle";
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[] colors1 = new string[] { "white", "yellow", "red", "blue", "green", "black" };
byte[][] colors2 = new byte[6][] { new byte[3] { 255, 255, 255 }, new byte[3] { 255, 255, 0 }, new byte[3] { 255, 0, 0 },
new byte[3] { 0, 0, 255 }, new byte[3] { 0, 255, 0 }, new byte[3] { 0, 0, 0 } };
for (int i = 0; i < colors1.Length; i++)
{
formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCheck, 0, 0, 0);
if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBackgroundColor(formID, (byte)255, (byte)228, (byte)196) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, (byte)165, (byte)42, (byte)42) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldCheckBoxStyle(formID, i, (PdfCheckBoxStyle)i) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldFontColor(formID, i, colors2[i][0], colors2[i][1], colors2[i][2]) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldOnStateName(formID, i, colors1[i]) != GdPictureStatus.OK) ||
(gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors1[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 set a different style of the checkmark for each child radio button in a group.
Dim caption As String = "Example: SetFormFieldCheckBoxStyle"
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 colour do you prefer for your T-shirt?") = GdPictureStatus.OK) Then
Dim formID As Integer = 0
Dim buttonName As String = "RadioButton"
Dim colors1 As String() = New String() {"white", "yellow", "red", "blue", "green", "black"}
Dim colors2 As Byte()() = New Byte(5)() {New Byte(2) {255, 255, 255}, New Byte(2) {255, 255, 0}, New Byte(2) {255, 0, 0}, New Byte(2) {0, 0, 255}, New Byte(2) {0, 255, 0}, New Byte(2) {0, 0, 0}}
For i As Integer = 0 To colors1.Length - 1
formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCheck, 0, 0, 0)
If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBackgroundColor(formID, CByte(255), CByte(228), CByte(196)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, CByte(165), CByte(42), CByte(42)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldCheckBoxStyle(formID, i, CType(i, PdfCheckBoxStyle)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldFontColor(formID, i, colors2(i)(0), colors2(i)(1), colors2(i)(2)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldOnStateName(formID, i, colors1(i)) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors1(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: SetFormFieldCheckBoxStyle";
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[] colors1 = new string[] { "white", "yellow", "red", "blue", "green", "black" };
byte[][] colors2 = new byte[6][] { new byte[3] { 255, 255, 255 }, new byte[3] { 255, 255, 0 }, new byte[3] { 255, 0, 0 },
new byte[3] { 0, 0, 255 }, new byte[3] { 0, 255, 0 }, new byte[3] { 0, 0, 0 } };
for (int i = 0; i < colors1.Length; i++)
{
formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCheck, 0, 0, 0);
if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBackgroundColor(formID, (byte)255, (byte)228, (byte)196) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, (byte)165, (byte)42, (byte)42) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldCheckBoxStyle(formID, i, (PdfCheckBoxStyle)i) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldFontColor(formID, i, colors2[i][0], colors2[i][1], colors2[i][2]) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldOnStateName(formID, i, colors1[i]) != GdPictureStatus.OK) ||
(gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors1[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();
See Also
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
GetFormFieldCheckBoxStyle(Int32,Int32) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddCheckBoxFormField(Single,Single,Single,Single,String,PdfCheckBoxStyle,Boolean,GdPictureColor) Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,GdPictureColor) Method