DocumentImage.flipTo Method

Module: DocumentImage

Definition

Flips the image.

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

Parameters

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

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

dst_document_image DocumentImage
in The destination Image object that receives the flipped image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
void flipTo(bool flipHorizontally, bool flipVertically, DocumentImage dstDocumentImage)

Parameters

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

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

dstDocumentImage DocumentImage
in The destination Image object that receives the flipped image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void FlipTo(bool flipHorizontally, bool flipVertically, DocumentImage dstDocumentImage)

Parameters

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

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

dstDocumentImage DocumentImage
in The destination Image object that receives the flipped image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void flipTo(boolean flipHorizontally, boolean flipVertically, DocumentImage dstDocumentImage) throws DocumentException

Parameters

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

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

dstDocumentImage DocumentImage
in The destination Image object that receives the flipped image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public func flipTo(flipHorizontally: Bool, flipVertically: Bool, dstDocumentImage: DocumentImage) throws

Parameters

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

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

dstDocumentImage DocumentImage
in The destination Image object that receives the flipped image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentImage_FlipTo (
    ID3_DOCUMENT_IMAGE hDocumentImage,
    bool flipHorizontally,
    bool flipVertically,
    ID3_DOCUMENT_IMAGE hDstDocumentImage)

Parameters

hDocumentImage ID3_DOCUMENT_IMAGE
in Handle to the DocumentImage object.

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

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

hDstDocumentImage ID3_DOCUMENT_IMAGE
in The destination Image object that receives the flipped image.

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.