MigraDoc Sample: Hello MigraDoc

Modified on 2015/09/14 10:17 by Thomas Hövel Categorized as MigraDoc Samples, Samples
{s:navigationPrevUpNext|MigraDocHelloWorld-sample|MigraDocSamples|DocumentViewer-sample}
This sample shows various features of MigraDoc including table of contents, tables, bookmarks, text formatting and font styles, charts, ...

== PDF Output File ==

See the PDF file created by this sample:  {s:PdfLink|HelloMigraDoc-sample%2fHelloMigraDoc_output.pdf|output.pdf} (133 kB)

== Source Code Listing ==

The Main method:
{s:beginCsharp}
static void Main()
{
  // Create a MigraDoc document
  Document document = Documents.CreateDocument();
&nbsp;
  //string ddl = MigraDoc.DocumentObjectModel.IO.DdlWriter.WriteToString(document);
  MigraDoc.DocumentObjectModel.IO.DdlWriter.WriteToFile(document, "MigraDoc.mdddl");
&nbsp;
  PdfDocumentRenderer renderer = new PdfDocumentRenderer(true, PdfSharp.Pdf.PdfFontEmbedding.Always);
  renderer.Document = document;
&nbsp;
  renderer.RenderDocument();
&nbsp;
  // Save the document...
  string filename = "HelloMigraDoc.pdf";
  renderer.PdfDocument.Save(filename);
  // ...and start a viewer.
  Process.Start(filename);
}
{s:endCsharp}

{s:funcName|CreateDocument} is the method that creates the content:
{s:beginCsharp}
public static Document CreateDocument()
{
  // Create a new MigraDoc document
  Document document = new Document();
  document.Info.Title = "Hello, MigraDoc";
  document.Info.Subject = "Demonstrates an excerpt of the capabilities of MigraDoc.";
  document.Info.Author = "Stefan Lange";
&nbsp;
  Styles.DefineStyles(document);
&nbsp;
  Cover.DefineCover(document);
  TableOfContents.DefineTableOfContents(document);
&nbsp;
  DefineContentSection(document);
&nbsp;
  Paragraphs.DefineParagraphs(document);
  Tables.DefineTables(document);
  Charts.DefineCharts(document);
&nbsp;
  return document;
}
{s:endCsharp}


{s:funcName|DefineStyles} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
/// <summary>
/// Defines the styles used in the document.
/// </summary>
public static void DefineStyles(Document document)
{
  // Get the predefined style Normal.
  Style style = document.Styles&#0091;"Normal"&#0093;;
  // Because all styles are derived from Normal, the next line changes the 
  // font of the whole document. Or, more exactly, it changes the font of
  // all styles and paragraphs that do not redefine the font.
  style.Font.Name = "Times New Roman";
&nbsp;
  // Heading1 to Heading9 are predefined styles with an outline level. An outline level
  // other than OutlineLevel.BodyText automatically creates the outline (or bookmarks) 
  // in PDF.
&nbsp;
  style = document.Styles&#0091;"Heading1"&#0093;;
  style.Font.Name = "Tahoma";
  style.Font.Size = 14;
  style.Font.Bold = true;
  style.Font.Color = Colors.DarkBlue;
  style.ParagraphFormat.PageBreakBefore = true;
  style.ParagraphFormat.SpaceAfter = 6;
&nbsp;
  style = document.Styles&#0091;"Heading2"&#0093;;
  style.Font.Size = 12;
  style.Font.Bold = true;
  style.ParagraphFormat.PageBreakBefore = false;
  style.ParagraphFormat.SpaceBefore = 6;
  style.ParagraphFormat.SpaceAfter = 6;
&nbsp;
  style = document.Styles&#0091;"Heading3"&#0093;;
  style.Font.Size = 10;
  style.Font.Bold = true;
  style.Font.Italic = true;
  style.ParagraphFormat.SpaceBefore = 6;
  style.ParagraphFormat.SpaceAfter = 3;
&nbsp;
  style = document.Styles&#0091;StyleNames.Header&#0093;;
  style.ParagraphFormat.AddTabStop("16cm", TabAlignment.Right);
&nbsp;
  style = document.Styles&#0091;StyleNames.Footer&#0093;;
  style.ParagraphFormat.AddTabStop("8cm", TabAlignment.Center);
&nbsp;
  // Create a new style called TextBox based on style Normal
  style = document.Styles.AddStyle("TextBox", "Normal");
  style.ParagraphFormat.Alignment = ParagraphAlignment.Justify;
  style.ParagraphFormat.Borders.Width = 2.5;
  style.ParagraphFormat.Borders.Distance = "3pt";
  style.ParagraphFormat.Shading.Color = Colors.SkyBlue;
&nbsp;
  // Create a new style called TOC based on style Normal
  style = document.Styles.AddStyle("TOC", "Normal");
  style.ParagraphFormat.AddTabStop("16cm", TabAlignment.Right, TabLeader.Dots);
  style.ParagraphFormat.Font.Color = Colors.Blue;
}
{s:endCsharp}


