←Select platform

GenerateMarkdownReport Method

Summary

Generates a Markdown Report from the result set.

Syntax
C#
VB
C++
public void GenerateMarkdownReport( 
   Stream stream, 
   MarkdownReportOptions options 
) 
Public Sub GenerateMarkdownReport( 
   ByVal stream As Stream, 
   ByVal options As MarkdownReportOptions 
) 
public:  
   void GenerateMarkdownReport( 
      Stream^ stream, 
      MarkdownReportOptions^ options 
   ) 

Parameters

stream

The stream to save the report to.

options

The MarkdownReportOptions to use when building the report.

Return Value

The report will be saved to the provided stream.

Example
C#
using Leadtools.Document; 
using Leadtools.Document.Compare; 
using Leadtools; 
 
public void GenerateMarkdownReportExample() 
{ 
   var doc1 = DocumentFactory.LoadFromFile(pathToDocument1, new LoadDocumentOptions()); 
   var doc2 = DocumentFactory.LoadFromFile(pathToDocument2, new LoadDocumentOptions()); 
 
   var docList = new List<LEADDocument>() 
   { 
      doc1, 
      doc2 
   }; 
 
   var comparer = new DocumentComparer(); 
   var diffs = comparer.CompareDocument(docList); 
   using (MemoryStream ms = new MemoryStream()) 
   { 
      var options = new MarkdownReportOptions() 
      { 
         BaseCSSClass = "example-base", 
         BaseColor = "white", 
         DeletionCSSClass  = "example-delete", 
         DeletionColor = "crimson", 
         InsertionCSSClass = "example-insert", 
         InsertionColor = "lightgreen", 
         StrikethroughCSSClass = "example-strikethrough", 
         StrikethroughColor = "red", 
         UnderlineCSSClass = "example-underline", 
         UnderlineColor = "green", 
      }; 
      options.ReportFooters.Add("Example Report Footer"); 
      options.ReportHeaders.Add("Example Report Header"); 
      options.DocumentNames.Add(doc1.Name); 
      options.DocumentNames.Add(doc2.Name); 
 
 
      diffs.GenerateMarkdownReport(ms, options); 
      ms.Position = 0; 
 
      File.WriteAllBytes(@"path/to/report.md", ms.ToArray()); 
   } 
} 

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Compare Assembly