com.groupdocs.assembly

Class LoadSaveOptions

  • java.lang.Object
    • com.groupdocs.assembly.LoadSaveOptions


  • public class LoadSaveOptions
    extends java.lang.Object
    Specifies additional options for loading and saving of a document to be assembled.
    • Constructor Summary

      Constructors 
      Constructor and Description
      LoadSaveOptions()
      Creates a new instance of this class without any properties specified.
      LoadSaveOptions(int saveFormat)
      Creates a new instance of this class with the specified file format to save an assembled document to.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getSaveFormat()
      Gets a file format to save an assembled document to.
      void setSaveFormat(int value)
      Sets a file format to save an assembled document to.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LoadSaveOptions

        public LoadSaveOptions()
        Creates a new instance of this class without any properties specified.
      • LoadSaveOptions

        public LoadSaveOptions(int saveFormat)
        Creates a new instance of this class with the specified file format to save an assembled document to.
        Parameters:
        saveFormat - A file format to save an assembled document to. The value must be one of FileFormat constants.
    • Method Detail

      • getSaveFormat

        public int getSaveFormat()
        Gets a file format to save an assembled document to. FileFormat.UNSPECIFIED is the default.

        When the value of this property is not specified, DocumentAssembler behaves as follows:

        - When you specify a file path to save an assembled document, the save file format is determined upon file extension from the path.

        - When you specify a stream to save an assembled document, the save file format remains the same as the file format of a loaded template document.

        Beware that it is not always possible to save an assembled document to any file format using GroupDocs.Assembly. For example, it is impossible to save a document loaded from a Word Processing file format (such as DOCX) to a Spreadsheet file format (such as XLSX). For more information on possible combinations of load and save file formats supported by GroupDocs.Assembly, please check GroupDocs.Assembly online documentation.

        Returns:
        A file format to save an assembled document to. The returned value is one of FileFormat constants.
      • setSaveFormat

        public void setSaveFormat(int value)
        Sets a file format to save an assembled document to. FileFormat.UNSPECIFIED is the default.

        When the value of this property is not specified, DocumentAssembler behaves as follows:

        - When you specify a file path to save an assembled document, the save file format is determined upon file extension from the path.

        - When you specify a stream to save an assembled document, the save file format remains the same as the file format of a loaded template document.

        Beware that it is not always possible to save an assembled document to any file format using GroupDocs.Assembly. For example, it is impossible to save a document loaded from a Word Processing file format (such as DOCX) to a Spreadsheet file format (such as XLSX). For more information on possible combinations of load and save file formats supported by GroupDocs.Assembly, please check GroupDocs.Assembly online documentation.

        Parameters:
        value - A file format to save an assembled document to. The value must be one of FileFormat constants.