SetFormFieldReadOnly Method (GdPicturePDF)

In This Topic

Sets the ReadOnly flag of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

If this flag is set, then the user may not change the value of the field. Likewise, the field will not interact with the user in any way, for example, it will not respond to mouse clicks or mouse motion, etc.

Syntax

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

'Declaration
 
Public Function SetFormFieldReadOnly( _
   ByVal FieldId As Integer, _
   ByVal ROnly As Boolean _
) As GdPictureStatus

public GdPictureStatus SetFormFieldReadOnly( 
   int FieldId,
   bool ROnly
)

public function SetFormFieldReadOnly( 
    FieldId: Integer;
    ROnly: Boolean
): GdPictureStatus;

public function SetFormFieldReadOnly( 
   FieldId : int,
   ROnly : boolean
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldReadOnly( 
   int FieldId,
   bool ROnly
)

public:
GdPictureStatus SetFormFieldReadOnly( 
   int FieldId,
   bool ROnly
)

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.
ROnly: Set this parameter to true, if you want to enable the ReadOnly 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.

Remarks

This method is only allowed for use with non-encrypted documents.

Example

How to make a newly added text field non-editable.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldReadOnly"
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, 1, "Code snippet filename") = GdPictureStatus.OK) AndAlso
               (gdpicturePDF.DrawText(fontResName, 0.5F, 4, "Code snippet") = GdPictureStatus.OK) Then
                Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 1.5F, 10, 1, "Filename", "", 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.SetFormFieldMultiLine(formID, False) <> GdPictureStatus.OK) OrElse
                       (gdpicturePDF.SetFormFieldReadOnly(formID, False) <> 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(1, 4.5F, 10, 10, "Code snippet", "", 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, False) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldMultiLine(formID, True) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldReadOnly(formID, True) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldRichText(formID, True) <> 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: SetFormFieldReadOnly";
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, 1, "Code snippet filename") == GdPictureStatus.OK) &&
                (gdpicturePDF.DrawText(fontResName, 0.5f, 4, "Code snippet") == GdPictureStatus.OK))
            {
                int formID = gdpicturePDF.AddTextFormField(1, 1.5f, 10, 1, "Filename", "", 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.SetFormFieldMultiLine(formID, false) != GdPictureStatus.OK) ||
                        (gdpicturePDF.SetFormFieldReadOnly(formID, false) != 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(1, 4.5f, 10, 10, "Code snippet", "", 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, false) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldMultiLine(formID, true) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldReadOnly(formID, true) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldRichText(formID, true) != 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();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetFormFieldReadOnly Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldRequired Method