com.aspose.words

Class PclSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.FixedPageSaveOptions

com.aspose.words.PclSaveOptions

public class PclSaveOptions
extends FixedPageSaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.PCL format.

To learn more, visit the Specify Save Options documentation article.

Examples:

Shows how to rasterize complex elements while saving a document to PCL.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setSaveFormat(SaveFormat.PCL);
 saveOptions.setRasterizeTransformedElements(true);

 doc.save(getArtifactsDir() + "PclSaveOptions.RasterizeElements.pcl", saveOptions);
 
 

Method Summary

Modifier and Type	Method and Description
void	addPrinterFont(java.lang.String fontFullName, java.lang.String fontPclName) Adds information about font that is uploaded to the printer by manufacturer.
java.lang.String	getFallbackFontName() Name of the font that will be used if no expected font is found in printer and built-in fonts collections.
boolean	getRasterizeTransformedElements() Gets a value determining whether or not complex transformed elements should be rasterized before saving to PCL document.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
void	setFallbackFontName(java.lang.String value) Name of the font that will be used if no expected font is found in printer and built-in fonts collections.
void	setRasterizeTransformedElements(boolean value) Sets a value determining whether or not complex transformed elements should be rasterized before saving to PCL document.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.

Methods inherited from class com.aspose.words.FixedPageSaveOptions

assertValidIdPrefix, equals, getColorMode, getJpegQuality, getMetafileRenderingOptions, getNumeralFormat, getOptimizeOutput, getPageSavingCallback, getPageSet, isValidIdPrefix, setColorMode, setJpegQuality, setMetafileRenderingOptions, setNumeralFormat, setOptimizeOutput, setPageSavingCallback, setPageSet

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getCustomTimeZoneInfo, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateAmbiguousTextFont, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setCustomTimeZoneInfo, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateAmbiguousTextFont, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PCL.

Examples:

Shows how to rasterize complex elements while saving a document to PCL.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setSaveFormat(SaveFormat.PCL);
 saveOptions.setRasterizeTransformedElements(true);

 doc.save(getArtifactsDir() + "PclSaveOptions.RasterizeElements.pcl", saveOptions);
 
 

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PCL.

Examples:

Shows how to rasterize complex elements while saving a document to PCL.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setSaveFormat(SaveFormat.PCL);
 saveOptions.setRasterizeTransformedElements(true);

 doc.save(getArtifactsDir() + "PclSaveOptions.RasterizeElements.pcl", saveOptions);
 
 

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getRasterizeTransformedElements

public boolean getRasterizeTransformedElements()

Gets a value determining whether or not complex transformed elements should be rasterized before saving to PCL document. Default is true.

Remarks:

PCL doesn't support some kind of transformations that are used by Aspose Words. E.g. rotated, skewed images and texture brushes. To properly render such elements rasterization process is used, i.e. saving to image and clipping. This process can take additional time and memory. If flag is set to false, some content in output may be different as compared with the source document.

Examples:

Shows how to rasterize complex elements while saving a document to PCL.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setSaveFormat(SaveFormat.PCL);
 saveOptions.setRasterizeTransformedElements(true);

 doc.save(getArtifactsDir() + "PclSaveOptions.RasterizeElements.pcl", saveOptions);
 
 

Returns:

A value determining whether or not complex transformed elements should be rasterized before saving to PCL document.

setRasterizeTransformedElements

public void setRasterizeTransformedElements(boolean value)

Sets a value determining whether or not complex transformed elements should be rasterized before saving to PCL document. Default is true.

Remarks:

PCL doesn't support some kind of transformations that are used by Aspose Words. E.g. rotated, skewed images and texture brushes. To properly render such elements rasterization process is used, i.e. saving to image and clipping. This process can take additional time and memory. If flag is set to false, some content in output may be different as compared with the source document.

Examples:

Shows how to rasterize complex elements while saving a document to PCL.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setSaveFormat(SaveFormat.PCL);
 saveOptions.setRasterizeTransformedElements(true);

 doc.save(getArtifactsDir() + "PclSaveOptions.RasterizeElements.pcl", saveOptions);
 
 

Parameters:

value - A value determining whether or not complex transformed elements should be rasterized before saving to PCL document.

addPrinterFont

public void addPrinterFont(java.lang.String fontFullName,
                           java.lang.String fontPclName)

Adds information about font that is uploaded to the printer by manufacturer.

Remarks:

There are 52 fonts that are to be built in any printer according to Pcl specification. However manufactures can add some other fonts to their devices.

Examples:

Shows how to get a printer to substitute all instances of a specific font with a different font.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.getFont().setName("Courier");
 builder.write("Hello world!");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.addPrinterFont("Courier New", "Courier");

 // When printing this document, the printer will use the "Courier New" font
 // to access places where our document used the "Courier" font.
 doc.save(getArtifactsDir() + "PclSaveOptions.AddPrinterFont.pcl", saveOptions);
 
 

Parameters:

fontFullName - Full name of the font (e.g. "Times New Roman Bold Italic").

fontPclName - Name of the font that is used in Pcl document.

getFallbackFontName

public java.lang.String getFallbackFontName()

Name of the font that will be used if no expected font is found in printer and built-in fonts collections.

Remarks:

If no fallback is found, a warning is generated and "Arial" font is used.

Examples:

Shows how to declare a font that a printer will apply to printed text as a substitute should its original font be unavailable.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.getFont().setName("Non-existent font");
 builder.write("Hello world!");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setFallbackFontName("Times New Roman");

 // This document will instruct the printer to apply "Times New Roman" to the text with the missing font.
 // Should "Times New Roman" also be unavailable, the printer will default to the "Arial" font.
 doc.save(getArtifactsDir() + "PclSaveOptions.SetPrinterFont.pcl", saveOptions);
 
 

Returns:

The corresponding String value.

setFallbackFontName

public void setFallbackFontName(java.lang.String value)

Name of the font that will be used if no expected font is found in printer and built-in fonts collections.

Remarks:

If no fallback is found, a warning is generated and "Arial" font is used.

Examples:

Shows how to declare a font that a printer will apply to printed text as a substitute should its original font be unavailable.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.getFont().setName("Non-existent font");
 builder.write("Hello world!");

 PclSaveOptions saveOptions = new PclSaveOptions();
 saveOptions.setFallbackFontName("Times New Roman");

 // This document will instruct the printer to apply "Times New Roman" to the text with the missing font.
 // Should "Times New Roman" also be unavailable, the printer will default to the "Arial" font.
 doc.save(getArtifactsDir() + "PclSaveOptions.SetPrinterFont.pcl", saveOptions);
 
 

Parameters:

value - The corresponding String value.