https://github.com/benfoster/migradoc.extensions

Extensions for MigraDoc/PDFSharp
https://github.com/benfoster/migradoc.extensions

Last synced: 7 days ago
JSON representation

Extensions for MigraDoc/PDFSharp

• Host: GitHub
• URL: https://github.com/benfoster/migradoc.extensions
• Owner: benfoster
• License: mit
• Created: 2013-05-10T09:26:56.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2018-09-24T00:15:49.000Z (about 6 years ago)
• Last Synced: 2024-10-31T15:37:56.788Z (14 days ago)
• Language: C#
• Size: 400 KB
• Stars: 28
• Watchers: 8
• Forks: 18
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# MigraDoc.Extensions

Extensions for [MigraDoc/PDFSharp](http://www.pdfsharp.net/Overview.ashx).

## Quick Start

The biggest feature provided by this library is the ability to convert from HTML and Markdown to PDF, via MigraDoc's Document Object Model.

MigraDoc.Extensions makes use of [MarkdownSharp](https://code.google.com/p/markdownsharp/) to convert from Markdown to HTML and the [Html Agility Pack](http://htmlagilitypack.codeplex.com/) to convert from HTML to PDF.

Since the MigraDoc DOM is pretty basic, much of the conversion involves setting the `Style` of generated MigraDoc `Paragraph` instances. You can then configure these styles however you like. See the [example project](https://github.com/benfoster/MigraDoc.Extensions/blob/master/src/examples/MigraDoc.Extensions.Html.Example/Program.cs#L44) for more details.

#### Converting from Markdown to PDF

Import the `MigraDoc.Extensions.Markdown` namespace and call `AddMarkdown` on a MigraDoc `Section` instance:

	var markdown = @"

		# This is a heading

		This is some **bold** ass text with a [link](http://www.google.com).

		- List Item 1

		- List Item 2

		- List Item 3

		Pretty cool huh?

	";

	section.AddMarkdown(markdown);

#### Converting from HTML to PDF

Import the `MigraDoc.Extensions.Html` namespace and call `AddHtml` on a MigraDoc `Section` instance:

	var html = @"

		
This is a heading


		
This is some **bold** ass text with a link.


		


			
List Item 1

			
List Item 2

			
List Item 3

		


		
Pretty cool huh?

	";


	section.AddHtml(html);

	

#### What is supported?

The HTML converter currently supports the following:

- Headings (H1 -> H6) - Sets a "HeadingX" style on the generated paragraph

- Paragraphs

- Hyperlinks containing plain text or supported inline elements

- Lists - Adds a paragraph with style "ListStart" before the list and one with style "ListEnd" after the list.

  - Unordered Lists - Each list item has the style "UnorderedList"

  - Ordered Lists - Each list item has the style "Ordered List"

- Line breaks 

- Inline elements ``, ``, ``, ``

- Horizontal Rules - Adds a paragraph with style "HorizontalRule"


For more details, check out the [specs](https://github.com/benfoster/MigraDoc.Extensions/blob/master/src/specs/MigraDoc.Extensions.Html.Specs/converting_tags.cs).

#### Extending the HTML converter

To add a custom handler, create a new instance of `HtmlConverter` and add to its `NodeHandlers` dictionary. The key is the HTML element you wish to handle and the value is a `Func` element:

    nodeHandlers.Add("strong", (node, parent) => {

        var format = TextFormat.Bold;

        

        var formattedText = parent as FormattedText;

        if (formattedText != null)

        {

            return formattedText.Format(format);

        }

        // otherwise parent is paragraph or section

        return GetParagraph(parent).AddFormattedText(format);

    });

In the above handler, we need to cater for nested format tags (e.g. `some text`) so we first attempt to cast the parent as `FormattedText`, otherwise fall back to adding formatted text to a `Paragraph`. Unfortunately such type checks are fairly frequent due to the limited relationships between objects in the MigraDoc DOM.

To use a custom converter instance use the `Section.Add(string content, IConverter converter)` extension in the `MigraDoc.Extensions` namespace.

Note that an element handler should not process any inner HTML. For example the handler for a `
` tag only adds a paragraph with a the style "Heading1", it does not add the text (there is a separate handler for processing text nodes).


## License

Licensed under the MIT License.