GetFormFieldRotation Method (GdPicturePDF)

In This Topic

Returns the counterclockwise rotation, in degrees, of a specified form field, relative to the page, where the form field is located. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The resulting value is always a multiple of 90.

Syntax

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

'Declaration
 
Public Function GetFormFieldRotation( _
   ByVal FieldId As Integer _
) As Integer

public int GetFormFieldRotation( 
   int FieldId
)

public function GetFormFieldRotation( 
    FieldId: Integer
): Integer;

public function GetFormFieldRotation( 
   FieldId : int
) : int;

public: int GetFormFieldRotation( 
   int FieldId
)

public:
int GetFormFieldRotation( 
   int FieldId
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GetFormFieldId, GetFormFieldChildID or methods intended to add form fields.

Return Value

The number of degrees by which the specified form field is rotated counterclockwise relative to the page. The default value is 0. The GetStat method can be subsequently used to determine if this method has been successful.

Remarks

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

It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Example

How to rotate each check box in the current document upside down.

VB.NET
C#

Dim caption As String = "Example: GetFormFieldRotation"
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 = ""
        If count = 0 Then
            message = "This document does not contain any forms."
        Else
            Dim formID As Integer = 0, rotation As Integer = 0
            Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
            For i As Integer = 0 To count - 1
                formID = gdpicturePDF.GetFormFieldId(i)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    type = gdpicturePDF.GetFormFieldType(formID)
                    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                        If type = PdfFormFieldType.PdfFormFieldTypeCheckBoxButton Then
                            rotation = gdpicturePDF.GetFormFieldRotation(formID)
                            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                                If gdpicturePDF.SetFormFieldRotation(formID, rotation + 180) <> GdPictureStatus.OK Then
                                    message = message + i.ToString() + ": The SetFormFieldRotation() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                                End If
                            Else
                                message = message + i.ToString() + ": The GetFormFieldRotation() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                            End If
                        End If
                    Else
                        message = message + i.ToString() + ": The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                    End If
                Else
                    message = message + i.ToString() + ": The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                End If
            Next
        End If
        If message.Equals("") Then message = "The example has been followed successfully." + vbCrLf
        If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then
            message = message + "The file has been saved."
        Else
            message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
        End If
        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: GetFormFieldRotation";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetFormFieldsCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        string message = "";
        if (count == 0)
            message = "This document does not contain any forms.";
        else
        {
            int formID = 0, rotation = 0;
            PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
            for (int i = 0; i < count; i++)
            {
                formID = gdpicturePDF.GetFormFieldId(i);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    type = gdpicturePDF.GetFormFieldType(formID);
                    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                    {
                        if (type == PdfFormFieldType.PdfFormFieldTypeCheckBoxButton)
                        {
                            rotation = gdpicturePDF.GetFormFieldRotation(formID);
                            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                            {
                                if (gdpicturePDF.SetFormFieldRotation(formID, rotation + 180) != GdPictureStatus.OK)
                                    message = message + i.ToString() + ": The SetFormFieldRotation() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                            }
                            else
                                message = message + i.ToString() + ": The GetFormFieldRotation() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                        }
                    }
                    else
                        message = message + i.ToString() + ": The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                }
                else
                    message = message + i.ToString() + ": The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
            }
            if (message.Equals("")) message = "The example has been followed successfully.\n";
            if (gdpicturePDF.SaveToFile("forms_updated.pdf") == GdPictureStatus.OK)
                message = message + "The file has been saved.";
            else
                message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
        }
        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();

Reference

GdPicturePDF Class
GdPicturePDF Members
SetFormFieldRotation Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldPage Method
GetFormFieldLocation Method