FluentConverter class

FluentConverter class

Represents a fluent conversion setup.

Sample fluent conversion usage:

var converter = FluentConverter.Create();
FluentConverter.Load("")
    .ConvertTo("")
    .Convert();
// Recommended: aggregate handlers via WithEvents at the early stage (before Load).
FluentConverter
    .WithEvents(e =>
    {
        e.OnDocumentConverted = ctx       => Console.WriteLine($"Done: {ctx.SourceFileName}");
        e.OnDocumentFailed    = (ctx, ex) => Console.Error.WriteLine(ex.Message);
    })
    .Load("input.docx")
    .ConvertTo("output.pdf").WithOptions(new PdfConvertOptions())
    .Convert();
// Per-page mirror: per-page handlers via WithEvents at the early stage.
FluentConverter
    .WithEvents(e =>
    {
        e.OnPageConverted = ctx       => Console.WriteLine($"page {ctx.Page} done");
        e.OnPageFailed    = (ctx, ex) => Console.Error.WriteLine($"page {ctx.Page}: {ex.Message}");
    })
    .Load("input.pdf")
    .ConvertByPageTo(ctx => new FileStream($"page-{ctx.Page}.png", FileMode.Create))
    .WithOptions(new ImageConvertOptions { Format = ImageFileType.Png })
    .Convert();
// Legacy chain still compiles unchanged (now backed by the obsolete staged interfaces):
FluentConverter.WithSettings(() => new ConverterSettings())
    .Load("").WithOptions(new PdfLoadOptions())
    .ConvertTo("").WithOptions(new PdfConvertOptions())
    .OnConversionCompleted(convertedDocumentStream => { })
    .Convert();
FluentConverter.Load("").GetPossibleConversions();
FluentConverter.Load("").GetDocumentInfo();
FluentConverter.Load("").WithOptions(new PdfLoadOptions()).GetPossibleConversions();
FluentConverter.Load("").WithOptions(new PdfLoadOptions()).GetDocumentInfo();

The FluentConverter type exposes the following members:

Methods

Method Description
load Configure source document for conversion.
load Configure set of source documents.
load Configure source document stream.
load Configure a set of source document streams.
load_file
load_files
load_func
load_string
load_strings
with_events Starts a fluent chain at the entry stage with conversion lifecycle event handlers.
with_settings Configure conversion settings.

See Also