LoadFormat (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.LoadFormat

public class LoadFormat
extends java.lang.Object

Indicates the format of the document that is to be loaded.

Examples:

Shows how to specify a base URI when opening an html document.

 
 // Suppose we want to load an .html document that contains an image linked by a relative URI
 // while the image is in a different location. In that case, we will need to resolve the relative URI into an absolute one.
 // We can provide a base URI using an HtmlLoadOptions object.
 HtmlLoadOptions loadOptions = new HtmlLoadOptions(LoadFormat.HTML, "", getImageDir());

 Assert.assertEquals(LoadFormat.HTML, loadOptions.getLoadFormat());

 Document doc = new Document(getMyDir() + "Missing image.html", loadOptions);

 // While the image was broken in the input .html, our custom base URI helped us repair the link.
 Shape imageShape = (Shape) doc.getChildNodes(NodeType.SHAPE, true).get(0);
 Assert.assertTrue(imageShape.isImage());

 // This output document will display the image that was missing.
 doc.save(getArtifactsDir() + "HtmlLoadOptions.BaseUri.docx");

Shows how to insert the HTML contents from a web page into a new document.

 
 URL url = new URL("https://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);

 doc.save(getArtifactsDir() + "Document.InsertHtmlFromWebPage.docx");

Shows how to use the FileFormatUtil methods to detect the format of a document.

 
 // Load a document from a file that is missing a file extension, and then detect its file format.
 FileInputStream docStream = new FileInputStream(getMyDir() + "Word document with missing file extension");

 FileFormatInfo info = FileFormatUtil.detectFileFormat(docStream);

 int loadFormat = info.getLoadFormat();

 Assert.assertEquals(LoadFormat.DOC, loadFormat);

 // Below are two methods of converting a LoadFormat to its corresponding SaveFormat.
 // 1 -  Get the file extension string for the LoadFormat, then get the corresponding SaveFormat from that string:
 String fileExtension = FileFormatUtil.loadFormatToExtension(loadFormat);

 int saveFormat = FileFormatUtil.extensionToSaveFormat(fileExtension);

 // 2 -  Convert the LoadFormat directly to its SaveFormat:
 saveFormat = FileFormatUtil.loadFormatToSaveFormat(loadFormat);

 // Load a document from the stream, and then save it to the automatically detected file extension.
 Document doc = new Document(docStream);

 Assert.assertEquals(".doc", FileFormatUtil.saveFormatToExtension(saveFormat));

 doc.save(getArtifactsDir() + "File.SaveToDetectedFileFormat" + FileFormatUtil.saveFormatToExtension(saveFormat));

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUTO` Instructs Aspose.Words to recognize the format automatically.
`static int`	`AZW_3` AZW3 format.
`static int`	`CHM` CHM (Compiled HTML Help) format.
`static int`	`DOC` Microsoft Word 95 or Word 97 - 2003 Document.
`static int`	`DOC_PRE_WORD_60` The document is in pre-Word 95 format.
`static int`	`DOCM` Office Open XML WordprocessingML Macro-Enabled Document.
`static int`	`DOCX` Office Open XML WordprocessingML Document (macro-free).
`static int`	`DOT` Microsoft Word 95 or Word 97 - 2003 Template.
`static int`	`DOTM` Office Open XML WordprocessingML Macro-Enabled Template.
`static int`	`DOTX` Office Open XML WordprocessingML Template (macro-free).
`static int`	`EPUB` EPUB format.
`static int`	`FLAT_OPC` Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.
`static int`	`FLAT_OPC_MACRO_ENABLED` Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package.
`static int`	`FLAT_OPC_TEMPLATE` Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package.
`static int`	`FLAT_OPC_TEMPLATE_MACRO_ENABLED` Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package.
`static int`	`HTML` HTML format.
`static int`	`length`
`static int`	`MARKDOWN` Markdown text document.
`static int`	`MHTML` MHTML (Web archive) format.
`static int`	`MOBI` MOBI format.
`static int`	`MS_WORKS` Microsoft Works 8 Document.
`static int`	`ODT` ODF Text Document.
`static int`	`OTT` ODF Text Document Template.
`static int`	`PDF` Pdf document.
`static int`	`RTF` RTF format.
`static int`	`TEXT` Plain Text.
`static int`	`UNKNOWN` Unrecognized format, cannot be loaded by Aspose.Words.
`static int`	`WORD_ML` Microsoft Word 2003 WordprocessingML format.
`static int`	`XML` XML document.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`fromName(java.lang.String loadFormatName)`
`static java.lang.String`	`getName(int loadFormat)`
`static int[]`	`getValues()`
`static java.lang.String`	`toString(int loadFormat)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AUTO
```
public static int AUTO
```
    Instructs Aspose.Words to recognize the format automatically.
  - MS_WORKS
```
public static int MS_WORKS
```
    Microsoft Works 8 Document.
  - DOC
```
public static int DOC
```
    Microsoft Word 95 or Word 97 - 2003 Document.
  - DOT
```
public static int DOT
```
    Microsoft Word 95 or Word 97 - 2003 Template.
  - DOC_PRE_WORD_60
```
public static int DOC_PRE_WORD_60
```
    The document is in pre-Word 95 format. Aspose.Words does not currently support loading such documents.
  - DOCX
```
public static int DOCX
```
    Office Open XML WordprocessingML Document (macro-free).
  - DOCM
```
public static int DOCM
```
    Office Open XML WordprocessingML Macro-Enabled Document.
  - DOTX
```
public static int DOTX
```
    Office Open XML WordprocessingML Template (macro-free).
  - DOTM
```
public static int DOTM
```
    Office Open XML WordprocessingML Macro-Enabled Template.
  - FLAT_OPC
```
public static int FLAT_OPC
```
    Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.
  - FLAT_OPC_MACRO_ENABLED
```
public static int FLAT_OPC_MACRO_ENABLED
```
    Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package.
  - FLAT_OPC_TEMPLATE
```
public static int FLAT_OPC_TEMPLATE
```
    Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package.
  - FLAT_OPC_TEMPLATE_MACRO_ENABLED
```
public static int FLAT_OPC_TEMPLATE_MACRO_ENABLED
```
    Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package.
  - RTF
```
public static int RTF
```
    RTF format.
  - WORD_ML
```
public static int WORD_ML
```
    Microsoft Word 2003 WordprocessingML format.
  - HTML
```
public static int HTML
```
    HTML format.
  - MHTML
```
public static int MHTML
```
    MHTML (Web archive) format.
  - MOBI
```
public static int MOBI
```
    MOBI format. Used by MobiPocket reader and Amazon Kindle readers.
  - CHM
```
public static int CHM
```
    CHM (Compiled HTML Help) format.
  - AZW_3
```
public static int AZW_3
```
    AZW3 format. Used by Amazon Kindle readers.
  - EPUB
```
public static int EPUB
```
    EPUB format.
  - ODT
```
public static int ODT
```
    ODF Text Document.
  - OTT
```
public static int OTT
```
    ODF Text Document Template.
  - TEXT
```
public static int TEXT
```
    Plain Text.
  - MARKDOWN
```
public static int MARKDOWN
```
    Markdown text document.
  - PDF
```
public static int PDF
```
    Pdf document.
  - XML
```
public static int XML
```
    XML document.
  - UNKNOWN
```
public static int UNKNOWN
```
    Unrecognized format, cannot be loaded by Aspose.Words.
  - length
```
public static int length
```
- Method Detail
  - getName
```
public static java.lang.String getName(int loadFormat)
```
  - toString
```
public static java.lang.String toString(int loadFormat)
```
  - fromName
```
public static int fromName(java.lang.String loadFormatName)
```
  - getValues
```
public static int[] getValues()
```

Class LoadFormat

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTO

MS_WORKS

DOC

DOT

DOC_PRE_WORD_60

DOCX

DOCM

DOTX

DOTM

FLAT_OPC

FLAT_OPC_MACRO_ENABLED

FLAT_OPC_TEMPLATE

FLAT_OPC_TEMPLATE_MACRO_ENABLED

RTF

WORD_ML

HTML

MHTML

MOBI

CHM

AZW_3

EPUB

ODT

OTT

TEXT

MARKDOWN

PDF

XML

UNKNOWN

length

Method Detail

getName

toString

fromName

getValues