MarkdownLoadOptions
Overview
MarkdownLoadOptions is a class in Aspose.Words FOSS for Java.
Inherits from: LoadOptions.
Allows to specify additional options when loading LoadFormat.MARKDOWN document into a Document object.
Edition status of its 65 listed members (a property and its accessor methods are listed separately, overloads once): 65 not yet exercised by a verified example.
This class declares 46 methods for MarkdownLoadOptions objects in Java programs.
Available methods include: LoadOptions, MarkdownLoadOptions, equals, getBaseUri, getConvertMetafilesToPng, getConvertShapeToOfficeMath, getEncoding, getFontSettings, getIgnoreOleData, getImportUnderlineFormatting, getLanguagePreferences, getLoadFormat, and 32 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
| Name | Type | Access | Description |
|---|---|---|---|
preserveEmptyLines | boolean | Read/Write | Gets or sets a boolean value indicating whether to preserve empty lines while load a LoadFormat.MARKDOWN document. |
importUnderlineFormatting | boolean | Read/Write | Gets or sets a boolean value indicating either to recognize a sequence of two plus characters “++” as underline text formatting. |
softLineBreakCharacter | char | Read/Write | Gets or sets a character value representing soft line break. |
loadFormat | int | Read/Write | Specifies the format of the document to be loaded. |
password | String | Read/Write | Gets or sets the password for opening an encrypted document. |
baseUri | String | Read/Write | Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. |
encoding | java.nio.charset.Charset | Read/Write | Gets or sets the encoding. |
resourceLoadingCallback | IResourceLoadingCallback | Read/Write | Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. |
warningCallback | IWarningCallback | Read/Write | Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss. |
progressCallback | IDocumentLoadingCallback | Read/Write | Called during loading a document and accepts data about loading progress. |
preserveIncludePictureField | boolean | Read/Write | Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. |
convertShapeToOfficeMath | boolean | Read/Write | Gets or sets whether to convert shapes with EquationXML to Office Math objects. |
fontSettings | FontSettings | Read/Write | Allows to specify document font settings. |
tempFolder | String | Read/Write | Allows to use temporary files when reading document. |
convertMetafilesToPng | boolean | Read/Write | Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format. |
mswVersion | int | Read/Write | Allows to specify that the document loading process should match a specific MS Word version. |
updateDirtyFields | boolean | Read/Write | Specifies whether to update the fields with the dirty attribute. |
ignoreOleData | boolean | Read/Write | Specifies whether to ignore the OLE data. |
useSystemLcid | boolean | Read/Write | Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins. |
languagePreferences | LanguagePreferences | Read | Gets language preferences that will be used when document is loading. |
recoveryMode | int | Read/Write | Defines how the document should be handled if errors occur during loading. |
Methods
| Signature | Description |
|---|---|
MarkdownLoadOptions() | Initializes a new instance of MarkdownLoadOptions class. |
getPreserveEmptyLines() → boolean | Gets or sets a boolean value indicating whether to preserve empty lines while load a LoadFormat.MARKDOWN document. |
setPreserveEmptyLines(value: boolean) | Sets the preserve empty lines value. |
getImportUnderlineFormatting() → boolean | Gets or sets a boolean value indicating either to recognize a sequence of two plus characters “++” as underline text formatting. |
setImportUnderlineFormatting(value: boolean) | Sets the import underline formatting value. |
getSoftLineBreakCharacter() → char | Gets or sets a character value representing soft line break. |
setSoftLineBreakCharacter(value: char) | Sets the soft line break character 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) → boolean | Determines whether the specified object is equal in value to the current object. |
getLoadFormat() → int | Specifies the format of the document to be loaded. |
setLoadFormat(value: int) | Sets the load format value. |
getPassword() → String | Gets or sets the password for opening an encrypted document. |
setPassword(value: String) | Sets the password value. |
getBaseUri() → String | Gets 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.Charset | Returns the encoding. |
setEncoding(value: java.nio.charset.Charset) | Sets the encoding value. |
getResourceLoadingCallback() → IResourceLoadingCallback | Allows 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() → IWarningCallback | Called 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() → IDocumentLoadingCallback | Called during loading a document and accepts data about loading progress. |
setProgressCallback(value: IDocumentLoadingCallback) | Sets the progress callback value. |
getPreserveIncludePictureField() → boolean | Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. |
setPreserveIncludePictureField(value: boolean) | Sets the preserve include picture field value. |
getConvertShapeToOfficeMath() → boolean | Gets or sets whether to convert shapes with EquationXML to Office Math objects. |
setConvertShapeToOfficeMath(value: boolean) | Sets the convert shape to office math value. |
getFontSettings() → FontSettings | Allows to specify document font settings. |
setFontSettings(value: FontSettings) | Sets the font settings value. |
getTempFolder() → String | Allows to use temporary files when reading document. |
setTempFolder(value: String) | Sets the temp folder value. |
getConvertMetafilesToPng() → boolean | Gets 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() → int | Allows to specify that the document loading process should match a specific MS Word version. |
setMswVersion(value: int) | Sets the msw version value. |
getUpdateDirtyFields() → boolean | Specifies whether to update the fields with the dirty attribute. |
setUpdateDirtyFields(value: boolean) | Sets the update dirty fields value. |
getIgnoreOleData() → boolean | Specifies whether to ignore the OLE data. |
setIgnoreOleData(value: boolean) | Sets the ignore ole data value. |
getUseSystemLcid() → boolean | Gets 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() → LanguagePreferences | Gets language preferences that will be used when document is loading. |
getRecoveryMode() → int | Defines how the document should be handled if errors occur during loading. |
setRecoveryMode(value: int) | Sets the recovery mode value. |