How To Create A PDF With Multilevel List in C#
How To Create A PDF With Multilevel List in C#
Brief
The article describes how to create a PDF document with Multilevel List
in C# using PDFFlow library.
Library website: https://www.pdfflow.io
Nuget package: https://www.nuget.org/packages/Gehtsoft.PDFFlowLib
Details
PDF document consists of sections. A section may have as many multilevel
lists as you need.
Creating a list with PDFFlow is only a few lines of code:
1. First you need to create DocumentBuilder.
2. Then add Section to it.
3. Now add as many Paragraphs to Section, as many list items you need.
4. Make each Paragraph a list item, set level and style if needed.
You can make a paragraph an item of a numbered multilevel list using the
ParagraphBuilder.SetListNumbered method. For each item, you can specify
the numbering style, the level of the list, the left indent, and enable
the hierarchic numeration is necessary. Items of a numbered list are
numbered automatically on each level. The available numbering styles are:
Arabic numbers, lower and upper Roman numbers, lower and upper Latin
letters, lower and upper Cyrillic letters (see the NumerationStyle
enumeration).
You can make a paragraph an item of a bulleted multilevel list using the
ParagraphBuilder.SetListBulleted method. For each item, you can specify
the bullet symbol, the level of the list, and the left indent. The
available bullet symbols are a bullet and a dash (see the ListBullet
enumeration).
The default level left indent for a multilevel list is 20f, the default
numbering style of a numbered list is Arabic, the default bullet symbol
is Bullet.
You can configure the formatting settings of list items directly or apply
a style to them using methods of ParagraphBuilder. You can also set a
style for all lists in the section using the SectionBuilder.SetListStyle
method. In this case, you can use the ParagraphBuilder.SetList method to
quickly make the necessary paragraphs list items and the set style will
be applied to all list items in the section.
Once a paragraph which is not an item of a multilevel list is met, the
multilevel list is considered completed.
When later another paragraph is made an item of a multilevel list, it
becomes the first item of a new multilevel list, and its automatic
numeration will start from the beginning.
Examples
Example 6. Set the style and formatting for a list and list items
// Set a style for all lists in the section: numbered, font color red:
StyleBuilder listStyleInCurrentSection =
StyleSheet.DefaultListNumberedBuilder().SetFontColor(Color.Red);
StyleBuilder styleBlue = StyleBuilder.New().SetFontColor(Color.Blue);
StyleBuilder styleListBold =
StyleBuilder.New(StyleSheet.DefaultListNumberedBuilder())
.SetFontBold();
// Create document:
DocumentBuilder.New()
.AddSection()
// Set a style for the lists found in current section:
.SetListStyle(listStyleInCurrentSection)
// Create a list, it will be numbered and have red font color as defined
by the list style for the section:
.AddParagraph("Item 1").SetList().ToSection()
.AddParagraph("Item 2").SetList().ToSection()
.AddParagraph("Item 3").SetList().ToSection()
// Set formatting of one item:
.AddParagraph("Item 4").SetList()
.SetBold()
.SetFontColor(Color.Green)
.ToSection()
// Apply Blue style to paragraph, then apply list formatting. It will be
bulleted, because direct ApplyStyle() has higher priority than
s.SetListStyle():
.AddParagraph("Item 5").ApplyStyle(styleBlue)
.SetList().ToSection()
// Make a paragraph a list item:
.AddParagraph("Item 6")
.ApplyStyle(StyleSheet.DefaultListNumberedBuilder())
.ToSection()
// Make a paragraph a list item and apply the Bold style:
.AddParagraph("Item 7").ApplyStyle(styleListBold)
.ToSection()
// Apply the Bulleted style to a list item. It will be bulleted because
the direct ApplyStyle() has a higher priority than s.SetListStyle():
.AddParagraph("Item 8")
.ApplyStyle(StyleSheet.DefaultListBulletedBuilder())
.ToSection()
// First apply the numbered style, then set the bulleted formatting. The
list will be bulleted because the formatting has a higher priority than
the style:
.AddParagraph("Item 9")
.ApplyStyle(StyleSheet.DefaultListNumberedBuilder())
.SetListBulleted(ListBullet.Dash)
.ToDocument().Build("Result.pdf");
The above code will generate the following:
The PDFFlow library is supplied with source code samples of real business
documents accompanied by descriptive articles:
https://go.pdfflow.io/PDFFlowLibrarySamples.
There are also Tutorials with many working code examples that can be used
as is or modified: https://go.pdfflow.io/PDFFlowLibraryTutorials.
Hope, this article will help you to create complex PDF documents fast and
efficiently.