com.aspose.words

Method Detail

• contentTypeToLoadFormat

  public static int contentTypeToLoadFormat(java.lang.String contentType)

  Converts IANA content type into a load format enumerated value.

  Example:

  Shows how to find the corresponding Aspose load/save format from each media type string.

  // The ContentTypeToSaveFormat/ContentTypeToLoadFormat methods only accept official IANA media type names, also known as MIME types. 
  // All valid media types are listed here: https://www.iana.org/assignments/media-types/media-types.xhtml.
  
  // Trying to associate a SaveFormat with a partial media type string will not work.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.contentTypeToSaveFormat("jpeg"));
  
  // If Aspose.Words does not have a corresponding save/load format for a content type, an exception will also be thrown.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.contentTypeToSaveFormat("application/zip"));
  
  // Files of the types listed below can be saved, but not loaded using Aspose.Words.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.contentTypeToLoadFormat("image/jpeg"));
  
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/jpeg"), SaveFormat.JPEG);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/png"), SaveFormat.PNG);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/tiff"), SaveFormat.TIFF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/gif"), SaveFormat.GIF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/x-emf"), SaveFormat.EMF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/vnd.ms-xpsdocument"), SaveFormat.XPS);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/pdf"), SaveFormat.PDF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/svg+xml"), SaveFormat.SVG);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/epub+zip"), SaveFormat.EPUB);
  
  // For file types that can be saved and loaded, we can match a media type to both a load format and a save format.
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("application/msword"), LoadFormat.DOC);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/msword"), SaveFormat.DOC);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("application/vnd.openxmlformats-officedocument.wordprocessingml.document"), LoadFormat.DOCX);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/vnd.openxmlformats-officedocument.wordprocessingml.document"), SaveFormat.DOCX);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("text/plain"), LoadFormat.TEXT);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("text/plain"), SaveFormat.TEXT);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("application/rtf"), LoadFormat.RTF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/rtf"), SaveFormat.RTF);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("text/html"), LoadFormat.HTML);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("text/html"), SaveFormat.HTML);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("multipart/related"), LoadFormat.MHTML);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("multipart/related"), SaveFormat.MHTML);

• contentTypeToSaveFormat

  public static int contentTypeToSaveFormat(java.lang.String contentType)

  Converts IANA content type into a save format enumerated value.

  Example:

  Shows how to find the corresponding Aspose load/save format from each media type string.

  // The ContentTypeToSaveFormat/ContentTypeToLoadFormat methods only accept official IANA media type names, also known as MIME types. 
  // All valid media types are listed here: https://www.iana.org/assignments/media-types/media-types.xhtml.
  
  // Trying to associate a SaveFormat with a partial media type string will not work.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.contentTypeToSaveFormat("jpeg"));
  
  // If Aspose.Words does not have a corresponding save/load format for a content type, an exception will also be thrown.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.contentTypeToSaveFormat("application/zip"));
  
  // Files of the types listed below can be saved, but not loaded using Aspose.Words.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.contentTypeToLoadFormat("image/jpeg"));
  
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/jpeg"), SaveFormat.JPEG);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/png"), SaveFormat.PNG);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/tiff"), SaveFormat.TIFF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/gif"), SaveFormat.GIF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/x-emf"), SaveFormat.EMF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/vnd.ms-xpsdocument"), SaveFormat.XPS);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/pdf"), SaveFormat.PDF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("image/svg+xml"), SaveFormat.SVG);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/epub+zip"), SaveFormat.EPUB);
  
  // For file types that can be saved and loaded, we can match a media type to both a load format and a save format.
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("application/msword"), LoadFormat.DOC);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/msword"), SaveFormat.DOC);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("application/vnd.openxmlformats-officedocument.wordprocessingml.document"), LoadFormat.DOCX);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/vnd.openxmlformats-officedocument.wordprocessingml.document"), SaveFormat.DOCX);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("text/plain"), LoadFormat.TEXT);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("text/plain"), SaveFormat.TEXT);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("application/rtf"), LoadFormat.RTF);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("application/rtf"), SaveFormat.RTF);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("text/html"), LoadFormat.HTML);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("text/html"), SaveFormat.HTML);
  
  Assert.assertEquals(FileFormatUtil.contentTypeToLoadFormat("multipart/related"), LoadFormat.MHTML);
  Assert.assertEquals(FileFormatUtil.contentTypeToSaveFormat("multipart/related"), SaveFormat.MHTML);

• detectFileFormat

  public static FileFormatInfo detectFileFormat(java.io.InputStream stream)
                                             throws java.lang.Exception

  Detects and returns the information about a format of a document stored in a stream.

  The stream must be positioned at the beginning of the document.

  Detecting a file format might require seeking to various positions in the stream. Because java.io.InputStream is not seekable, this method loads the whole stream into memory temporarily. When this method returns, the stream is positioned at the end of the document.

  Even if this method detects the document format, it does not guarantee that the specified document is valid. This method only detects the document format by reading data that is sufficient for detection. To fully verify that a document is valid you need to load the document into a Document object.

  This method throws FileCorruptedException when the format is recognized, but the detection cannot complete because of corruption.

  Parameters:

  stream - The stream.

  Returns:

  A FileFormatInfo object that contains the detected information.

  Example:

  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);
  /*LoadFormat*/
  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);
  /*SaveFormat*/
  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));

