image_watermark property

WatermarkerContext.image_watermark property

Image bytes to be used as a watermark.

@property
def image_watermark(self) -> bytes:
    ...

@image_watermark.setter
def image_watermark(self, value: bytes):
    ...

Remarks

If both WatermarkerContext.image_watermark and WatermarkerContext.text_watermark are specified, text watermark overrides image watermark.

Examples

Shows how to insert watermark image to the document using context.

doc = MY_DIR + 'Document.docx'
watermark_image = IMAGE_DIR + 'Logo.jpg'
watermarker_context = aw.lowcode.WatermarkerContext()
watermarker_context.image_watermark = system_helper.io.File.read_all_bytes(watermark_image)
watermarker_context.image_watermark_options.scale = 50
aw.lowcode.Watermarker.create(watermarker_context).from_file(input=doc).to_file(output=ARTIFACTS_DIR + 'LowCode.WatermarkContextImage.docx').execute()

Shows how to insert watermark image to the document from a stream using context.

watermark_image = IMAGE_DIR + 'Logo.jpg'
with system_helper.io.FileStream(MY_DIR + 'Document.docx', system_helper.io.FileMode.OPEN, system_helper.io.FileAccess.READ) as stream_in:
    watermarker_context = aw.lowcode.WatermarkerContext()
    watermarker_context.image_watermark = system_helper.io.File.read_all_bytes(watermark_image)
    watermarker_context.image_watermark_options.scale = 50
    with system_helper.io.FileStream(ARTIFACTS_DIR + 'LowCode.WatermarkContextImageStream.docx', system_helper.io.FileMode.CREATE, system_helper.io.FileAccess.READ_WRITE) as stream_out:
        aw.lowcode.Watermarker.create(watermarker_context).from_stream(input=stream_in).to_stream(output=stream_out, save_format=aw.SaveFormat.DOCX).execute()

See Also

WatermarkerContext constructor WatermarkerContext.image_watermark_options property