resources_folder property

SvgSaveOptions.resources_folder property

Specifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is None.

@property
def resources_folder(self) -> str:
    ...

@resources_folder.setter
def resources_folder(self, value: str):
    ...

Remarks

Has effect only if SvgSaveOptions.export_embedded_images property is False.

When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. SvgSaveOptions.resources_folder allows you to specify where the images will be saved and SvgSaveOptions.resources_folder_alias allows to specify how the image URIs will be constructed.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use SvgSaveOptions.resources_folder to override this behavior.

If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the SvgSaveOptions.resources_folder property

Examples

Shows how to manipulate and print the URIs of linked resources created while converting a document to .svg.

doc = aw.Document(file_name=MY_DIR + 'Rendering.docx')
options = aw.saving.SvgSaveOptions()
options.save_format = aw.SaveFormat.SVG
options.export_embedded_images = False
options.resources_folder = ARTIFACTS_DIR + 'SvgResourceFolder'
options.resources_folder_alias = ARTIFACTS_DIR + 'SvgResourceFolderAlias'
options.show_page_border = False
options.resource_saving_callback = self.ResourceUriPrinter()
system_helper.io.Directory.create_directory(options.resources_folder_alias)
doc.save(file_name=ARTIFACTS_DIR + 'SvgSaveOptions.SvgResourceFolder.svg', save_options=options)

Shows how to manipulate and print the URIs of linked resources created while converting a document to .svg (ResourceUriPrinter).

class ResourceUriPrinter(aw.saving.IResourceSavingCallback):

    def __init__(self):
        self.m_saved_resource_count = None

    def resource_saving(self, args):
        mSavedResourceCount = 0
        mSavedResourceCount += 1
        print(f'Resource #{mSavedResourceCount} "{args.resource_file_name}"')
        print('\t' + args.resource_file_uri)

See Also

SvgSaveOptions.resource_saving_callback property SvgSaveOptions.resources_folder_alias property