com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class SvgSaveOptions



  • public class SvgSaveOptions
    extends UnifiedSaveOptions

    Save options for export to SVG format

    • Constructor Detail

      • SvgSaveOptions

        public SvgSaveOptions()

        Constructor

    • Method Detail

      • getCustomStrategyOfEmbeddedImagesSaving

        public SvgSaveOptions.EmbeddedImagesSavingStrategy getCustomStrategyOfEmbeddedImagesSaving()

        This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced external images files (like embedded BMP or JPEG) embedded into saved SVG. That strategy must process resources and return string that represents desirable URI of saved resource in generated SVG. If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'imageSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code .

        Returns:
        EmbeddedImagesSavingStrategy instance
      • setCustomStrategyOfEmbeddedImagesSaving

        public void setCustomStrategyOfEmbeddedImagesSaving(SvgSaveOptions.EmbeddedImagesSavingStrategy customStrategyOfEmbeddedImagesSaving)

        This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced external images files (like embedded BMP or JPEG) embedded into saved SVG. That strategy must process resources and return string that represents desirable URI of saved resource in generated SVG. If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'imageSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code .

        Parameters:
        customStrategyOfEmbeddedImagesSaving - EmbeddedImagesSavingStrategy instance
      • isTreatTargetFileNameAsDirectory

        public boolean isTreatTargetFileNameAsDirectory()

        This options defines whether will be created target directory (if absent yet) with same name as requested output file instead of requested output file itself. It so, that directory will contain all output SVG-images of pages (like described below). If no, output files of pages other then first one will be created exactly in requested directory as main output file, but will contain in file name suffix _[2...n], that is defined by page number, f.e. if You define output file "C:\AsposeTests\output.svg" and output will contain several svg-files of pages, then files of pages will be created also in directory "C:\AsposeTests\" and have names 'output.svg', 'output_2.svg', 'output_3.svg' etc.

        Returns:
        boolean value
      • setTreatTargetFileNameAsDirectory

        public void setTreatTargetFileNameAsDirectory(boolean treatTargetFileNameAsDirectory)

        This options defines whether will be created target directory (if absent yet) with same name as requested output file instead of requested output file itself. It so, that directory will contain all output SVG-images of pages (like described below). If no, output files of pages other then first one will be created exactly in requested directory as main output file, but will contain in file name suffix _[2...n], that is defined by page number, f.e. if You define output file "C:\AsposeTests\output.svg" and output will contain several svg-files of pages, then files of pages will be created also in directory "C:\AsposeTests\" and have names 'output.svg', 'output_2.svg', 'output_3.svg' etc.

        Parameters:
        treatTargetFileNameAsDirectory - boolean value
      • isCompressOutputToZipArchive

        public boolean isCompressOutputToZipArchive()

        Specifies whether output will be created as one zip-archive. Please refer comment to 'TreatTargetFileNameAsDirectory' options to see rules of naming of svg-files of pages for multipage source document, that are also applied to zipped set of output files.

        Returns:
        boolean value
      • setCompressOutputToZipArchive

        public void setCompressOutputToZipArchive(boolean compressOutputToZipArchive)

        Specifies whether output will be created as one zip-archive. Please refer comment to 'TreatTargetFileNameAsDirectory' options to see rules of naming of svg-files of pages for multipage source document, that are also applied to zipped set of output files.

        Parameters:
        compressOutputToZipArchive - boolean value
      • isScaleToPixels

        public boolean isScaleToPixels()

        Specifies whether to scale the output document from typographic points to pixels.

        Returns:
        boolean value
      • setScaleToPixels

        public void setScaleToPixels(boolean scaleToPixels)

        Specifies whether to scale the output document from typographic points to pixels.

        Parameters:
        scaleToPixels - boolean value