Groupdocs API References – CustomImageSavingArgs class

Python-Net: set_output_image_file_name method

Mon, 01 Jan 0001 00:00:00 +0000

set_output_image_file_name

Overrides the default file name for this image. The image will be saved under the specified name instead of the library-generated CustomImageSavingArgs.image_file_name.

def set_output_image_file_name(self, file_name):
    ...

Parameter	Type	Description
file_name	`str`	The new file name (without path) to use for the image.

Python-Net: set_output_stream method

Mon, 01 Jan 0001 00:00:00 +0000

set_output_stream

Redirects the image data to a custom writable stream instead of the default file output. The library will write the image bytes to this stream during conversion.

def set_output_stream(self, stream):
    ...

Parameter	Type	Description
stream	`io.RawIOBase`	A writable stream where the image data will be written.

Raises	Description
`ValueError`	When `stream` is None.

Python-Net: set_replacement_image method

Mon, 01 Jan 0001 00:00:00 +0000

set_replacement_image

Provides a replacement image to use instead of the original image from the source document. The stream must contain the complete replacement image data (e.g., PNG or JPEG bytes). When set, the library writes this data to the output instead of the original image.

def set_replacement_image(self, image_stream):
    ...

Parameter	Type	Description
image_stream	`io.RawIOBase`	A readable stream containing the replacement image data.

Raises	Description
`ValueError`	Raised when `image_stream` is None.

Python-Net: image_file_name property

Mon, 01 Jan 0001 00:00:00 +0000

image_file_name property

The default file name (without path) suggested by the library for this image.

Definition:

@property
def image_file_name(self):
    ...

Python-Net: image_file_name_output property

Mon, 01 Jan 0001 00:00:00 +0000

image_file_name_output property

The overridden file name set by CustomImageSavingArgs.set_output_image_file_name, or None if no override was specified.

Definition:

@property
def image_file_name_output(self):
    ...

Python-Net: output_directory property

Mon, 01 Jan 0001 00:00:00 +0000

output_directory property

The output directory where images are being saved.

Definition:

@property
def output_directory(self):
    ...

Python-Net: output_stream property

Mon, 01 Jan 0001 00:00:00 +0000

output_stream property

The custom output stream set by CustomImageSavingArgs.set_output_stream, or None if no custom stream was specified.

Definition:

@property
def output_stream(self):
    ...

Python-Net: replacement_image_stream property

Mon, 01 Jan 0001 00:00:00 +0000

replacement_image_stream property

The replacement image stream set by CustomImageSavingArgs.set_replacement_image, or None if no replacement was specified.

Definition:

@property
def replacement_image_stream(self):
    ...

Python-Net: shape_type property

Mon, 01 Jan 0001 00:00:00 +0000

shape_type property

The type of the shape that contains the image in the source document (e.g., “Picture” or “Shape”).

Definition:

@property
def shape_type(self):
    ...

Groupdocs API References – CustomImageSavingArgs class

Python-Net: set_output_image_file_name method

set_output_image_file_name

See Also

Python-Net: set_output_stream method

set_output_stream

See Also

Python-Net: set_replacement_image method

set_replacement_image

See Also

Python-Net: image_file_name property

image_file_name property

Definition:

See Also

Python-Net: image_file_name_output property

image_file_name_output property

Definition:

See Also

Python-Net: output_directory property

output_directory property

Definition:

See Also

Python-Net: output_stream property

output_stream property

Definition:

See Also

Python-Net: replacement_image_stream property

replacement_image_stream property

Definition:

See Also

Python-Net: shape_type property

shape_type property

Definition:

See Also