.. index:: 
  !DetectedDocument.orientation Property

.. _id3_document_detected_document_orientation_class_member:

===============================================================================
DetectedDocument.orientation Property
===============================================================================

Module: :ref:`DetectedDocument<id3_document_detected_document_class>`

Type: :ref:`DocumentOrientation<id3_document_document_orientation_struct>`

Definition
----------

Document orientation in source image. [0,0,0] means the document is in front of the camera.


.. tab-set::

  .. tab-item:: Python
    :sync: Python

    .. code:: Python

      orientation: DocumentOrientation


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: Dart
    :sync: Dart

    .. code:: Dart

      DocumentOrientation get orientation => getOrientation();


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: C#
    :sync: C#

    .. code:: C#

      public DocumentOrientation orientation
      {
          get => Getorientation();
      }


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: Java
    :sync: Java

    .. code:: Java

      public DocumentOrientation getOrientation() throws DocumentException


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: Swift
    :sync: Swift

    .. code:: Swift

      public var orientation: DocumentOrientation
          get {
              return try! getOrientation()
          }
      }


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: C
    :sync: C

    .. code:: C

      int id3DetectedDocument_GetOrientation (ID3_DETECTED_DOCUMENT hDetectedDocument, id3DocumentOrientation * sOrientation)

    **Returns**
   
      .. line-block::

        ``int``
        An error code.
        See :ref:`id3DocumentError<id3_document_document_error_enum>` file for the list of possible error codes.

