Lists with iTextSharp

Having already looked at how to create a PDF document with iTextSharp, set fonts and their styles and add text, this article turns its attention to lists. Ordered and unordered lists will be covered. You may want to review earlier articles in this series, if you haven't already done so.

Create PDFs in ASP.NET - getting started with iTextSharp
iTextSharp - Working with Fonts
iTextSharp - Adding Text with Chunks, Phrases and Paragraphs

Lists are generated from the iTextSharp.text.List object. A List is a collection of iTextSharp.text.ListItem objects. Actually, it is an ArrayList of ListItem objects. ListItem inherits from Paragraph (which inherits from Phrase, which inherits from ArrayList), so each item in the list is rendered on a new line. As with their html <ul> and <ol> counterparts, Lists can be UNORDERED or ORDERED (numbered). Diving straight into code, here's how to generate a List:

 

string path = Server.MapPath("PDFs");

it.Document doc = new it.Document();

try

{

    PdfWriter.GetInstance(doc, new FileStream(path + "/Lists.pdf", FileMode.Create));

    doc.Open();

    it.List list = new it.List(it.List.UNORDERED);

    list.Add(new it.ListItem("One"));

    list.Add("Two");

    list.Add("Three");

    list.Add("Four");

    list.Add("Five");

    it.Paragraph paragraph = new it.Paragraph();

    string text = "Lists";

    paragraph.Add(text);

    doc.Add(paragraph);

    doc.Add(list);

}

catch (it.DocumentException dex)

{

    Response.Write(dex.Message);

}

catch (IOException ioex)

{

    Response.Write(ioex.Message);

}

finally

{

    doc.Close();

}

 

If you are not familiar with the concept, the way that a List or ListItem is referenced in the above code needs explaining. As you can see, "it." is used as a prefix for some objects. If you are coding your PDF generation within an ASP.NET code-behind file, you will probably be working with the default set of namespaces that Visual Stuido references when the aspx.cs file is created. One of those namespaces is System.Web.UI.WebControls, which also includes a ListItem class. That means that attempting to simply add


ListItem li = new ListItem();

to your code will result in a warning of ambiguity. The way to resolve this is to fully reference the ListItem class you are attempting to use by adding its namespace:


iTextSharp.text.ListItem li = new iTextSharp.text.ListItem();

All that extra typing can get very boring, so you can shortcut the namespace by providing an alias to it:


using
it = iTextSharp.text;

Now you can use the alias instead.

Back to what the code actually does - the first thing is to create a new List object, and to pass in a bool to indicate whether it is an ordered, or numbered list or not. The default is false. The code doesn't do much more except add 5 items to the list. The first is added by creating a new ListItem object, and setting its string value. The second and subsequent items are added directly to the List object as strings. Finally, a Paragraph is created and added to the document, followed by the List being added to the document. The result is this:

As you can see, each item acts like a Paragraph as promised, in that it occupies a new line. You will also note that the default settings provide a boring list with hyphens as symbols for each ListItem, and none of the usual indentation that you would get if you were using Microsoft Word, for example. iTextSharp provides ways to format the List so that it looks a lot better.

 

it.List list = new it.List(it.List.UNORDERED, 10f);

list.SetListSymbol("\u2022");

list.IndentationLeft = 30f;

 

A second argument (float) is passed in to the List constructor, which sets the symbolIndent value at 10 points. This results in the space between the symbol and the item itself being increased. Secondly, the actual symbol is changed to the more traditional bullet point using the setListSymbol() method. Finally, the List is indented 30 points from the left margin of the document. The result looks a little more pleasing:

If you like your ordered lists with Roman numerals, you can use the RomanList class:


RomanList romanlist = new RomanList(true, 20);

romanlist.IndentationLeft = 30f;

romanlist.Add("One");

romanlist.Add("Two");

romanlist.Add("Three");

romanlist.Add("Four");

romanlist.Add("Five");

doc.Add(romanlist);

 

For some odd reason, the symbolIdent value passed into the constructor is an int this time, instead of a float. The first argument is a bool that tells iTextSharp whether you want lowercase symbols or not.

A separate GreekList class supplies list symbols as Greek letters, and two further classes: ZapfDingbatsList and ZapfDingbatsNumberList offer more symbol formatting opportunities as they make use of the ZapfDingBats font. The Greek and Roman lists should never be used for lists that contain more than 24 and 26 items respectively, and the ZapfDingBatsNumberList can only cope with a maximum of 10 items before the numbering runs out and becomes 0.

 

ZapfDingbatsList zlist = new it.ZapfDingbatsList(49, 15);

zlist.Add("One");

zlist.Add("Two");

zlist.Add("Three");

