RenderingOptions

Inheritance: java.lang.Object, com.aspose.pdf.RenderingOptions

public final class RenderingOptions extends Object

Represents rendering options

Constructors

Constructor	Description
RenderingOptions	Initializes new instance of the {@code RenderingOptions} object.

Methods

Method	Description
getAnalyzeFonts	Replaces fonts as necessary to ensure all characters in the text can be displayed. The font substitution algorithm follows these steps: 1. If the user explicitly sets the DefaultFontName property, check if the specified font can display the desired characters. 2. If no user-defined font is set, search through fonts added via the {@code FontRepository.Sources}. 3. Analyze the text to identify its alphabet or script and suggest font names accordingly. Attempt to locate and use these fonts from the system. 4. As a fallback, search the system for any font capable of displaying the required characters.
getBarcodeOptimization	Gets barcode optimization mode.
getConvertFontsToUnicodeTTF	Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text.
getDefaultFontName	Gets/sets the default name of font used to substitute of missing fonts.
getHeightExtraUnits	Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.
getIgnoreResourceFontErrors	Gets or sets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default
getInterpolationHighQuality	Gets or sets high quality mode for interpolation.
getMaxFontsCacheSize	Maximum count of fonts in fonts cache. Default value is 10.
getMaxSymbolsCacheSize	Maximum count of symbols in symbol cache. Default value is 100.
getOptimizeDimensions	Gets or sets optimize dimensions mode.
getScaleImagesToFitPageWidth	Gets or sets a values used to scale all images on the page to fit page’s width.
getSystemFontsNativeRendering	Gets a mode where system fonts are rendered natively
getUseFontHinting	Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document.
getUseNewImagingEngine	Gets a flag determines whether new imaging engine is used or not.
getWidthExtraUnits	Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.
isTryToSkipDocumentErrors	Gets a value used to skip errors during processing pdf file
setAnalyzeFonts	Replaces fonts as necessary to ensure all characters in the text can be displayed. The font substitution algorithm follows these steps: 1. If the user explicitly sets the DefaultFontName property, check if the specified font can display the desired characters. 2. If no user-defined font is set, search through fonts added via the {@code FontRepository.Sources}. 3. Analyze the text to identify its alphabet or script and suggest font names accordingly. Attempt to locate and use these fonts from the system. 4. As a fallback, search the system for any font capable of displaying the required characters.
setBarcodeOptimization	Sets barcode optimization mode.
setConvertFontsToUnicodeTTF	Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text.
setDefaultFontName	Gets/sets the default name of font used to substitute of missing fonts.
setHeightExtraUnits	Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.
setIgnoreResourceFontErrors	Gets or sets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default
setInterpolationHighQuality	Gets or sets high quality mode for interpolation.
setMaxFontsCacheSize	Maximum count of fonts in fonts cache. Default value is 10.
setMaxSymbolsCacheSize	Maximum count of symbols in symbol cache. Default value is 100.
setOptimizeDimensions	Gets or sets optimize dimensions mode.
setScaleImagesToFitPageWidth	Gets or sets a values used to scale all images on the page to fit page’s width.
setSystemFontsNativeRendering	Sets a mode where system fonts are rendered natively
setTryToSkipDocumentErrors	Sets a value used to skip errors during processing pdf file
setUseFontHinting	Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document.
setUseNewImagingEngine	Sets a flag determines whether new imaging engine is used or not.
setWidthExtraUnits	Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

RenderingOptions

public RenderingOptions()

Initializes new instance of the {@code RenderingOptions} object.

getAnalyzeFonts

public final boolean getAnalyzeFonts()

Replaces fonts as necessary to ensure all characters in the text can be displayed. The font substitution algorithm follows these steps: 1. If the user explicitly sets the DefaultFontName property, check if the specified font can display the desired characters. 2. If no user-defined font is set, search through fonts added via the {@code FontRepository.Sources}. 3. Analyze the text to identify its alphabet or script and suggest font names accordingly. Attempt to locate and use these fonts from the system. 4. As a fallback, search the system for any font capable of displaying the required characters.

Returns: boolean value

getBarcodeOptimization

public boolean getBarcodeOptimization()

Gets barcode optimization mode.

Returns: boolean value

getConvertFontsToUnicodeTTF

public boolean getConvertFontsToUnicodeTTF()

Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text.

Returns: boolean value

getDefaultFontName

public final String getDefaultFontName()

Gets/sets the default name of font used to substitute of missing fonts.

Returns: String value

getHeightExtraUnits

public final float getHeightExtraUnits()

Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

Returns: float value

getIgnoreResourceFontErrors

