PdfFormatConversionOptions

Overview

PdfFormatConversionOptions is a class in Aspose.Pdf FOSS for Java.

Options controlling PDF/A (and other standard) validation and conversion.

Properties

Name	Type	Access	Description
`default`	`PdfFormatConversionOptions`	Read	Returns a conservative default option set used by simple validation calls.
`logFileName`	`String`	Read	Returns the log file name, or {@code null} if not set.
`logStream`	`OutputStream`	Read	Returns the log output stream, or {@code null} if not set.
`format`	`PdfFormat`	Read	Returns the target PDF format.
`errorAction`	`ConvertErrorAction`	Read	Returns the error action strategy.
`transparencyAction`	`ConvertTransparencyAction`	Read	Returns the transparency handling action.
`embedFonts`	`boolean`	Read	Returns whether fonts should be embedded during conversion.
`subsetFonts`	`boolean`	Read	Returns whether embedded fonts should be subsetted.
`defaultFontName`	`String`	Read	Returns the default font name used when a font cannot be found.
`ignoreResourceFontErrors`	`boolean`	Read	Returns whether resource font errors should be ignored during conversion.
`alignText`	`boolean`	Read	Returns whether text alignment is enabled during conversion.
`softMaskAction`	`ConvertSoftMaskAction`	Read	Returns the soft mask handling action.
`autoTaggingSettings`	`AutoTaggingSettings`	Read	Returns the auto-tagging settings, or {@code null} if not set.
`optimizeFileSize`	`boolean`	Read	Returns whether conversion should attempt to minimize the output file size.
`lowMemoryMode`	`boolean`	Read	Returns whether low-memory conversion mode is enabled.
`transferInfo`	`boolean`	Read	Returns whether document information should be transferred into generated metadata.
`iccProfileFileName`	`String`	Read	Returns the ICC profile file name used for output intent generation.
`fontEmbeddingOptions`	`FontEmbeddingOptions`	Read	Returns font embedding options used by conversion.
`excludeFontsStrategy`	`int`	Read	Returns the bitwise font-exclusion strategy flags.

Methods

Signature	Description
`PdfFormatConversionOptions(format: PdfFormat)`	Creates options for the supplied format using the default delete-on-error behavior.
`PdfFormatConversionOptions(format: PdfFormat, errorAction: ConvertErrorAction)`	Creates options for the supplied format and error action without predefined logging.
`PdfFormatConversionOptions(logFileName: String, format: PdfFormat, errorAction: ConvertErrorAction)`	Creates options that write the conversion log to a file.
`PdfFormatConversionOptions(logStream: OutputStream, format: PdfFormat, errorAction: ConvertErrorAction)`	Creates options that write the conversion log to an output stream.
`getDefault()` → `PdfFormatConversionOptions`	Returns a conservative default option set used by simple validation calls.
`getLogFileName()` → `String`	Returns the log file name, or {@code null} if not set.
`setLogFileName(logFileName: String)`	Sets the log file name.
`getLogStream()` → `OutputStream`	Returns the log output stream, or {@code null} if not set.
`setLogStream(logStream: OutputStream)`	Sets the log output stream.
`getFormat()` → `PdfFormat`	Returns the target PDF format.
`setFormat(format: PdfFormat)`	Sets the target PDF format.
`getErrorAction()` → `ConvertErrorAction`	Returns the error action strategy.
`setErrorAction(errorAction: ConvertErrorAction)`	Sets the error action strategy.
`getTransparencyAction()` → `ConvertTransparencyAction`	Returns the transparency handling action.
`setTransparencyAction(transparencyAction: ConvertTransparencyAction)`	Sets the transparency handling action.
`isEmbedFonts()` → `boolean`	Returns whether fonts should be embedded during conversion.
`setEmbedFonts(embedFonts: boolean)`	Sets whether fonts should be embedded during conversion.
`isSubsetFonts()` → `boolean`	Returns whether embedded fonts should be subsetted.
`setSubsetFonts(subsetFonts: boolean)`	Sets whether embedded fonts should be subsetted.
`getDefaultFontName()` → `String`	Returns the default font name used when a font cannot be found.
`setDefaultFontName(defaultFontName: String)`	Sets the default font name used when a font cannot be found.
`isIgnoreResourceFontErrors()` → `boolean`	Returns whether resource font errors should be ignored during conversion.
`setIgnoreResourceFontErrors(ignoreResourceFontErrors: boolean)`	Sets whether resource font errors should be ignored during conversion.
`isAlignText()` → `boolean`	Returns whether text alignment is enabled during conversion.
`setAlignText(alignText: boolean)`	Sets whether text alignment should be applied during conversion.
`getSoftMaskAction()` → `ConvertSoftMaskAction`	Returns the soft mask handling action.
`setSoftMaskAction(softMaskAction: ConvertSoftMaskAction)`	Sets the soft mask handling action.
`getAutoTaggingSettings()` → `AutoTaggingSettings`	Returns the auto-tagging settings, or {@code null} if not set.
`setAutoTaggingSettings(autoTaggingSettings: AutoTaggingSettings)`	Sets the auto-tagging settings for automatic structure tagging during conversion.
`isOptimizeFileSize()` → `boolean`	Returns whether conversion should attempt to minimize the output file size.
`setOptimizeFileSize(optimizeFileSize: boolean)`	Sets whether conversion should attempt to minimize the output file size.
`isLowMemoryMode()` → `boolean`	Returns whether low-memory conversion mode is enabled.
`setIsLowMemoryMode(lowMemoryMode: boolean)`	Sets whether low-memory conversion mode is enabled.
`isTransferInfo()` → `boolean`	Returns whether document information should be transferred into generated metadata.
`setTransferInfo(transferInfo: boolean)`	Sets whether document information should be transferred into generated metadata.
`getIccProfileFileName()` → `String`	Returns the ICC profile file name used for output intent generation.
`setIccProfileFileName(iccProfileFileName: String)`	Sets the ICC profile file name used for output intent generation.
`getFontEmbeddingOptions()` → `FontEmbeddingOptions`	Returns font embedding options used by conversion.
`setFontEmbeddingOptions(fontEmbeddingOptions: FontEmbeddingOptions)`	Sets font embedding options used by conversion.
`getExcludeFontsStrategy()` → `int`	Returns the bitwise font-exclusion strategy flags.
`setExcludeFontsStrategy(excludeFontsStrategy: int)`	Sets the bitwise font-exclusion strategy flags.

PdfFormatConversionOptions

Overview

Properties

Methods

See Also