• detectFileFormat

  public static FileFormatInfo detectFileFormat(java.lang.String fileName)
                                             throws java.lang.Exception

  Detects and returns the information about a format of a document stored in a disk file.

  Even if this method detects the document format, it does not guarantee that the specified document is valid. This method only detects the document format by reading data that is sufficient for detection. To fully verify that a document is valid you need to load the document into a Document object.

  This method throws FileCorruptedException when the format is recognized, but the detection cannot complete because of corruption.

  Parameters:

  fileName - The file name.

  Returns:

  A FileFormatInfo object that contains the detected information.

  Example:

  Shows how to use the FileFormatUtil class to detect the document format and presence of digital signatures.

  // Use a FileFormatInfo instance to verify that a document is not digitally signed.
  FileFormatInfo info = FileFormatUtil.detectFileFormat(getMyDir() + "Document.docx");
  
  Assert.assertEquals(".docx", FileFormatUtil.loadFormatToExtension(info.getLoadFormat()));
  Assert.assertFalse(info.hasDigitalSignature());
  
  CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw", null);
  DigitalSignatureUtil.sign(getMyDir() + "Document.docx", getArtifactsDir() + "File.DetectDigitalSignatures.docx",
          certificateHolder);
  
  // Use a new FileFormatInstance to confirm that it is signed.
  info = FileFormatUtil.detectFileFormat(getArtifactsDir() + "File.DetectDigitalSignatures.docx");
  
  Assert.assertTrue(info.hasDigitalSignature());
  
  // We can load and access the signatures of a signed document in a collection like this.
  Assert.assertEquals(1, DigitalSignatureUtil.loadSignatures(getArtifactsDir() + "File.DetectDigitalSignatures.docx").getCount());

  Example:

  Shows how to use the FileFormatUtil class to detect the document format and encryption.

  Document doc = new Document();
  
  // Configure a SaveOptions object to encrypt the document with a password when we save it, and then save it.
  OdtSaveOptions saveOptions = new OdtSaveOptions(SaveFormat.ODT);
  saveOptions.setPassword("MyPassword");
  
  doc.save(getArtifactsDir() + "File.DetectDocumentEncryption.odt", saveOptions);
  
  // Verify the file type of our document, and its encryption status.
  FileFormatInfo info = FileFormatUtil.detectFileFormat(getArtifactsDir() + "File.DetectDocumentEncryption.odt");
  
  Assert.assertEquals(".odt", FileFormatUtil.loadFormatToExtension(info.getLoadFormat()));
  Assert.assertTrue(info.isEncrypted());

• extensionToSaveFormat

  public static int extensionToSaveFormat(java.lang.String extension)

  Converts a file name extension into a SaveFormat value.

  If the extension cannot be recognized, returns SaveFormat.UNKNOWN.

  Parameters:

  extension - The file extension. Can be with or without a leading dot. Case-insensitive.

  Example:

  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);
  /*LoadFormat*/
  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);
  /*SaveFormat*/
  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));

• imageTypeToExtension

  public static java.lang.String imageTypeToExtension(int imageType)

  Converts an Aspose.Words image type enumerated value into a file extension. The returned extension is a lower-case string with a leading dot.

  Parameters:

  imageType - A ImageType value.

  Example:

  Shows how to extract images from a document, and save them to the local file system as individual files.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  // Get the collection of shapes from the document,
  // and save the image data of every shape with an image as a file to the local file system.
  NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
  
  int imageIndex = 0;
  for (Shape shape : (Iterable<Shape>) shapes) {
      if (shape.hasImage()) {
          // The image data of shapes may contain images of many possible image formats. 
          // We can determine a file extension for each image automatically, based on its format.
          String imageFileName = MessageFormat.format("File.ExtractImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
          shape.getImageData().save(getArtifactsDir() + imageFileName);
          imageIndex++;
      }
  }

• loadFormatToExtension

  public static java.lang.String loadFormatToExtension(int loadFormat)

  Converts a load format enumerated value into a file extension. The returned extension is a lower-case string with a leading dot.

  The SaveFormat.WORD_ML value is converted to ".wml".

  Parameters:

  loadFormat - A LoadFormat value.

  Example:

  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);
  /*LoadFormat*/
  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);
  /*SaveFormat*/
  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));

• loadFormatToSaveFormat

  public static int loadFormatToSaveFormat(int loadFormat)

  Converts a LoadFormat value to a SaveFormat value if possible.

  Parameters:

  loadFormat - A LoadFormat value.

  Example:

  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);
  /*LoadFormat*/
  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);
  /*SaveFormat*/
  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));

• saveFormatToExtension

  public static java.lang.String saveFormatToExtension(int saveFormat)

  Converts a save format enumerated value into a file extension. The returned extension is a lower-case string with a leading dot.

  The SaveFormat.WORD_ML value is converted to ".wml".

  The SaveFormat.FLAT_OPC value is converted to ".fopc".

  Parameters:

  saveFormat - A SaveFormat value.

  Example:

  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);
  /*LoadFormat*/
  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);
  /*SaveFormat*/
  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));

• saveFormatToLoadFormat

  public static int saveFormatToLoadFormat(int saveFormat)

  Converts a SaveFormat value to a LoadFormat value if possible.

  Parameters:

  saveFormat - A SaveFormat value.

  Example:

  Shows how to convert a save format to its corresponding load format.

  Assert.assertEquals(LoadFormat.HTML, FileFormatUtil.saveFormatToLoadFormat(SaveFormat.HTML));
  
  // Some file types can have documents saved to, but not loaded from using Aspose.Words.
  // If we attempt to convert a save format of such a type to a load format, an exception will be thrown.
  Assert.assertThrows(IllegalArgumentException.class, () -> FileFormatUtil.saveFormatToLoadFormat(SaveFormat.JPEG));