public class LoadOptions
Example:
Loads a Microsoft Word document encrypted with a password.Document doc = new Document(getMyDir() + "Document.LoadEncrypted.doc", new LoadOptions("qwerty"));
Constructor Summary |
---|
LoadOptions()
Initializes a new instance of this class with default values. |
LoadOptions(java.lang.Stringpassword)
A shortcut to initialize a new instance of this class with the specified password to load an encrypted document. |
LoadOptions(intloadFormat, java.lang.Stringpassword, java.lang.StringbaseUri)
A shortcut to initialize a new instance of this class with properties set to the specified values. |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAnnotationsAtBlockLevel() | |
void | setAnnotationsAtBlockLevel(booleanvalue) | |
Gets or sets a flag indicating whether cross structure annotation nodes can be added at block/cell/row level. | ||
static boolean | getAnnotationsAtBlockLevelAsDefault() | |
staticvoid | setAnnotationsAtBlockLevelAsDefault(booleanvalue) | |
Gets or sets a default value for the |
||
java.lang.String | getBaseUri() | |
void | setBaseUri(java.lang.Stringvalue) | |
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() | |
void | setConvertShapeToOfficeMath(booleanvalue) | |
Gets or sets whether to convert shapes with EquationXML to Office Math objects. | ||
java.nio.charset.Charset | getEncoding() | |
void | setEncoding(java.nio.charset.Charsetvalue) | |
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() | |
void | setFontSettings(FontSettings value) | |
Allows to specify document font settings. | ||
LanguagePreferences | getLanguagePreferences() | |
Gets language preferences that will be used when document is loading.
|
||
int | getLoadFormat() | |
void | setLoadFormat(intvalue) | |
Specifies the format of the document to be loaded.
Default is |
||
int | getMswVersion() | |
void | setMswVersion(intvalue) | |
Allows to specify that the document loading process should match a specific MS Word version.
Default value is |
||
java.lang.String | getPassword() | |
void | setPassword(java.lang.Stringvalue) | |
Gets or sets the password for opening an encrypted document. Can be null or empty string. Default is null. | ||
boolean | getPreserveIncludePictureField() | |
void | setPreserveIncludePictureField(booleanvalue) | |
Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is false. | ||
IResourceLoadingCallback | getResourceLoadingCallback() | |
void | ||
Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. | ||
boolean | getUpdateDirtyFields() | |
void | setUpdateDirtyFields(booleanvalue) | |
Specifies whether to update the fields with the dirty attribute.
|
||
IWarningCallback | getWarningCallback() | |
void | ||
Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss. |
public LoadOptions()
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");
public LoadOptions(java.lang.String password)
password
- The password to open an encrypted document. Can be null or empty string.Example:
Loads a Microsoft Word document encrypted with a password.Document doc = new Document(getMyDir() + "Document.LoadEncrypted.doc", new LoadOptions("qwerty"));
public LoadOptions(int loadFormat, java.lang.String password, java.lang.String baseUri)
loadFormat
- A password
- The password to open an encrypted document. Can be null or empty string.baseUri
- The string that will be used to resolve relative URIs to absolute. Can be null or empty string.Example:
Shows how to insert the HTML contents from a web page into a new document.// The url of the page to load URL url = new URL("http://www.aspose.com/"); // The easiest way to load our document from the internet is make use of the URLConnection class. URLConnection webClient = url.openConnection(); // Download the bytes from the location referenced by the URL. InputStream inputStream = webClient.getInputStream(); // Convert the input stream to a byte array. int pos; ByteArrayOutputStream bos = new ByteArrayOutputStream(); while ((pos = inputStream.read()) != -1) bos.write(pos); byte[] dataBytes = bos.toByteArray(); // Wrap the bytes representing the document in memory into a stream object. ByteArrayInputStream byteStream = new ByteArrayInputStream(dataBytes); // The baseUri property should be set to ensure any relative img paths are retrieved correctly. LoadOptions options = new LoadOptions(LoadFormat.HTML, "", url.getPath()); // Load the HTML document from stream and pass the LoadOptions object. Document doc = new Document(byteStream, options); // Save the document to disk. // The extension of the filename can be changed to save the document into other formats. e.g PDF, DOCX, ODT, RTF. doc.save(getMyDir() + "\\Artifacts\\Document.HtmlPageFromWebpage.doc");
public boolean getAnnotationsAtBlockLevel() / public void setAnnotationsAtBlockLevel(boolean value)
public static boolean getAnnotationsAtBlockLevelAsDefault() / public static void setAnnotationsAtBlockLevelAsDefault(boolean value)
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");
public boolean getConvertShapeToOfficeMath() / public void setConvertShapeToOfficeMath(boolean value)
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.
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.
public LanguagePreferences getLanguagePreferences()
public int getLoadFormat() / public void setLoadFormat(int value)
It is recommended that you specify the
public int getMswVersion() / public void setMswVersion(int value)
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.
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.
public IResourceLoadingCallback getResourceLoadingCallback() / public void setResourceLoadingCallback(IResourceLoadingCallback value)
public boolean getUpdateDirtyFields() / public void setUpdateDirtyFields(boolean value)
dirty
attribute.
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)