GroupDocs.Conversion for .NET 20.4 Release Notes

Major Features

There are 20+ features, improvements and bug-fixes in this release, most notable are:

  • Conversions from PST, OST - can convert each message, contact to different format
  • Now is possible to convert each email attachment to different format
  • Conversions from Oxps, Fods, Otg
  • Conversion to Fods
  • Improved caching
  • Introduced in-memory caching

Full List of Issues Covering all Changes in this Release

KeyCategorySummary
CONVERSIONNET-3225FeatureSupport for auto page numbering while export to PDF
CONVERSIONNET-3710FeatureConvert each email attachment to different type
CONVERSIONNET-3778FeatureConvert from PST, OST
CONVERSIONNET-3812FeatureImplement conversion from Oxps
CONVERSIONNET-3816FeatureImplement conversion from Fods
CONVERSIONNET-3822FeatureImplement conversion to Fods
CONVERSIONNET-3823FeatureImplement conversion from Otg
CONVERSIONNET-2875FeatureIntroduced in memory caching
CONVERSIONNET-3659ImprovementImprove font substitution when converting from PDF
CONVERSIONNET-3874ImprovementImproved caching
CONVERSIONNET-1702BugA generic error occurred in GDI+ while saving document to LZW TIFF
CONVERSIONNET-3699BugException while Converting PST to CSV using GroupDocs.Conversion .NET API v20.1.0 As The Not supported file type
CONVERSIONNET-3724BugException while Converting XLSB to XLS using GroupDocs.Conversion .NET API v20.1.0
CONVERSIONNET-3729BugException while Converting XLSB to XLSX As The column index should not be inside the pivot table report
CONVERSIONNET-3745BugXLSB to XLS conversion issue 
CONVERSIONNET-3768Bug“System.DllNotFoundException : Unable to load DLL ‘libgdiplus’: The specified module could not be found.” exception on MacOS targeting .NET Standard
CONVERSIONNET-3770BugVSD to DOC conversion issue
CONVERSIONNET-3790BugXps and Tex files are converted in trial mode when using venture licensing
CONVERSIONNET-3804BugPCL to DOT file conversion
CONVERSIONNET-3810BugXLSX to XLS conversion - The column index should not be inside the pivottable report
CONVERSIONNET-3821BugGroupDocs.Conversion.Exceptions.GroupDocsConversionException was unhandled

