PdfLoadOptions

PdfLoadOptions

Overview

PdfLoadOptions is a class in Aspose.Words FOSS for Java. Inherits from: LoadOptions.

Allows to specify additional options when loading Pdf document into a Document object.

Edition status of its 64 listed members (a property and its accessor methods are listed separately, overloads once): 64 not yet exercised by a verified example.

This class declares 45 methods for PdfLoadOptions objects in Java programs. Available methods include: LoadOptions, equals, getBaseUri, getConvertMetafilesToPng, getConvertShapeToOfficeMath, getEncoding, getFontSettings, getIgnoreOleData, getLanguagePreferences, getLoadFormat, getMswVersion, getPageCount, and 31 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: baseUri, convertMetafilesToPng, convertShapeToOfficeMath, encoding, fontSettings, ignoreOleData, and 15 more.

Properties

NameTypeAccessDescription
pageIndexintRead/WriteGets or sets the 0-based index of the first page to read.
pageCountintRead/WriteGets or sets the number of pages to read.
skipPdfImagesbooleanRead/WriteGets or sets the flag indicating whether images must be skipped while loading PDF document.
loadFormatintRead/WriteSpecifies the format of the document to be loaded.
passwordStringRead/WriteGets or sets the password for opening an encrypted document.
baseUriStringRead/WriteGets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required.
encodingjava.nio.charset.CharsetRead/WriteGets or sets the encoding.
resourceLoadingCallbackIResourceLoadingCallbackRead/WriteAllows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
warningCallbackIWarningCallbackRead/WriteCalled during a load operation, when an issue is detected that might result in data or formatting fidelity loss.
progressCallbackIDocumentLoadingCallbackRead/WriteCalled during loading a document and accepts data about loading progress.
preserveIncludePictureFieldbooleanRead/WriteGets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats.
convertShapeToOfficeMathbooleanRead/WriteGets or sets whether to convert shapes with EquationXML to Office Math objects.
fontSettingsFontSettingsRead/WriteAllows to specify document font settings.
tempFolderStringRead/WriteAllows to use temporary files when reading document.
convertMetafilesToPngbooleanRead/WriteGets or sets whether to convert metafile(Wmf or Emf) images to Png image format.
mswVersionintRead/WriteAllows to specify that the document loading process should match a specific MS Word version.
updateDirtyFieldsbooleanRead/WriteSpecifies whether to update the fields with the dirty attribute.
ignoreOleDatabooleanRead/WriteSpecifies whether to ignore the OLE data.
useSystemLcidbooleanRead/WriteGets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins.
languagePreferencesLanguagePreferencesReadGets language preferences that will be used when document is loading.
recoveryModeintRead/WriteDefines how the document should be handled if errors occur during loading.

Methods

SignatureDescription
getPageIndex() → intGets or sets the 0-based index of the first page to read.
setPageIndex(value: int)Sets the page index value.
getPageCount() → intGets or sets the number of pages to read.
setPageCount(value: int)Sets the page count value.
getSkipPdfImages() → booleanGets or sets the flag indicating whether images must be skipped while loading PDF document.
setSkipPdfImages(value: boolean)Sets the skip pdf images value.
LoadOptions()Initializes a new instance of this class with default values.
LoadOptions(password: String)A shortcut to initialize a new instance of this class with the specified password to load an encrypted document.
LoadOptions(loadFormat: int, password: String, baseUri: String)A shortcut to initialize a new instance of this class with properties set to the specified values.
equals(obj: Object) → booleanDetermines whether the specified object is equal in value to the current object.
getLoadFormat() → intSpecifies the format of the document to be loaded.
setLoadFormat(value: int)Sets the load format value.
getPassword() → StringGets or sets the password for opening an encrypted document.
setPassword(value: String)Sets the password value.
getBaseUri() → StringGets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required.
setBaseUri(value: String)Sets the base uri value.
getEncoding() → java.nio.charset.CharsetReturns the encoding.
setEncoding(value: java.nio.charset.Charset)Sets the encoding value.
getResourceLoadingCallback() → IResourceLoadingCallbackAllows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
setResourceLoadingCallback(value: IResourceLoadingCallback)Sets the resource loading callback value.
getWarningCallback() → IWarningCallbackCalled during a load operation, when an issue is detected that might result in data or formatting fidelity loss.
setWarningCallback(value: IWarningCallback)Sets the warning callback value.
getProgressCallback() → IDocumentLoadingCallbackCalled during loading a document and accepts data about loading progress.
setProgressCallback(value: IDocumentLoadingCallback)Sets the progress callback value.
getPreserveIncludePictureField() → booleanGets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats.
setPreserveIncludePictureField(value: boolean)Sets the preserve include picture field value.
getConvertShapeToOfficeMath() → booleanGets or sets whether to convert shapes with EquationXML to Office Math objects.
setConvertShapeToOfficeMath(value: boolean)Sets the convert shape to office math value.
getFontSettings() → FontSettingsAllows to specify document font settings.
setFontSettings(value: FontSettings)Sets the font settings value.
getTempFolder() → StringAllows to use temporary files when reading document.
setTempFolder(value: String)Sets the temp folder value.
getConvertMetafilesToPng() → booleanGets or sets whether to convert metafile(Wmf or Emf) images to Png image format.
setConvertMetafilesToPng(value: boolean)Sets the convert metafiles to png value.
getMswVersion() → intAllows to specify that the document loading process should match a specific MS Word version.
setMswVersion(value: int)Sets the msw version value.
getUpdateDirtyFields() → booleanSpecifies whether to update the fields with the dirty attribute.
setUpdateDirtyFields(value: boolean)Sets the update dirty fields value.
getIgnoreOleData() → booleanSpecifies whether to ignore the OLE data.
setIgnoreOleData(value: boolean)Sets the ignore ole data value.
getUseSystemLcid() → booleanGets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins.
setUseSystemLcid(value: boolean)Sets the use system lcid value.
getLanguagePreferences() → LanguagePreferencesGets language preferences that will be used when document is loading.
getRecoveryMode() → intDefines how the document should be handled if errors occur during loading.
setRecoveryMode(value: int)Sets the recovery mode value.

See Also