com.aspose.words

Class MetafileRenderingOptions

  • java.lang.Object
    • com.aspose.words.MetafileRenderingOptions
public class MetafileRenderingOptions 
extends java.lang.Object

Allows to specify additional metafile rendering options.

Example:

Shows added a fallback to bitmap rendering and changing type of warnings about unsupported metafile records.
public void handleBinaryRasterWarnings() throws Exception {
    Document doc = new Document(getMyDir() + "WMF with image.docx");

    MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();

    // Set the "EmulateRasterOperations" property to "false" to fall back to bitmap when
    // it encounters a metafile, which will require raster operations to render in the output PDF.
    metafileRenderingOptions.setEmulateRasterOperations(false);

    // Set the "RenderingMode" property to "VectorWithFallback" to try to render every metafile using vector graphics.
    metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);

    // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
    // to modify how that method converts the document to .PDF and applies the configuration
    // in our MetafileRenderingOptions object to the saving operation.
    PdfSaveOptions saveOptions = new PdfSaveOptions();
    saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);

    HandleDocumentWarnings callback = new HandleDocumentWarnings();
    doc.setWarningCallback(callback);

    doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);

    Assert.assertEquals(1, callback.mWarnings.getCount());
    Assert.assertEquals("'R2_XORPEN' binary raster operation is partly supported.",
            callback.mWarnings.get(0).getDescription());
}

/// <summary>
/// Prints and collects formatting loss-related warnings that occur upon saving a document.
/// </summary>
public static class HandleDocumentWarnings implements IWarningCallback {
    public void warning(WarningInfo info) {
        if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) {
            System.out.println("Unsupported operation: " + info.getDescription());
            this.mWarnings.warning(info);
        }
    }

    public WarningInfoCollection mWarnings = new WarningInfoCollection();
}

Constructor Summary
 
Property Getters/Setters Summary
intgetEmfPlusDualRenderingMode()
void
           Gets or sets a value determining how EMF+ Dual metafiles should be rendered. The value of the property is EmfPlusDualRenderingMode integer constant.
booleangetEmulateRasterOperations()
void
           Gets or sets a value determining whether or not the raster operations should be emulated.
intgetRenderingMode()
void
           Gets or sets a value determining how metafile images should be rendered. The value of the property is MetafileRenderingMode integer constant.
booleangetScaleWmfFontsToMetafileSize()
void
           Gets or sets a value determining whether or not to scale fonts in WMF metafile according to metafile size on the page.
