SetFormFieldDoNotScroll Method (GdPicturePDF)
In This Topic
Sets the DoNotScroll 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 does not scroll to include more text than fits within its rectangle. Once the field is full, no further text is accepted.
Syntax
'Declaration
Public Function SetFormFieldDoNotScroll( _
ByVal As Integer, _
ByVal As Boolean _
) As GdPictureStatus
public GdPictureStatus SetFormFieldDoNotScroll(
int ,
bool
)
public function SetFormFieldDoNotScroll(
: Integer;
: Boolean
): GdPictureStatus;
public function SetFormFieldDoNotScroll(
: int,
: boolean
) : GdPictureStatus;
public: GdPictureStatus SetFormFieldDoNotScroll(
int ,
bool
)
public:
GdPictureStatus SetFormFieldDoNotScroll(
int ,
bool
)
Parameters
- FieldId
- A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte), GetFormFieldId or GetFormFieldChildID.
- DoNotScroll
- Set this parameter to true, if you want to enable the DoNotScroll 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 DoNotScroll flag when creating different text form fields.
Dim caption As String = "Example: SetFormFieldDoNotScroll"
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.PdfStandardFontHelvetica)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetTextSize(20) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 0.5F, 2, "Name") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 0.5F, 4, "Address") = GdPictureStatus.OK) Then
Dim formID As Integer = gdpicturePDF.AddTextFormField(3.5F, 1, 6, 1, "Name", "", False, fontResName, 20, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotScroll(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) <> GdPictureStatus.OK) Then
MessageBox.Show("Setting 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
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
formID = gdpicturePDF.AddTextFormField(3.5F, 3, 6, 2, "Address", "", True, fontResName, 20, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotScroll(formID, False) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) <> GdPictureStatus.OK) Then
MessageBox.Show("Setting 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
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddStandardFont() method 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: SetFormFieldDoNotScroll";
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.PdfStandardFontHelvetica);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetTextSize(20) == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 0.5f, 2, "Name") == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 0.5f, 4, "Address") == GdPictureStatus.OK))
{
int formID = gdpicturePDF.AddTextFormField(3.5f, 1, 6, 1, "Name", "", false, fontResName, 20, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotScroll(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) != GdPictureStatus.OK))
{
MessageBox.Show("Setting 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)
{
formID = gdpicturePDF.AddTextFormField(3.5f, 3, 6, 2, "Address", "", true, fontResName, 20, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotScroll(formID, false) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) != GdPictureStatus.OK))
{
MessageBox.Show("Setting 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)
{
if (gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddStandardFont() method 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 DoNotScroll flag when creating different text form fields.
Dim caption As String = "Example: SetFormFieldDoNotScroll"
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.PdfStandardFontHelvetica)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetTextSize(20) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 0.5F, 2, "Name") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontResName, 0.5F, 4, "Address") = GdPictureStatus.OK) Then
Dim formID As Integer = gdpicturePDF.AddTextFormField(3.5F, 1, 6, 1, "Name", "", False, fontResName, 20, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotScroll(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) <> GdPictureStatus.OK) Then
MessageBox.Show("Setting 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
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
formID = gdpicturePDF.AddTextFormField(3.5F, 3, 6, 2, "Address", "", True, fontResName, 20, 165, 42, 42)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotScroll(formID, False) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) OrElse
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) <> GdPictureStatus.OK) Then
MessageBox.Show("Setting 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
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddStandardFont() method 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: SetFormFieldDoNotScroll";
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.PdfStandardFontHelvetica);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetTextSize(20) == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 0.5f, 2, "Name") == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontResName, 0.5f, 4, "Address") == GdPictureStatus.OK))
{
int formID = gdpicturePDF.AddTextFormField(3.5f, 1, 6, 1, "Name", "", false, fontResName, 20, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotScroll(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) != GdPictureStatus.OK))
{
MessageBox.Show("Setting 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)
{
formID = gdpicturePDF.AddTextFormField(3.5f, 3, 6, 2, "Address", "", true, fontResName, 20, 165, 42, 42);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotScroll(formID, false) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK) ||
(gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) != GdPictureStatus.OK))
{
MessageBox.Show("Setting 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)
{
if (gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddStandardFont() method 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
GetFormFieldDoNotScroll 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