set_image method
Contents
[
Hide
]set_image(image_path, options)
Adds Image watermark into the document.
def set_image(self, image_path: str, options: aspose.words.ImageWatermarkOptions):
...
| Parameter | Type | Description |
|---|---|---|
| image_path | str | Path to the image file that is displayed as a watermark. |
| options | ImageWatermarkOptions | Defines additional options for the image watermark. |
Remarks
If ImageWatermarkOptions is None, the watermark will be set with default options.
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(ArgumentNullException)) | Throws when the path is None. |
set_image(image_stream, options)
Adds Image watermark into the document.
def set_image(self, image_stream: io.BytesIO, options: aspose.words.ImageWatermarkOptions):
...
| Parameter | Type | Description |
|---|---|---|
| image_stream | io.BytesIO | The stream containing the image data that is displayed as a watermark. |
| options | ImageWatermarkOptions | Defines additional options for the image watermark. |
Remarks
If ImageWatermarkOptions is None, the watermark will be set with default options.
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(ArgumentNullException)) | Throws when the path is None. |
Examples
Shows how to create a watermark from an image stream.
doc = aw.Document()
# Modify the image watermark's appearance with an ImageWatermarkOptions object,
# then pass it while creating a watermark from an image file.
image_watermark_options = aw.ImageWatermarkOptions()
image_watermark_options.scale = 5
with system_helper.io.FileStream(IMAGE_DIR + 'Logo.jpg', system_helper.io.FileMode.OPEN, system_helper.io.FileAccess.READ) as image_stream:
doc.watermark.set_image(image_stream=image_stream, options=image_watermark_options)
doc.save(file_name=ARTIFACTS_DIR + 'Document.ImageWatermarkStream.docx')
See Also
- module aspose.words
- class Watermark