booleangetUseEmfEmbeddedToWmf()
void
           Gets or sets a value determining how WMF metafiles with embedded EMF metafiles should be rendered.
 

    • Constructor Detail

      • MetafileRenderingOptions

        public MetafileRenderingOptions()
    • Property Getters/Setters Detail

      • getEmfPlusDualRenderingMode/setEmfPlusDualRenderingMode

        public int getEmfPlusDualRenderingMode() / public void setEmfPlusDualRenderingMode(int value)
        
        Gets or sets a value determining how EMF+ Dual metafiles should be rendered. The value of the property is EmfPlusDualRenderingMode integer constant.

        EMF+ Dual metafiles contains both EMF+ and EMF parts. MS Word and GDI+ always renders EMF+ part. Aspose.Words currently doesn't fully supports all EMF+ records and in some cases rendering result of EMF part looks better then rendering result of EMF+ part.

        This option is used only when metafile is rendered as vector graphics. When metafile is rendered to bitmap, EMF+ part is always used.

        The default value is EmfPlusDualRenderingMode.EMF_PLUS_WITH_FALLBACK.

        Example:

        Shows how to configure Enhanced Windows Metafile-related rendering options when saving to PDF.
        Document doc = new Document(getMyDir() + "EMF.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions saveOptions = new PdfSaveOptions();
        
        // Set the "EmfPlusDualRenderingMode" property to "EmfPlusDualRenderingMode.Emf"
        // to only render the EMF part of an EMF+ dual metafile.
        // Set the "EmfPlusDualRenderingMode" property to "EmfPlusDualRenderingMode.EmfPlus" to
        // to render the EMF+ part of an EMF+ dual metafile.
        // Set the "EmfPlusDualRenderingMode" property to "EmfPlusDualRenderingMode.EmfPlusWithFallback"
        // to render the EMF+ part of an EMF+ dual metafile if all of the EMF+ records are supported.
        // Otherwise, Aspose.Words will render the EMF part.
        saveOptions.getMetafileRenderingOptions().setEmfPlusDualRenderingMode(renderingMode);
        
        // Set the "UseEmfEmbeddedToWmf" property to "true" to render embedded EMF data
        // for metafiles that we can render as vector graphics.
        saveOptions.getMetafileRenderingOptions().setUseEmfEmbeddedToWmf(true);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.RenderMetafile.pdf", saveOptions);
      • getEmulateRasterOperations/setEmulateRasterOperations

        public boolean getEmulateRasterOperations() / public void setEmulateRasterOperations(boolean value)
        
        Gets or sets a value determining whether or not the raster operations should be emulated.

        Specific raster operations could be used in metafiles. They can not be rendered directly to vector graphics. Emulating raster operations requires partial rasterization of the resulting vector graphics which may affect the metafile rendering performance.

        When this value is set to true, Aspose.Words emulates the raster operations. The resulting output maybe partially rasterized and performance might be slower.

        When this value is set to false, Aspose.Words does not emulate the raster operations. When Aspose.Words encounters a raster operation in a metafile it fallbacks to rendering the metafile into a bitmap by using the operating system.

        This option is used only when metafile is rendered as vector graphics.

        The default value is true.

        Example:

        Shows added a fallback to bitmap rendering and changing type of warnings about unsupported metafile records.
        public void handleBinaryRasterWarnings() throws Exception {
            Document doc = new Document(getMyDir() + "WMF with image.docx");
        
            MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
        
            // Set the "EmulateRasterOperations" property to "false" to fall back to bitmap when
            // it encounters a metafile, which will require raster operations to render in the output PDF.
            metafileRenderingOptions.setEmulateRasterOperations(false);
        
            // Set the "RenderingMode" property to "VectorWithFallback" to try to render every metafile using vector graphics.
            metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
        
            // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
            // to modify how that method converts the document to .PDF and applies the configuration
            // in our MetafileRenderingOptions object to the saving operation.
            PdfSaveOptions saveOptions = new PdfSaveOptions();
            saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
        
            HandleDocumentWarnings callback = new HandleDocumentWarnings();
            doc.setWarningCallback(callback);
        
            doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);
        
            Assert.assertEquals(1, callback.mWarnings.getCount());
            Assert.assertEquals("'R2_XORPEN' binary raster operation is partly supported.",
                    callback.mWarnings.get(0).getDescription());
        }
        
        /// <summary>
        /// Prints and collects formatting loss-related warnings that occur upon saving a document.
        /// </summary>
        public static class HandleDocumentWarnings implements IWarningCallback {
            public void warning(WarningInfo info) {
                if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) {
                    System.out.println("Unsupported operation: " + info.getDescription());
                    this.mWarnings.warning(info);
                }
            }
        
            public WarningInfoCollection mWarnings = new WarningInfoCollection();
        }
      • getRenderingMode/setRenderingMode

        public int getRenderingMode() / public void setRenderingMode(int value)
        
        Gets or sets a value determining how metafile images should be rendered. The value of the property is MetafileRenderingMode integer constant.

        The default value depends on the save format. For images it is MetafileRenderingMode.BITMAP. For other formats it is MetafileRenderingMode.VECTOR_WITH_FALLBACK.

        Example:

        Shows added a fallback to bitmap rendering and changing type of warnings about unsupported metafile records.
        public void handleBinaryRasterWarnings() throws Exception {
            Document doc = new Document(getMyDir() + "WMF with image.docx");
        
            MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
        
            // Set the "EmulateRasterOperations" property to "false" to fall back to bitmap when
            // it encounters a metafile, which will require raster operations to render in the output PDF.
            metafileRenderingOptions.setEmulateRasterOperations(false);
        
            // Set the "RenderingMode" property to "VectorWithFallback" to try to render every metafile using vector graphics.
            metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
        
            // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
            // to modify how that method converts the document to .PDF and applies the configuration
            // in our MetafileRenderingOptions object to the saving operation.
            PdfSaveOptions saveOptions = new PdfSaveOptions();
            saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
        
            HandleDocumentWarnings callback = new HandleDocumentWarnings();
            doc.setWarningCallback(callback);
        
            doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);
        
            Assert.assertEquals(1, callback.mWarnings.getCount());
            Assert.assertEquals("'R2_XORPEN' binary raster operation is partly supported.",
                    callback.mWarnings.get(0).getDescription());
        }
        
        /// <summary>
        /// Prints and collects formatting loss-related warnings that occur upon saving a document.
        /// </summary>
        public static class HandleDocumentWarnings implements IWarningCallback {
            public void warning(WarningInfo info) {
                if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) {
                    System.out.println("Unsupported operation: " + info.getDescription());
                    this.mWarnings.warning(info);
                }
            }
        
            public WarningInfoCollection mWarnings = new WarningInfoCollection();
        }
      • getScaleWmfFontsToMetafileSize/setScaleWmfFontsToMetafileSize

        public boolean getScaleWmfFontsToMetafileSize() / public void setScaleWmfFontsToMetafileSize(boolean value)
        
        Gets or sets a value determining whether or not to scale fonts in WMF metafile according to metafile size on the page.

        When WMF metafiles are displayed in MS Word, fonts may be scaled according to actual metafile size on the page.

        When this value is set to true, Aspose.Words emulates font scaling according to metafile size on the page.

        When this value is set to false, Aspose.Words displays the fonts as metafile is rendered to its default size.

        This option is used only when metafile is rendered as vector graphics.

        The default value is true.

        Example:

        Shows how to WMF fonts scaling according to metafile size on the page.
        Document doc = new Document(getMyDir() + "WMF with text.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions saveOptions = new PdfSaveOptions();
        
        // Set the "ScaleWmfFontsToMetafileSize" property to "true" to scale fonts
        // that format text within WMF images according to the size of the metafile on the page.
        // Set the "ScaleWmfFontsToMetafileSize" property to "false" to
        // preserve the default scale of these fonts.
        saveOptions.getMetafileRenderingOptions().setScaleWmfFontsToMetafileSize(scaleWmfFonts);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.FontsScaledToMetafileSize.pdf", saveOptions);
      • getUseEmfEmbeddedToWmf/setUseEmfEmbeddedToWmf

        public boolean getUseEmfEmbeddedToWmf() / public void setUseEmfEmbeddedToWmf(boolean value)
        
        Gets or sets a value determining how WMF metafiles with embedded EMF metafiles should be rendered.

        WMF metafiles could contain embedded EMF data. MS Word in most cases uses embedded EMF data. GDI+ always uses WMF data.

        When this value is set to true, Aspose.Words uses embedded EMF data when rendering.

        When this value is set to false, Aspose.Words uses WMF data when rendering.

        This option is used only when metafile is rendered as vector graphics. When metafile is rendered to bitmap, WMF data is always used.

        The default value is true.

        Example:

        Shows how to configure Enhanced Windows Metafile-related rendering options when saving to PDF.
        Document doc = new Document(getMyDir() + "EMF.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions saveOptions = new PdfSaveOptions();
        
        // Set the "EmfPlusDualRenderingMode" property to "EmfPlusDualRenderingMode.Emf"
        // to only render the EMF part of an EMF+ dual metafile.
        // Set the "EmfPlusDualRenderingMode" property to "EmfPlusDualRenderingMode.EmfPlus" to
        // to render the EMF+ part of an EMF+ dual metafile.
        // Set the "EmfPlusDualRenderingMode" property to "EmfPlusDualRenderingMode.EmfPlusWithFallback"
        // to render the EMF+ part of an EMF+ dual metafile if all of the EMF+ records are supported.
        // Otherwise, Aspose.Words will render the EMF part.
        saveOptions.getMetafileRenderingOptions().setEmfPlusDualRenderingMode(renderingMode);
        
        // Set the "UseEmfEmbeddedToWmf" property to "true" to render embedded EMF data
        // for metafiles that we can render as vector graphics.
        saveOptions.getMetafileRenderingOptions().setUseEmfEmbeddedToWmf(true);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.RenderMetafile.pdf", saveOptions);