save_images_as_wmf property

RtfSaveOptions.save_images_as_wmf property

When True all images will be saved as WMF.

@property
def save_images_as_wmf(self) -> bool:
    ...

@save_images_as_wmf.setter
def save_images_as_wmf(self, value: bool):
    ...

Remarks

This option might help to avoid WordPad warning messages.

Examples

Shows how to convert all images in a document to the Windows Metafile format as we save the document as an RTF.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Jpeg image:')
image_shape = builder.insert_image(file_name=IMAGE_DIR + 'Logo.jpg')
self.assertEqual(aw.drawing.ImageType.JPEG, image_shape.image_data.image_type)
builder.insert_paragraph()
builder.writeln('Png image:')
image_shape = builder.insert_image(file_name=IMAGE_DIR + 'Transparent background logo.png')
self.assertEqual(aw.drawing.ImageType.PNG, image_shape.image_data.image_type)
# Create an "RtfSaveOptions" object to pass to the document's "Save" method to modify how we save it to an RTF.
rtf_save_options = aw.saving.RtfSaveOptions()
# Set the "SaveImagesAsWmf" property to "true" to convert all images in the document to WMF as we save it to RTF.
# Doing so will help readers such as WordPad to read our document.
# Set the "SaveImagesAsWmf" property to "false" to preserve the original format of all images in the document
# as we save it to RTF. This will preserve the quality of the images at the cost of compatibility with older RTF readers.
rtf_save_options.save_images_as_wmf = save_images_as_wmf
doc.save(file_name=ARTIFACTS_DIR + 'RtfSaveOptions.SaveImagesAsWmf.rtf', save_options=rtf_save_options)
doc = aw.Document(file_name=ARTIFACTS_DIR + 'RtfSaveOptions.SaveImagesAsWmf.rtf')
shapes = doc.get_child_nodes(aw.NodeType.SHAPE, True)
if save_images_as_wmf:
    self.assertEqual(aw.drawing.ImageType.WMF, shapes[0].as_shape().image_data.image_type)
    self.assertEqual(aw.drawing.ImageType.WMF, shapes[1].as_shape().image_data.image_type)
else:
    self.assertEqual(aw.drawing.ImageType.JPEG, shapes[0].as_shape().image_data.image_type)
    self.assertEqual(aw.drawing.ImageType.PNG, shapes[1].as_shape().image_data.image_type)

See Also

RtfSaveOptions.save_format property