Rectangle.clipInsideImage Method

Module: Rectangle

Definition

Clip a rectangle to be fully inside an image.

Python

clip_inside_image(self, image_width: int, image_height: int) -> None

Parameters

image_width int

in Width of the image.

image_height int

in Height of the image.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

void clipInsideImage(int imageWidth, int imageHeight)

Parameters

imageWidth int

in Width of the image.

imageHeight int

in Height of the image.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public void ClipInsideImage(int imageWidth, int imageHeight)

Parameters

imageWidth int

in Width of the image.

imageHeight int

in Height of the image.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public void clipInsideImage(int imageWidth, int imageHeight) throws DocumentException

Parameters

imageWidth int

in Width of the image.

imageHeight int

in Height of the image.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func clipInsideImage(imageWidth: Int32, imageHeight: Int32) throws

Parameters

imageWidth Int32

in Width of the image.

imageHeight Int32

in Height of the image.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentRectangle_ClipInsideImage (
    ID3_DOCUMENT_RECTANGLE hRectangle,
    int imageWidth,
    int imageHeight)

Parameters

hRectangle ID3_DOCUMENT_RECTANGLE

in Handle to the Rectangle object.

imageWidth int

in Width of the image.

imageHeight int

in Height of the image.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.