GetFormFieldFontColor(Int32) Method
Returns the color of the font used to display text or the checkmark 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. This attribute is not restricted to any form fields, even if the form field's appearance doesn't display text. In other words, this value also defines the color of the checkmark in a required form field.
Be aware that if the checkmark's color differs for each single child radio button in a group of radio buttons within a radio button field, this method will fail. Please use the GdPicturePDF.GetFormFieldFontColor method to determine the individual color of the checkmark for each child radio button in a group instead.
For further assistance, please refer to the PDF Reference, Section "Interactive Forms".
public Color GetFormFieldFontColor(
int
)
public function GetFormFieldFontColor(
: Integer
): Color;
public function GetFormFieldFontColor(
: int
) : Color;
public: Color GetFormFieldFontColor(
int
)
public:
Color GetFormFieldFontColor(
int
)
'Declaration
Public Overloads Function GetFormFieldFontColor( _
ByVal As Integer _
) As Color
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.
Return Value
The color of the defined font or the checkmark of a specified form field. The
GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
How to find out font properties of fonts used for all form fields in the current document.
Dim caption As String = "Example: GetFormFieldFontColor"
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 message As String = "This document contains " + count.ToString() + " form fields." + vbCrLf
Dim formID As Integer = 0
Dim fName As String = "", fFamily As String = ""
Dim fSize As Single = 0
Dim fColor As Color = Color.Black
Dim fStyle As GdPicture14.FontStyle = GdPicture14.FontStyle.FontStyleRegular
Dim isStdF As Boolean = False
Dim status As GdPictureStatus = GdPictureStatus.OK
Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
For i As Integer = 0 To count - 1
formID = gdpicturePDF.GetFormFieldId(i)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + (i + 1).ToString() + ". "
message = message + "type: "
type = gdpicturePDF.GetFormFieldType(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + type.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
message = message + " font: "
fName = gdpicturePDF.GetFormFieldFontName(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + fName
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
message = message + " size: "
fSize = gdpicturePDF.GetFormFieldFontSize(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + fSize.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
message = message + " color: "
fColor = gdpicturePDF.GetFormFieldFontColor(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + fColor.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
message = message + vbCrLf + " properties: "
status = gdpicturePDF.GetFormFieldFontProperties(formID, fFamily, fStyle, isStdF)
If status = GdPictureStatus.OK Then
message = message + " family: " + fFamily + " style: " + fStyle.ToString() + " isStandard: " + isStdF.ToString()
Else
message = message + status.ToString()
End If
message += vbCrLf
Else
message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString()
Exit For
End If
Next
MessageBox.Show(message, caption)
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: GetFormFieldFontColor";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
int count = gdpicturePDF.GetFormFieldsCount();
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
string message = "This document contains " + count.ToString() + " form fields.\n";
int formID = 0;
string fName = "", fFamily = "";
float fSize = 0;
Color fColor = Color.Black;
GdPicture14.FontStyle fStyle = GdPicture14.FontStyle.FontStyleRegular;
bool isStdF = false;
GdPictureStatus status = GdPictureStatus.OK;
PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
for (int i = 0; i < count; i++)
{
formID = gdpicturePDF.GetFormFieldId(i);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
message = message + (i + 1).ToString() + ". ";
message = message + "type: ";
type = gdpicturePDF.GetFormFieldType(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + type.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
message = message + " font: ";
fName = gdpicturePDF.GetFormFieldFontName(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + fName;
else
message = message + gdpicturePDF.GetStat().ToString();
message = message + " size: ";
fSize = gdpicturePDF.GetFormFieldFontSize(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + fSize.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
message = message + " color: ";
fColor = gdpicturePDF.GetFormFieldFontColor(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + fColor.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
message = message + "\n properties: ";
status = gdpicturePDF.GetFormFieldFontProperties(formID, ref fFamily, ref fStyle, ref isStdF);
if (status == GdPictureStatus.OK)
message = message + " family: " + fFamily + " style: " +fStyle.ToString() + " isStandard: " + isStdF.ToString();
else
message = message + status.ToString();
message += "\n";
}
else
{
message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString();
break;
}
}
MessageBox.Show(message, 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();