Public API and Backward Incompatible Changes

  1. Converter class has new constructor overloads

    /// <summary>
    /// Initializes new instance of <see cref="Converter"/> class.
    /// </summary>
    /// <param name="document">The method that returns readable stream.</param>
    /// <param name="loadOptions">The methods that returns document load options.</param>
    public Converter(Func<Stream> document, Func<FileType, LoadOptions> loadOptions)
        
        
    /// <summary>
    /// Initializes new instance of <see cref="Converter"/> class.
    /// </summary>
    /// <param name="document">The method that returns readable stream.</param>
    /// <param name="loadOptions">The methods that returns document load options.</param>
    /// <param name="settings">The Converter settings.</param>
    public Converter(Func<Stream> document, Func<FileType, LoadOptions> loadOptions, Func<ConverterSettings> settings)
        
    /// <summary>
    /// Initializes new instance of <see cref="Converter"/> class.
    /// </summary>
    /// <param name="filePath">The file path to the source document.</param>
    /// <param name="loadOptions">The methods that returns document load options.</param>
    public Converter(string filePath, Func<FileType, LoadOptions> loadOptions)
        
    /// <summary>
    /// Initializes new instance of <see cref="Converter"/> class.
    /// </summary>
    /// <param name="filePath">The file path to the source document.</param>
    /// <param name="loadOptions">The methods that returns document load options.</param>
    /// <param name="settings">The Converter settings.</param>
    public Converter(string filePath, Func<FileType, LoadOptions> loadOptions, Func<ConverterSettings> settings) 
    

    Usage

    LoadOptions LoadOptionsProvider(FileType sourceType)
    {
        if (sourceType == EmailFileType.Msg)
        {
            return new EmailLoadOptions {ConvertOwned = true, ConvertOwner = true};
        }
        return null;
    }
        
    var source = "sample.docx";
    using (var converter = new Converter(source, LoadOptionsProvider))
    {
    ....
    }
    
  2. Convert method in Converter class has new overloads

    /// <summary>
    /// Converts source document. Saves the whole converted document.
    /// </summary>
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider) 
     
    /// <summary>
    /// Converts source document. Saves the whole converted document.
    /// </summary>
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="documentCompleted">The delegate that receive converted document stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
        
    /// <summary>
    /// Converts source document. Saves the whole converted document.
    /// </summary>
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="convertOptions">The convert options specific to desired target file type.</param>
    public void Convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions)
        
    /// <summary>
    /// Converts source document. Saves the whole converted document.
    /// </summary>
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="documentCompleted">The delegate that receive converted document stream.</param>
    /// <param name="convertOptions">The convert options specific to desired target file type.</param>
    public void Convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
        
    /// <summary>
    /// Converts source document. Saves the whole converted document.
    /// </summary>
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
        
    /// <summary>
    /// Converts source document. Saves the whole converted document.
    /// </summary>
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="documentCompleted">The delegate that receive converted document stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
        
    /// <summary>
    /// Converts source document. Saves the converted document page by page.
    /// </summary>        
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider)
        
    /// <summary>
    /// Converts source document. Saves the converted document page by page.
    /// </summary>        
    /// <param name="document">The delegate that saves converted document page to a stream.</param>
    /// <param name="documentCompleted">The delegate that receive converted document page stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
        
    /// <summary>
    /// Converts source document. Saves the converted document page by page.
    /// </summary>        
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="convertOptions">The convert options specific to desired target file type.</param>
    public void Convert(SavePageStreamForFileType document, ConvertOptions convertOptions)
        
    /// <summary>
    /// Converts source document. Saves the converted document page by page.
    /// </summary>        
    /// <param name="document">The delegate that saves converted document page to a stream.</param>
    /// <param name="documentCompleted">The delegate that receive converted document page stream.</param>
    /// <param name="convertOptions">The convert options specific to desired target file type.</param>
    public void Convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
        
    /// <summary>
    /// Converts source document. Saves the converted document page by page.
    /// </summary>        
    /// <param name="document">The delegate that saves converted document to a stream.</param>
    /// <param name="convertOptionsProvider">Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
        
    /// <summary>
    /// Converts source document. Saves the converted document page by page.
    /// </summary>        
    /// <param name="document">The delegate that saves converted document page to a stream.</param>
    /// <param name="documentCompleted">The delegate that receive converted document page stream.</param>
    /// <param name="convertOptionsProvider">Convert options factory. Will be called for each conversion to provide specific convert options to desired target document type.</param>
    public void Convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
    

    Usage

    LoadOptions LoadOptionsProvider(FileType sourceType)
    {
        if (sourceType == EmailFileType.Msg)
        {
            return new EmailLoadOptions {ConvertOwned = true, ConvertOwner = true};
        }
        return null;
    }
     
    Stream ConvertedStreamProvider(FileType targetType)
    {
        return new FileStream($"converted-{index++}.{targetType.Extension}", FileMode.Create);
    }
        
    ConvertOptions ConvertOptionsProvider(string sourceDocumentName, FileType sourceType)
    {
        if (sourceType == WordProcessingFileType.Doc)
        {
            return new ImageConvertOptions
            {
                Format = ImageFileType.Tiff
            };
        } else if (sourceType == EmailFileType.Msg)
        {
            return new PdfConvertOptions();
        } else if (sourceType == ImageFileType.Png)
        {
            return new ImageConvertOptions {Format = ImageFileType.Jpeg};
        }
        return new PdfConvertOptions();
    }
        
    var source = "sample.docx";
    using (var converter = new Converter(source, LoadOptionsProvider))
    {
        converter.Convert(ConvertedStreamProvider, ConvertOptionsProvider);
    }
    
  3. New delegates are introduced

    /// <summary>
    /// Describes delegate for saving converted document into stream. 
    /// </summary>
    /// <param name="fileType">Converted document type</param>
    /// <returns>Must return a stream where the converted document will be saved</returns>
    public delegate Stream SaveDocumentStreamForFileType(FileType fileType);
        
    /// <summary>
    /// Describes delegate for saving converted document page into stream. 
    /// </summary>
    /// <param name="pageNumber">Converted page number</param>
    /// <param name="fileType">Converted document type</param>
    /// <returns>Must return a stream where the converted document page will be saved</returns>
    public delegate Stream SavePageStreamForFileType(int pageNumber, FileType fileType);
        
     
    /// <summary>
    /// Describes delegate to provide convert options for specific source document.
    /// The delegate will be called before each conversion and provide a chance to provide specific convert options for desired target conversion.
    /// The decision could be made based on provided source file name and source file type.
    /// </summary>
    /// <param name="sourceDocumentName">Source file name</param>
    /// <param name="sourceType">Source file type</param>
    /// <returns>Must return <see cref="ConvertOptions"/> to be used for conversion of <see cref="FileType">sourceType</see> document</returns>
    public delegate ConvertOptions ConvertOptionsProvider(string sourceDocumentName, FileType sourceType);
    
  4. FormatingOptions in PdfOptions class is marked as obsolete FormattingOptions must be used

  5. DefaultFont in GroupDocs.Conversion.ConverterSettings class is marked as obsolete DefaultFont in specific ConvertOptions instance must be used.

  6. ConvertAttachments in EmailLoadOptions class is marked as obsolete ConvertOwned must be used