public final boolean getIgnoreResourceFontErrors()

Gets or sets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default

Returns: boolean value

getInterpolationHighQuality

public boolean getInterpolationHighQuality()

Gets or sets high quality mode for interpolation.

Returns: boolean value

getMaxFontsCacheSize

public int getMaxFontsCacheSize()

Maximum count of fonts in fonts cache. Default value is 10.

Returns: int value

getMaxSymbolsCacheSize

public int getMaxSymbolsCacheSize()

Maximum count of symbols in symbol cache. Default value is 100.

Returns: int value

getOptimizeDimensions

public final boolean getOptimizeDimensions()

Gets or sets optimize dimensions mode.

Returns: boolean value

getScaleImagesToFitPageWidth

@Deprecated public final boolean getScaleImagesToFitPageWidth()

Gets or sets a values used to scale all images on the page to fit page’s width.

Returns: boolean value @deprecated ScaleImagesToFitPageWidth is deprecated.

getSystemFontsNativeRendering

public boolean getSystemFontsNativeRendering()

Gets a mode where system fonts are rendered natively

Returns: boolean value

getUseFontHinting

public boolean getUseFontHinting()

Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document.

Returns: boolean value

getUseNewImagingEngine

@Deprecated public boolean getUseNewImagingEngine()

Gets a flag determines whether new imaging engine is used or not.

Returns: boolean value @deprecated UseNewImagingEngine is deprecated

getWidthExtraUnits

public float getWidthExtraUnits()

Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

Returns: float value

isTryToSkipDocumentErrors

public boolean isTryToSkipDocumentErrors()

Gets a value used to skip errors during processing pdf file

Returns: boolean value

setAnalyzeFonts

public final void setAnalyzeFonts(boolean value)

Parameters:

Parameter	Type	Description
value		boolean value

setBarcodeOptimization

public void setBarcodeOptimization(boolean value)

Sets barcode optimization mode.

Parameters:

Parameter	Type	Description
value		boolean value

setConvertFontsToUnicodeTTF

public void setConvertFontsToUnicodeTTF(boolean value)

Parameters:

Parameter	Type	Description
value		boolean value

setDefaultFontName

Gets/sets the default name of font used to substitute of missing fonts.

setHeightExtraUnits

public final void setHeightExtraUnits(float value)

Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

Parameters:

Parameter	Type	Description
value		float value

setIgnoreResourceFontErrors

public final void setIgnoreResourceFontErrors(boolean value)

Parameters:

Parameter	Type	Description
value		boolean value

setInterpolationHighQuality

public void setInterpolationHighQuality(boolean value)

Gets or sets high quality mode for interpolation.

Parameters:

Parameter	Type	Description
value		boolean value

setMaxFontsCacheSize

public void setMaxFontsCacheSize(int value)

Maximum count of fonts in fonts cache. Default value is 10.

Parameters:

Parameter	Type	Description
value		int value

setMaxSymbolsCacheSize

public void setMaxSymbolsCacheSize(int value)

Maximum count of symbols in symbol cache. Default value is 100.

Parameters:

Parameter	Type	Description
value		int value

setOptimizeDimensions

public final void setOptimizeDimensions(boolean value)

Gets or sets optimize dimensions mode.

Parameters:

Parameter	Type	Description
value		boolean value

setScaleImagesToFitPageWidth

@Deprecated public final void setScaleImagesToFitPageWidth(boolean value)

Gets or sets a values used to scale all images on the page to fit page’s width.

Parameters:

Parameter	Type	Description
value		boolean value @deprecated ScaleImagesToFitPageWidth is deprecated.

setSystemFontsNativeRendering

public void setSystemFontsNativeRendering(boolean value)

Sets a mode where system fonts are rendered natively

Parameters:

Parameter	Type	Description
value		boolean value

setTryToSkipDocumentErrors

public void setTryToSkipDocumentErrors(boolean value)

Sets a value used to skip errors during processing pdf file

Parameters:

Parameter	Type	Description
value		boolean value

setUseFontHinting

public void setUseFontHinting(boolean value)

Parameters:

Parameter	Type	Description
value		boolean value

setUseNewImagingEngine

@Deprecated public void setUseNewImagingEngine(boolean value)

Sets a flag determines whether new imaging engine is used or not.

Parameters:

Parameter	Type	Description
value		boolean value @deprecated UseNewImagingEngine is deprecated

setWidthExtraUnits

public void setWidthExtraUnits(float value)

Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

Parameters:

Parameter	Type	Description
value		float value

RegistrationMarkAnnotation RenderModeType