{s:funcName|DefineCover} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
/// <summary>
/// Defines the cover page.
/// </summary>
public static void DefineCover(Document document)
{
  Section section = document.AddSection();
&nbsp;
  Paragraph paragraph = section.AddParagraph();
  paragraph.Format.SpaceAfter = "3cm";
&nbsp;
  Image image = section.AddImage("../../images/Logo landscape.png");
  image.Width = "10cm";
&nbsp;
  paragraph = section.AddParagraph("A sample document that demonstrates the\ncapabilities of MigraDoc");
  paragraph.Format.Font.Size = 16;
  paragraph.Format.Font.Color = Colors.DarkRed;
  paragraph.Format.SpaceBefore = "8cm";
  paragraph.Format.SpaceAfter = "3cm";
&nbsp;
  paragraph = section.AddParagraph("Rendering date: ");
  paragraph.AddDateField();
}
{s:endCsharp}


{s:funcName|DefineTableOfContents} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
/// <summary>
/// Defines the cover page.
/// </summary>
public static void DefineTableOfContents(Document document)
{
  Section section = document.LastSection;
&nbsp;
  section.AddPageBreak();
  Paragraph paragraph = section.AddParagraph("Table of Contents");
  paragraph.Format.Font.Size = 14;
  paragraph.Format.Font.Bold = true;
  paragraph.Format.SpaceAfter = 24;
  paragraph.Format.OutlineLevel = OutlineLevel.Level1;
&nbsp;
  paragraph = section.AddParagraph();
  paragraph.Style = "TOC";
  Hyperlink hyperlink = paragraph.AddHyperlink("Paragraphs");
  hyperlink.AddText("Paragraphs\t");
  hyperlink.AddPageRefField("Paragraphs");
&nbsp;
  paragraph = section.AddParagraph();
  paragraph.Style = "TOC";
  hyperlink = paragraph.AddHyperlink("Tables");
  hyperlink.AddText("Tables\t");
  hyperlink.AddPageRefField("Tables");
&nbsp;
  paragraph = section.AddParagraph();
  paragraph.Style = "TOC";
  hyperlink = paragraph.AddHyperlink("Charts");
  hyperlink.AddText("Charts\t");
  hyperlink.AddPageRefField("Charts");
}
{s:endCsharp}


{s:funcName|DefineContentSection} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
/// <summary>
/// Defines page setup, headers, and footers.
/// </summary>
static void DefineContentSection(Document document)
{
  Section section = document.AddSection();
  section.PageSetup.OddAndEvenPagesHeaderFooter = true;
  section.PageSetup.StartingNumber = 1;
&nbsp;
  HeaderFooter header = section.Headers.Primary;
  header.AddParagraph("\tOdd Page Header");
&nbsp;
  header = section.Headers.EvenPage;
  header.AddParagraph("Even Page Header");
&nbsp;
  // Create a paragraph with centered page number. See definition of style "Footer".
  Paragraph paragraph = new Paragraph();
  paragraph.AddTab();
  paragraph.AddPageField();
&nbsp;
  // Add paragraph to footer for odd pages.
  section.Footers.Primary.Add(paragraph);
  // Add clone of paragraph to footer for odd pages. Cloning is necessary because an object must
  // not belong to more than one other object. If you forget cloning an exception is thrown.
  section.Footers.EvenPage.Add(paragraph.Clone());
}
{s:endCsharp}


