.. index:: 
  !DocumentImage.flipTo Method
  
.. _id3_document_document_image_flip_to_class_method:

===============================================================================
DocumentImage.flipTo Method
===============================================================================

Module: :ref:`DocumentImage<id3_document_document_image_class>`

Definition
----------

Flips the image.


.. tab-set::

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

      .. code:: Python

        flip_to(self, flip_horizontally: bool, flip_vertically: bool, dst_document_image: DocumentImage) -> None

      **Parameters**

        .. line-block::

          ``flip_horizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flip_vertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dst_document_image`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Exceptions**

        .. line-block::

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


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

      .. code:: Dart

        void flipTo(bool flipHorizontally, bool flipVertically, DocumentImage dstDocumentImage)

      **Parameters**

        .. line-block::

          ``flipHorizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstDocumentImage`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **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 void FlipTo(bool flipHorizontally, bool flipVertically, DocumentImage dstDocumentImage)

      **Parameters**

        .. line-block::

          ``flipHorizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstDocumentImage`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **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 void flipTo(boolean flipHorizontally, boolean flipVertically, DocumentImage dstDocumentImage) throws DocumentException

      **Parameters**

        .. line-block::

          ``flipHorizontally`` boolean
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` boolean
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstDocumentImage`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **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 func flipTo(flipHorizontally: Bool, flipVertically: Bool, dstDocumentImage: DocumentImage) throws

      **Parameters**

        .. line-block::

          ``flipHorizontally`` Bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` Bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstDocumentImage`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **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 id3DocumentImage_FlipTo (
            ID3_DOCUMENT_IMAGE hDocumentImage, 
            bool flipHorizontally, 
            bool flipVertically, 
            ID3_DOCUMENT_IMAGE hDstDocumentImage)

      **Parameters**

        .. line-block::

          ``hDocumentImage`` :ref:`ID3_DOCUMENT_IMAGE<id3_document_document_image_class>`
          :guilabel:`in` Handle to the DocumentImage object.

          ``flipHorizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``hDstDocumentImage`` :ref:`ID3_DOCUMENT_IMAGE<id3_document_document_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Returns**

        .. line-block::

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


