java.lang.ObjectLoadOptions
com.aspose.words.RtfLoadOptions
public class RtfLoadOptions
Constructor Summary |
---|
RtfLoadOptions()
Initializes a new instance of this class with default values. |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAllowTrailingWhitespaceForListItems() | → inherited from LoadOptions |
void | setAllowTrailingWhitespaceForListItems(boolean value) | |
Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true. | ||
boolean | getAnnotationsAtBlockLevel() | → inherited from LoadOptions |
void | setAnnotationsAtBlockLevel(boolean value) | |
Gets or sets a flag indicating whether cross structure annotation nodes can be added at block/cell/row level. | ||
java.lang.String | getBaseUri() | → inherited from LoadOptions |
void | setBaseUri(java.lang.String value) | |
Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be null or empty string. Default is null. | ||
boolean | getConvertShapeToOfficeMath() | → inherited from LoadOptions |
void | setConvertShapeToOfficeMath(boolean value) | |
Gets or sets whether to convert shapes with EquationXML to Office Math objects. | ||
java.nio.charset.Charset | getEncoding() | → inherited from LoadOptions |
void | setEncoding(java.nio.charset.Charset value) | |
Gets or sets the encoding that will be used to load an HTML or TXT document if the encoding is not specified in HTML/TXT. Can be null. Default is null. | ||
FontSettings | getFontSettings() | → inherited from LoadOptions |
void | setFontSettings(FontSettings value) | |
Allows to specify document font settings. | ||
LanguagePreferences | getLanguagePreferences() | → inherited from LoadOptions |
Gets language preferences that will be used when document is loading. | ||
int | getLoadFormat() | → inherited from LoadOptions |
void | setLoadFormat(int value) | |
Specifies the format of the document to be loaded.
Default is |
||
int | getMswVersion() | → inherited from LoadOptions |
void | setMswVersion(int value) | |
Allows to specify that the document loading process should match a specific MS Word version.
Default value is |
||
java.lang.String | getPassword() | → inherited from LoadOptions |
void | setPassword(java.lang.String value) | |
Gets or sets the password for opening an encrypted document. Can be null or empty string. Default is null. | ||
boolean | getPreserveIncludePictureField() | → inherited from LoadOptions |
void | setPreserveIncludePictureField(boolean value) | |
Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is false. | ||
boolean | getRecognizeUtf8Text() | |
void | setRecognizeUtf8Text(boolean value) | |
When set to true, |
||
IResourceLoadingCallback | getResourceLoadingCallback() | → inherited from LoadOptions |
void | setResourceLoadingCallback(IResourceLoadingCallback value) | |
Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. | ||
boolean | getUpdateDirtyFields() | → inherited from LoadOptions |
void | setUpdateDirtyFields(boolean value) | |
Specifies whether to update the fields with the dirty attribute.
|
||
IWarningCallback | getWarningCallback() | → inherited from LoadOptions |
void | setWarningCallback(IWarningCallback value) | |
Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss. |
Constructor Detail |
---|
public RtfLoadOptions()
Property Getters/Setters Detail |
---|
getAllowTrailingWhitespaceForListItems/setAllowTrailingWhitespaceForListItems | → inherited from LoadOptions |
public boolean getAllowTrailingWhitespaceForListItems() / public void setAllowTrailingWhitespaceForListItems(boolean value) |
This property is used only when loading plain text documents.
If set to true, lists recognition algorithm allows list numbers to end with either dot or whitespace character.
If this option is set to false then the list item is only recognized as such if the leading number is ending with dot "." symbol.
getAnnotationsAtBlockLevel/setAnnotationsAtBlockLevel | → inherited from LoadOptions |
public boolean getAnnotationsAtBlockLevel() / public void setAnnotationsAtBlockLevel(boolean value) |
getBaseUri/setBaseUri | → inherited from LoadOptions |
public java.lang.String getBaseUri() / public void setBaseUri(java.lang.String value) |
This property is used to resolve relative URIs into absolute in the following cases:
Example:
Opens an HTML document with images from a stream using a base URI.// We are opening this HTML file: // <html> // <body> // <p>Simple file.</p> // <p><img src="Aspose.Words.gif" width="80" height="60"></p> // </body> // </html> String fileName = getMyDir() + "Document.OpenFromStreamWithBaseUri.html"; // Open the stream. InputStream stream = new FileInputStream(fileName); // Open the document. Note the Document constructor detects HTML format automatically. // Pass the URI of the base folder so any images with relative URIs in the HTML document can be found. LoadOptions loadOptions = new LoadOptions(); loadOptions.setBaseUri(getMyDir()); Document doc = new Document(stream, loadOptions); // You can close the stream now, it is no longer needed because the document is in memory. stream.close(); // Save in the DOC format. doc.save(getMyDir() + "\\Artifacts\\Document.OpenFromStreamWithBaseUri.doc");
getConvertShapeToOfficeMath/setConvertShapeToOfficeMath | → inherited from LoadOptions |
public boolean getConvertShapeToOfficeMath() / public void setConvertShapeToOfficeMath(boolean value) |
getEncoding/setEncoding | → inherited from LoadOptions |
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value) |
This property is used only when loading HTML or TXT documents.
If encoding is not specified in HTML/TXT and this property is null
, then the system will try to
automatically detect the encoding.
getFontSettings/setFontSettings | → inherited from LoadOptions |
public FontSettings getFontSettings() / public void setFontSettings(FontSettings value) |
When loading some formats, Aspose.Words may require to resolve the fonts. For example, when loading HTML documents Aspose.Words may resolve the fonts to perform font fallback.
If set to null, default static font settings
The default value is null.
getLanguagePreferences | → inherited from LoadOptions |
public LanguagePreferences getLanguagePreferences() |
getLoadFormat/setLoadFormat | → inherited from LoadOptions |
public int getLoadFormat() / public void setLoadFormat(int value) |
It is recommended that you specify the
getMswVersion/setMswVersion | → inherited from LoadOptions |
public int getMswVersion() / public void setMswVersion(int value) |
getPassword/setPassword | → inherited from LoadOptions |
public java.lang.String getPassword() / public void setPassword(java.lang.String value) |
You need to know the password to open an encrypted document. If the document is not encrypted, set this to null or empty string.
getPreserveIncludePictureField/setPreserveIncludePictureField | → inherited from LoadOptions |
public boolean getPreserveIncludePictureField() / public void setPreserveIncludePictureField(boolean value) |
By default, the INCLUDEPICTURE field is converted into a shape object. You can override that if you need the field to be preserved, for example, if you wish to update it programmatically. Note however that this approach is not common for Aspose.Words. Use it on your own risk.
One of the possible use cases may be using a MERGEFIELD as a child field to dynamically change the source path of the picture. In this case you need the INCLUDEPICTURE to be preserved in the model.
getRecognizeUtf8Text/setRecognizeUtf8Text | |
public boolean getRecognizeUtf8Text() / public void setRecognizeUtf8Text(boolean value) |
When set to true,
getResourceLoadingCallback/setResourceLoadingCallback | → inherited from LoadOptions |
public IResourceLoadingCallback getResourceLoadingCallback() / public void setResourceLoadingCallback(IResourceLoadingCallback value) |
getUpdateDirtyFields/setUpdateDirtyFields | → inherited from LoadOptions |
public boolean getUpdateDirtyFields() / public void setUpdateDirtyFields(boolean value) |
dirty
attribute.
getWarningCallback/setWarningCallback | → inherited from LoadOptions |
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value) |