SetFormFieldPassword Method (GdPicturePDF)
In This Topic
Sets the Password flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.
If this flag is set, then the text field is intended for entering a secure password that should not be echoed visibly to the screen. Instead, the characters typed from the keyboard should be displayed in some unreadable form, usually asterisks.
Syntax
Parameters
- FieldId
- A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddTextFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
- Password
- Set this parameter to true, if you want to enable the Password flag, otherwise set it to false to disable it.
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 utilize the Password flag when creating the text form field intended for adding a password.
Dim caption As String = "Example: SetFormFieldPassword"
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.PdfStandardFontCourierOblique)
If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetTextSize(16) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 1, 1, "Enter your name") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 1, 4, "Enter your password") = GdPictureStatus.OK) Then
'Adding the name text field.
Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 1.5F, 10, 1, "Name", "", False, fontResName, 16, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotScroll(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) Then
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
Else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
End If
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
'Adding the password text field.
formID = gdpicturePDF.AddTextFormField(1, 4.5F, 10, 1, "Password", "", False, fontResName, 16, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldDoNotScroll(formID, True) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldPassword(formID, True) = GdPictureStatus.OK) Then
Dim message As String = "The example has been followed successfully"
If gdpicturePDF.SaveToFile("forms_textfield.pdf") = GdPictureStatus.OK Then
message = message + " and the file has been saved successfully."
Else
message = message + ", but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
End If
MessageBox.Show(message, caption)
Else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
End If
Else
MessageBox.Show("The AddStandardFont() method or drawing 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: SetFormFieldPassword";
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.PdfStandardFontCourierOblique);
if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
(gdpicturePDF.SetTextSize(16) == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 1, 1, "Enter your name") == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 1, 4, "Enter your password") == GdPictureStatus.OK))
{
//Adding the name text field.
int formID = gdpicturePDF.AddTextFormField(1, 2, 10, 1, "Name", "", false, fontResName, 16, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotScroll(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK))
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
//Adding the password text field.
formID = gdpicturePDF.AddTextFormField(1, 4, 10, 1, "Password", "", false, fontResName, 16, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldDoNotScroll(formID, true) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldPassword(formID, true) == GdPictureStatus.OK))
{
string message = "The example has been followed successfully";
if (gdpicturePDF.SaveToFile("forms_textfield.pdf") == GdPictureStatus.OK)
message = message + " and the file has been saved successfully.";
else
message = message + ", but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
MessageBox.Show(message, caption);
}
else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
}
else
MessageBox.Show("The AddStandardFont() method or drawing 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 utilize the Password flag when creating the text form field intended for adding a password.
Dim caption As String = "Example: SetFormFieldPassword"
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.PdfStandardFontCourierOblique)
If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetTextSize(16) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 1, 1, "Enter your name") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 1, 4, "Enter your password") = GdPictureStatus.OK) Then
'Adding the name text field.
Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 1.5F, 10, 1, "Name", "", False, fontResName, 16, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotScroll(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) Then
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
Else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
End If
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
'Adding the password text field.
formID = gdpicturePDF.AddTextFormField(1, 4.5F, 10, 1, "Password", "", False, fontResName, 16, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldDoNotScroll(formID, True) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldPassword(formID, True) = GdPictureStatus.OK) Then
Dim message As String = "The example has been followed successfully"
If gdpicturePDF.SaveToFile("forms_textfield.pdf") = GdPictureStatus.OK Then
message = message + " and the file has been saved successfully."
Else
message = message + ", but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
End If
MessageBox.Show(message, caption)
Else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
End If
Else
MessageBox.Show("The AddStandardFont() method or drawing 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: SetFormFieldPassword";
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.PdfStandardFontCourierOblique);
if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
(gdpicturePDF.SetTextSize(16) == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 1, 1, "Enter your name") == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 1, 4, "Enter your password") == GdPictureStatus.OK))
{
//Adding the name text field.
int formID = gdpicturePDF.AddTextFormField(1, 2, 10, 1, "Name", "", false, fontResName, 16, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotScroll(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK))
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
//Adding the password text field.
formID = gdpicturePDF.AddTextFormField(1, 4, 10, 1, "Password", "", false, fontResName, 16, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 255, 255) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldDoNotScroll(formID, true) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldPassword(formID, true) == GdPictureStatus.OK))
{
string message = "The example has been followed successfully";
if (gdpicturePDF.SaveToFile("forms_textfield.pdf") == GdPictureStatus.OK)
message = message + " and the file has been saved successfully.";
else
message = message + ", but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
MessageBox.Show(message, caption);
}
else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
}
else
MessageBox.Show("The AddStandardFont() method or drawing 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
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldPassword Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldValue(Int32) Method
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte) Method