zlist.Add("Four");

zlist.Add("Five");

doc.Add(zlist);

 

Lists can also be nested. Since the List.Add() method accepts an object, all you need to do is to pass in a valid List() object. The following code creates a RomanList first, then an ordered list. The RomanList is added to the ordered list, and iTextSharp indents the RomanList relative to the ordered list to which it belongs:

 

RomanList romanlist = new RomanList(true, 20);

romanlist.IndentationLeft = 10f;

romanlist.Add("One");

romanlist.Add("Two");

romanlist.Add("Three");

romanlist.Add("Four");

romanlist.Add("Five");

 

List list = new List(List.ORDERED, 20f);

list.SetListSymbol("\u2022");

list.IndentationLeft = 20f;

list.Add("One");

list.Add("Two");

list.Add("Three");

list.Add("Roman List");

list.Add(romanlist);

list.Add("Four");

list.Add("Five");

 

doc.Add(paragraph);

doc.Add(list);

 

 

Date Posted:
Last Updated:
Posted by:
Total Views to date: 86529

10 Comments

- NIKHIL

Nice code

- Nameless

great code, but how about aligment of the list?

- Mike

@Nameless

Aligning them with what? If you mean managing the indentation of list items, the article discusses that.

- The Undertaker

How can I make the direction of the list from right to left. I have used PdfWriter.RUN_DIRECTION_RTL but it just align the text to the right side of the document and the bullets remain on the left side

- Mike

@Undertaker

I believe that you can only set text to run from right to left if one of the following conditions are satisfied: the text is absolutely positioned; or the text appears in a table cell, ColumnText or MultiColumnText object.

If you click the iTextSharp link in the Categories list at the top of the page, you will find a couple of articles on tables and columns that should help.

- MOHAN LAL

the code which is very fantastic..... i have solve a huge problem by using that.... thanks dud.....

- Sara Mendez

Cool stuff Mike, thanks!
But, how can I position the list somewhere on my document? Can I use it in a column? At the moment, I habe better results if I use a table, with 2 columns, one for the bullets and one for the text. So I can put the table wherever I want. Using lists would be maybe more elegant... what about absolute positoining?
thx and greetings from Vienna.

- Baskaran

Hi Mike, can you please tell how to add header and footer to each page. Also i need to know how to insert page numbers for each page.

thanks in advance

- Scott

Thanks so much for these guides. Using them and other posts I've dug up, I've managed to produce very large pdfs rather quickly.

One problem I found with Lists was that KeepTogether did not work. I could solve that by loading the ListItem with a paragraph (having its own KeepTogether), but that somehow killed the bullet/number (using a Phrase kept the bullet, but that lacks KeepTogether). As such, I had to turn to tables for my solution. I was pleasantly surprised that tables did not add significantly to the document size (though it did seem to lose some speed).

- Shubhendu

Do we have code for larger sized bullets?

Recent Comments

sandeep 8/28/2015 7:03 AM
In response to 7 C# 6.0 Features That Every ASP.NET Developer Should Know About
very good article, i like it........keep writing such quality article in future. thx Mike....

Hassan, MVC Learner 8/28/2015 6:37 AM
In response to Get The Drop On ASP.NET MVC DropDownLists
Great Help, simple, great and patiently explained article !...

Anvesh 8/28/2015 12:39 AM
In response to ASP.NET MVC DropDownLists - Multiple Selection and Enum Support
what if we are taking postback values from FormCollections instead of an array int[] category. How...

Ben 8/27/2015 10:50 PM
In response to Simple File Download Protection with ASP.NET
Is it possible to setup your project to publish files to outside of your root directory? I would to...

Fred 8/26/2015 12:50 AM
In response to WebMatrix Opens Wrong Version Of Visual Studio
I enjoyed many of your tutorials but the problem is none of the tutorials are combined like most be....

Muhammad Ashikuzzaman 8/25/2015 2:48 PM
In response to Managing Checkboxes And Radios In ASP.NET Razor Web Pages
That's a very good tips for razor...

Sergey 8/25/2015 8:32 AM
In response to More Flexible Routing For ASP.NET Web Pages
Hi. How I can set up my site to get urldata from link for default page? site.com/default/1-...

Tony Gray 8/25/2015 6:27 AM
In response to Adding Validation
Hi Mike, Really helpful article and series. Thanks. Small typo in 4th paragraph you have so...

amanda n 8/25/2015 12:38 AM
In response to Solving the Operation Must Use An Updateable Query error
Thank you very much. I'm a uni student and while solving coding problems is usually enjoyable and me...

salman 8/23/2015 9:25 AM
In response to How To Send Email In ASP.NET MVC
thanks ......