{s:funcName|DefineParagraphs} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
public static void DefineParagraphs(Document document)
{
  Paragraph paragraph = document.LastSection.AddParagraph("Paragraph Layout Overview", "Heading1");
  paragraph.AddBookmark("Paragraphs");
&nbsp;
  DemonstrateAlignment(document);
  DemonstrateIndent(document);
  DemonstrateFormattedText(document);
  DemonstrateBordersAndShading(document);
}
&nbsp;
static void DemonstrateAlignment(Document document)
{
  document.LastSection.AddParagraph("Alignment", "Heading2");
&nbsp;
  document.LastSection.AddParagraph("Left Aligned", "Heading3");
&nbsp;
  Paragraph paragraph = document.LastSection.AddParagraph();
  paragraph.Format.Alignment = ParagraphAlignment.Left;
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("Right Aligned", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.Alignment = ParagraphAlignment.Right;
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("Centered", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.Alignment = ParagraphAlignment.Center;
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("Justified", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.Alignment = ParagraphAlignment.Justify;
  paragraph.AddText(FillerText.MediumText);
}
&nbsp;
static void DemonstrateIndent(Document document)
{
  document.LastSection.AddParagraph("Indent", "Heading2");
&nbsp;
  document.LastSection.AddParagraph("Left Indent", "Heading3");
&nbsp;
  Paragraph paragraph = document.LastSection.AddParagraph();
  paragraph.Format.LeftIndent = "2cm";
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("Right Indent", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.RightIndent = "1in";
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("First Line Indent", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.FirstLineIndent = "12mm";
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("First Line Negative Indent", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.LeftIndent = "1.5cm";
  paragraph.Format.FirstLineIndent = "-1.5cm";
  paragraph.AddText(FillerText.Text);
}
&nbsp;
static void DemonstrateFormattedText(Document document)
{
  document.LastSection.AddParagraph("Formatted Text", "Heading2");
&nbsp;
  //document.LastSection.AddParagraph("Left Aligned", "Heading3");
&nbsp;
  Paragraph paragraph = document.LastSection.AddParagraph();
  paragraph.AddText("Text can be formatted ");
  paragraph.AddFormattedText("bold", TextFormat.Bold);
  paragraph.AddText(", ");
  paragraph.AddFormattedText("italic", TextFormat.Italic);
  paragraph.AddText(", or ");
  paragraph.AddFormattedText("bold & italic", TextFormat.Bold | TextFormat.Italic);
  paragraph.AddText(".");
  paragraph.AddLineBreak();
  paragraph.AddText("You can set the ");
  FormattedText formattedText = paragraph.AddFormattedText("size ");
  formattedText.Size = 15;
  paragraph.AddText("the ");
  formattedText = paragraph.AddFormattedText("color ");
  formattedText.Color = Colors.Firebrick;
  paragraph.AddText("the ");
  formattedText = paragraph.AddFormattedText("font", new Font("Verdana"));
  paragraph.AddText(".");
  paragraph.AddLineBreak();
  paragraph.AddText("You can set the ");
  formattedText = paragraph.AddFormattedText("subscript");
  formattedText.Subscript = true;
  paragraph.AddText(" or ");
  formattedText = paragraph.AddFormattedText("superscript");
  formattedText.Superscript = true;
  paragraph.AddText(".");
}
&nbsp;
static void DemonstrateBordersAndShading(Document document)
{
  document.LastSection.AddPageBreak();
  document.LastSection.AddParagraph("Borders and Shading", "Heading2");
&nbsp;
  document.LastSection.AddParagraph("Border around Paragraph", "Heading3");
&nbsp;
  Paragraph paragraph = document.LastSection.AddParagraph();
  paragraph.Format.Borders.Width = 2.5;
  paragraph.Format.Borders.Color = Colors.Navy;
  paragraph.Format.Borders.Distance = 3;
  paragraph.AddText(FillerText.MediumText);
&nbsp;
  document.LastSection.AddParagraph("Shading", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Format.Shading.Color = Colors.LightCoral;
  paragraph.AddText(FillerText.Text);
&nbsp;
  document.LastSection.AddParagraph("Borders & Shading", "Heading3");
&nbsp;
  paragraph = document.LastSection.AddParagraph();
  paragraph.Style = "TextBox";
  paragraph.AddText(FillerText.MediumText);
}
{s:endCsharp}


{s:funcName|DefineTables} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
public static void DefineTables(Document document)
{
  Paragraph paragraph = document.LastSection.AddParagraph("Table Overview", "Heading1");
  paragraph.AddBookmark("Tables");
&nbsp;
  DemonstrateSimpleTable(document);
  DemonstrateAlignment(document);
  DemonstrateCellMerge(document);
}
&nbsp;
public static void DemonstrateSimpleTable(Document document)
{
  document.LastSection.AddParagraph("Simple Tables", "Heading2");
&nbsp;
  Table table = new Table();
  table.Borders.Width = 0.75;
&nbsp;
  Column column = table.AddColumn(Unit.FromCentimeter(2));
  column.Format.Alignment = ParagraphAlignment.Center;
&nbsp;
  table.AddColumn(Unit.FromCentimeter(5));
&nbsp;
  Row row = table.AddRow();
  row.Shading.Color = Colors.PaleGoldenrod;
  Cell cell = row.Cells&#0091;0&#0093;;
  cell.AddParagraph("Itemus");
  cell = row.Cells&#0091;1&#0093;;
  cell.AddParagraph("Descriptum");
&nbsp;
  row = table.AddRow();
  cell = row.Cells&#0091;0&#0093;;
  cell.AddParagraph("1");
  cell = row.Cells&#0091;1&#0093;;
  cell.AddParagraph(FillerText.ShortText);
&nbsp;
  row = table.AddRow();
  cell = row.Cells&#0091;0&#0093;;
  cell.AddParagraph("2");
  cell = row.Cells&#0091;1&#0093;;
  cell.AddParagraph(FillerText.Text);
&nbsp;
  table.SetEdge(0, 0, 2, 3, Edge.Box, BorderStyle.Single, 1.5, Colors.Black);
&nbsp;
  document.LastSection.Add(table);
}
&nbsp;
public static void DemonstrateAlignment(Document document)
{
  document.LastSection.AddParagraph("Cell Alignment", "Heading2");
&nbsp;
  Table table = document.LastSection.AddTable();
  table.Borders.Visible = true;
  table.Format.Shading.Color = Colors.LavenderBlush;
  table.Shading.Color = Colors.Salmon;
  table.TopPadding = 5;
  table.BottomPadding = 5;
&nbsp;
  Column column = table.AddColumn();
  column.Format.Alignment = ParagraphAlignment.Left;
&nbsp;
  column = table.AddColumn();
  column.Format.Alignment = ParagraphAlignment.Center;
&nbsp;
  column = table.AddColumn();
  column.Format.Alignment = ParagraphAlignment.Right;
&nbsp;
  table.Rows.Height = 35;
&nbsp;
  Row row = table.AddRow();
  row.VerticalAlignment = VerticalAlignment.Top;
  row.Cells&#0091;0&#0093;.AddParagraph("Text");
  row.Cells&#0091;1&#0093;.AddParagraph("Text");
  row.Cells&#0091;2&#0093;.AddParagraph("Text");
&nbsp;
  row = table.AddRow();
  row.VerticalAlignment = VerticalAlignment.Center;
  row.Cells&#0091;0&#0093;.AddParagraph("Text");
  row.Cells&#0091;1&#0093;.AddParagraph("Text");
  row.Cells&#0091;2&#0093;.AddParagraph("Text");
&nbsp;
  row = table.AddRow();
  row.VerticalAlignment = VerticalAlignment.Bottom;
  row.Cells&#0091;0&#0093;.AddParagraph("Text");
  row.Cells&#0091;1&#0093;.AddParagraph("Text");
  row.Cells&#0091;2&#0093;.AddParagraph("Text");
}
&nbsp;
public static void DemonstrateCellMerge(Document document)
{
  document.LastSection.AddParagraph("Cell Merge", "Heading2");
&nbsp;
  Table table = document.LastSection.AddTable();
  table.Borders.Visible = true;
  table.TopPadding = 5;
  table.BottomPadding = 5;
&nbsp;
  Column column = table.AddColumn();
  column.Format.Alignment = ParagraphAlignment.Left;
&nbsp;
  column = table.AddColumn();
  column.Format.Alignment = ParagraphAlignment.Center;
&nbsp;
  column = table.AddColumn();
  column.Format.Alignment = ParagraphAlignment.Right;
&nbsp;
  table.Rows.Height = 35;
&nbsp;
  Row row = table.AddRow();
  row.Cells&#0091;0&#0093;.AddParagraph("Merge Right");
  row.Cells&#0091;0&#0093;.MergeRight = 1;
&nbsp;
  row = table.AddRow();
  row.VerticalAlignment = VerticalAlignment.Bottom;
  row.Cells&#0091;0&#0093;.MergeDown = 1;
  row.Cells&#0091;0&#0093;.VerticalAlignment = VerticalAlignment.Bottom;
  row.Cells&#0091;0&#0093;.AddParagraph("Merge Down");
&nbsp;
  table.AddRow();
}
{s:endCsharp}


{s:funcName|DefineCharts} is called by {s:funcName|CreateDocument}:
{s:beginCsharp}
public static void DefineCharts(Document document)
{
  Paragraph paragraph = document.LastSection.AddParagraph("Chart Overview", "Heading1");
  paragraph.AddBookmark("Charts");
&nbsp;
  document.LastSection.AddParagraph("Sample Chart", "Heading2");
&nbsp;
  Chart chart = new Chart();
  chart.Left = 0;
&nbsp;
  chart.Width = Unit.FromCentimeter(16);
  chart.Height = Unit.FromCentimeter(12);
  Series series = chart.SeriesCollection.AddSeries();
  series.ChartType = ChartType.Column2D;
  series.Add(new double[]{1, 17, 45, 5, 3, 20, 11, 23, 8, 19});
  series.HasDataLabel = true;
&nbsp;
  series = chart.SeriesCollection.AddSeries();
  series.ChartType = ChartType.Line;
  series.Add(new double[]{41, 7, 5, 45, 13, 10, 21, 13, 18, 9});
&nbsp;
  XSeries xseries = chart.XValues.AddXSeries();
  xseries.Add("A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N");
&nbsp;
  chart.XAxis.MajorTickMark = TickMarkType.Outside;
  chart.XAxis.Title.Caption = "X-Axis";
&nbsp;
  chart.YAxis.MajorTickMark = TickMarkType.Outside;
  chart.YAxis.HasMajorGridlines = true;
&nbsp;
  chart.PlotArea.LineFormat.Color = Colors.DarkGray;
  chart.PlotArea.LineFormat.Width = 1;
&nbsp;
  document.LastSection.Add(chart);
}
{s:endCsharp}

{s:sampleSourceCode}
Meta Keywords:
Meta Description:
Change Comment:
Miscellaneous
Home
PDFsharp
FAQ
Samples
Articles
MigraDoc
FAQ
Samples
Articles
PDFsharp and MigraDoc Wiki

Navigation¶

MigraDoc Sample: Hello MigraDoc
