Lists

A List is a content node holding ListItem item labels like numbers, letters, or roman numerals. They are generated and renumbered automatically during pagination.

Info

The list class is named List in most languages. Exceptions include ListContainer in PHP because list is a reserved word, PTList in Objective-C, and PDFNet.List in JavaScript.

Simple list

AddList creates a list and AddItem appends an item. A ListItem is a content container in its own right, so its content is added as paragraphs.

List list = doc.AddList();
list.SetNumberFormat(List.NumberFormat.e_decimal, ".", true);

list.AddItem().AddParagraph("Create a FlowDocument.");
list.AddItem().AddParagraph("Append content to it.");
list.AddItem().AddParagraph("Paginate it into a PDF.");

List list = doc.AddList();
list.SetNumberFormat(List::e_decimal, ".", true);

list.AddItem().AddParagraph("Create a FlowDocument.");
list.AddItem().AddParagraph("Append content to it.");
list.AddItem().AddParagraph("Paginate it into a PDF.");

list := doc.AddList()
list.SetNumberFormat(ListE_decimal, ".", true)

list.AddItem().AddParagraph("Create a FlowDocument.")
list.AddItem().AddParagraph("Append content to it.")
list.AddItem().AddParagraph("Paginate it into a PDF.")

List list = doc.addList();
list.setNumberFormat(List.ListItemNumberFormat.e_decimal, ".", true);

list.addItem().addParagraph("Create a FlowDocument.");
list.addItem().addParagraph("Append content to it.");
list.addItem().addParagraph("Paginate it into a PDF.");

const list = await doc.addList();
list.setNumberFormat(PDFNet.List.NumberFormat.e_decimal, '.', true);

await (await list.addItem()).addParagraphWithText('Create a FlowDocument.');
await (await list.addItem()).addParagraphWithText('Append content to it.');
await (await list.addItem()).addParagraphWithText('Paginate it into a PDF.');

PTList* list = [doc AddList];
[list SetNumberFormatWithSuffix:e_ptlist_format_decimal suffix:@"." cascade:YES];

[[list AddItem] AddParagraphWithText:@"Create a FlowDocument."];
[[list AddItem] AddParagraphWithText:@"Append content to it."];
[[list AddItem] AddParagraphWithText:@"Paginate it into a PDF."];

$list = $doc->AddList();
$list->SetNumberFormat(ListContainer::e_decimal, ".", true);

$list->AddItem()->AddParagraph("Create a FlowDocument.");
$list->AddItem()->AddParagraph("Append content to it.");
$list->AddItem()->AddParagraph("Paginate it into a PDF.");

list = doc.AddList()
list.SetNumberFormat(List.e_decimal, ".", True)

list.AddItem().AddParagraph("Create a FlowDocument.")
list.AddItem().AddParagraph("Append content to it.")
list.AddItem().AddParagraph("Paginate it into a PDF.")

list = doc.AddList()
list.SetNumberFormat(List::E_decimal, ".", true)

list.AddItem().AddParagraph("Create a FlowDocument.")
list.AddItem().AddParagraph("Append content to it.")
list.AddItem().AddParagraph("Paginate it into a PDF.")

Number formats

SetNumberFormat selects the label style. The three-argument overload also sets the suffix printed after the label and whether the format cascades to nested lists.

Examples of number formatting like roman numerals.

Number formatting options include:

Value

Labels

e_none

(no label - an unordered list)

e_decimal

1, 2, 3

e_decimal_zero

01, 02, 03

e_lower_roman

i, ii, iii

e_upper_roman

I, II, III

e_lower_letter

a, b, c

e_upper_letter

A, B, C

e_ordinal

1st, 2nd, 3rd

e_ordinal_text

First, Second, Third

e_cardinal_text

One, Two, Three

e_chinese_counting

Chinese counting numerals

e_chinese_counting_thousand

Chinese counting numerals, thousands

Use SetStartIndex to begin numbering somewhere other than 1.

Nest lists

A ListItem can contain a nested List through its own AddList. Nested lists are indented automatically and can use their own number format.

List list = doc.AddList();
list.SetNumberFormat(List.NumberFormat.e_decimal, ".", true);
list.GetLabelStyle().SetBold(true);

list.AddItem().AddParagraph("Revenue grew in every region.");

ListItem risks = list.AddItem();
risks.AddParagraph("Risks for the Q4 forecast:");

List riskList = risks.AddList();
riskList.SetNumberFormat(List.NumberFormat.e_lower_letter, ")", true);
riskList.AddItem().AddParagraph("Currency fluctuations.");
riskList.AddItem().AddParagraph("Longer sales cycles.");

list.AddItem().AddParagraph("Hiring continues as planned.");

List list = doc.AddList();
list.SetNumberFormat(List::e_decimal, ".", true);
list.GetLabelStyle().SetBold(true);

list.AddItem().AddParagraph("Revenue grew in every region.");

ListItem risks = list.AddItem();
risks.AddParagraph("Risks for the Q4 forecast:");

List risk_list = risks.AddList();
risk_list.SetNumberFormat(List::e_lower_letter, ")", true);
risk_list.AddItem().AddParagraph("Currency fluctuations.");
risk_list.AddItem().AddParagraph("Longer sales cycles.");

list.AddItem().AddParagraph("Hiring continues as planned.");

list := doc.AddList()
list.SetNumberFormat(ListE_decimal, ".", true)
list.GetLabelStyle().SetBold(true)

list.AddItem().AddParagraph("Revenue grew in every region.")

risks := list.AddItem()
risks.AddParagraph("Risks for the Q4 forecast:")

riskList := risks.AddList()
riskList.SetNumberFormat(ListE_lower_letter, ")", true)
riskList.AddItem().AddParagraph("Currency fluctuations.")
riskList.AddItem().AddParagraph("Longer sales cycles.")

list.AddItem().AddParagraph("Hiring continues as planned.")

List list = doc.addList();
list.setNumberFormat(List.ListItemNumberFormat.e_decimal, ".", true);
list.getLabelStyle().setBold(true);

list.addItem().addParagraph("Revenue grew in every region.");

ListItem risks = list.addItem();
risks.addParagraph("Risks for the Q4 forecast:");

List riskList = risks.addList();
riskList.setNumberFormat(List.ListItemNumberFormat.e_lower_letter, ")", true);
riskList.addItem().addParagraph("Currency fluctuations.");
riskList.addItem().addParagraph("Longer sales cycles.");

list.addItem().addParagraph("Hiring continues as planned.");

const list = await doc.addList();
list.setNumberFormat(PDFNet.List.NumberFormat.e_decimal, '.', true);
(await list.getLabelStyle()).setBold(true);

await (await list.addItem()).addParagraphWithText('Revenue grew in every region.');

const risks = await list.addItem();
await risks.addParagraphWithText('Risks for the Q4 forecast:');

const riskList = await risks.addList();
riskList.setNumberFormat(PDFNet.List.NumberFormat.e_lower_letter, ')', true);
await (await riskList.addItem()).addParagraphWithText('Currency fluctuations.');
await (await riskList.addItem()).addParagraphWithText('Longer sales cycles.');

await (await list.addItem()).addParagraphWithText('Hiring continues as planned.');

PTList* list = [doc AddList];
[list SetNumberFormatWithSuffix:e_ptlist_format_decimal suffix:@"." cascade:YES];
[[list GetLabelStyle] SetBold:YES];

[[list AddItem] AddParagraphWithText:@"Revenue grew in every region."];

PTListItem* risks = [list AddItem];
[risks AddParagraphWithText:@"Risks for the Q4 forecast:"];

PTList* risk_list = [risks AddList];
[risk_list SetNumberFormatWithSuffix:e_ptlist_format_lower_letter suffix:@")" cascade:YES];
[[risk_list AddItem] AddParagraphWithText:@"Currency fluctuations."];
[[risk_list AddItem] AddParagraphWithText:@"Longer sales cycles."];

[[list AddItem] AddParagraphWithText:@"Hiring continues as planned."];

$list = $doc->AddList();
$list->SetNumberFormat(ListContainer::e_decimal, ".", true);
$list->GetLabelStyle()->SetBold(true);

$list->AddItem()->AddParagraph("Revenue grew in every region.");

$risks = $list->AddItem();
$risks->AddParagraph("Risks for the Q4 forecast:");

$risk_list = $risks->AddList();
$risk_list->SetNumberFormat(ListContainer::e_lower_letter, ")", true);
$risk_list->AddItem()->AddParagraph("Currency fluctuations.");
$risk_list->AddItem()->AddParagraph("Longer sales cycles.");

$list->AddItem()->AddParagraph("Hiring continues as planned.");

list = doc.AddList()
list.SetNumberFormat(List.e_decimal, ".", True)
list.GetLabelStyle().SetBold(True)

list.AddItem().AddParagraph("Revenue grew in every region.")

risks = list.AddItem()
risks.AddParagraph("Risks for the Q4 forecast:")

risk_list = risks.AddList()
risk_list.SetNumberFormat(List.e_lower_letter, ")", True)
risk_list.AddItem().AddParagraph("Currency fluctuations.")
risk_list.AddItem().AddParagraph("Longer sales cycles.")

list.AddItem().AddParagraph("Hiring continues as planned.")

list = doc.AddList()
list.SetNumberFormat(List::E_decimal, ".", true)
list.GetLabelStyle().SetBold(true)

list.AddItem().AddParagraph("Revenue grew in every region.")

risks = list.AddItem()
risks.AddParagraph("Risks for the Q4 forecast:")

risk_list = risks.AddList()
risk_list.SetNumberFormat(List::E_lower_letter, ")", true)
risk_list.AddItem().AddParagraph("Currency fluctuations.")
risk_list.AddItem().AddParagraph("Longer sales cycles.")

list.AddItem().AddParagraph("Hiring continues as planned.")

Style labels

GetLabelStyle returns a TextStyledElement that applies to the generated labels only, leaving item text untouched. This is how you make numbers bold or colored without affecting the content. Item text is styled as usual, through the paragraph inside the item.

TextStyledElement labels = list.GetLabelStyle();
labels.SetBold(true);
labels.SetTextColor(0, 51, 102);

Paragraph itemText = list.AddItem().AddParagraph("An emphasized item.");
itemText.GetTextStyledElement().SetItalic(true);

TextStyledElement labels = list.GetLabelStyle();
labels.SetBold(true);
labels.SetTextColor(0, 51, 102);

Paragraph item_text = list.AddItem().AddParagraph("An emphasized item.");
item_text.GetTextStyledElement().SetItalic(true);

labels := list.GetLabelStyle()
labels.SetBold(true)
labels.SetTextColor(0, 51, 102)

itemText := list.AddItem().AddParagraph("An emphasized item.")
itemText.GetTextStyledElement().SetItalic(true)

TextStyledElement labels = list.getLabelStyle();
labels.setBold(true);
labels.setTextColor(0, 51, 102);

Paragraph itemText = list.addItem().addParagraph("An emphasized item.");
itemText.getTextStyledElement().setItalic(true);

const labels = await list.getLabelStyle();
labels.setBold(true);
labels.setTextColor(0, 51, 102);

const itemText = await (await list.addItem()).addParagraphWithText('An emphasized item.');
(await itemText.getTextStyledElement()).setItalic(true);

PTTextStyledElement* labels = [list GetLabelStyle];
[labels SetBold:YES];
[labels SetTextColor:0 green:51 blue:102];

PTParagraph* item_text = [[list AddItem] AddParagraphWithText:@"An emphasized item."];
[[item_text GetTextStyledElement] SetItalic:YES];

$labels = $list->GetLabelStyle();
$labels->SetBold(true);
$labels->SetTextColor(0, 51, 102);

$item_text = $list->AddItem()->AddParagraph("An emphasized item.");
$item_text->GetTextStyledElement()->SetItalic(true);

labels = list.GetLabelStyle()
labels.SetBold(True)
labels.SetTextColor(0, 51, 102)

item_text = list.AddItem().AddParagraph("An emphasized item.")
item_text.GetTextStyledElement().SetItalic(True)

labels = list.GetLabelStyle()
labels.SetBold(true)
labels.SetTextColor(0, 51, 102)

item_text = list.AddItem().AddParagraph("An emphasized item.")
item_text.GetTextStyledElement().SetItalic(true)

Continue a list

Adding non-list content between items normally ends the list, so a following AddItem starts fresh numbering. ContinueList marks the list as the logical continuation of the earlier one, so numbering carries on across the interruption.

List steps = doc.AddList();
steps.SetNumberFormat(List.NumberFormat.e_decimal, ".", true);
steps.AddItem().AddParagraph("Install the SDK.");
steps.AddItem().AddParagraph("Add your license key.");

doc.AddParagraph("Note: the license key is required before any other call.");

// Resume the same numbering after the interrupting paragraph.
steps.ContinueList();
steps.AddItem().AddParagraph("Build your first document.");

List steps = doc.AddList();
steps.SetNumberFormat(List::e_decimal, ".", true);
steps.AddItem().AddParagraph("Install the SDK.");
steps.AddItem().AddParagraph("Add your license key.");

doc.AddParagraph("Note: the license key is required before any other call.");

// Resume the same numbering after the interrupting paragraph.
steps.ContinueList();
steps.AddItem().AddParagraph("Build your first document.");

steps := doc.AddList()
steps.SetNumberFormat(ListE_decimal, ".", true)
steps.AddItem().AddParagraph("Install the SDK.")
steps.AddItem().AddParagraph("Add your license key.")

doc.AddParagraph("Note: the license key is required before any other call.")

// Resume the same numbering after the interrupting paragraph.
steps.ContinueList()
steps.AddItem().AddParagraph("Build your first document.")

List steps = doc.addList();
steps.setNumberFormat(List.ListItemNumberFormat.e_decimal, ".", true);
steps.addItem().addParagraph("Install the SDK.");
steps.addItem().addParagraph("Add your license key.");

doc.addParagraph("Note: the license key is required before any other call.");

// Resume the same numbering after the interrupting paragraph.
steps.continueList();
steps.addItem().addParagraph("Build your first document.");

const steps = await doc.addList();
steps.setNumberFormat(PDFNet.List.NumberFormat.e_decimal, '.', true);
await (await steps.addItem()).addParagraphWithText('Install the SDK.');
await (await steps.addItem()).addParagraphWithText('Add your license key.');

await doc.addParagraphWithText('Note: the license key is required before any other call.');

// Resume the same numbering after the interrupting paragraph.
steps.continueList();
await (await steps.addItem()).addParagraphWithText('Build your first document.');

PTList* steps = [doc AddList];
[steps SetNumberFormatWithSuffix:e_ptlist_format_decimal suffix:@"." cascade:YES];
[[steps AddItem] AddParagraphWithText:@"Install the SDK."];
[[steps AddItem] AddParagraphWithText:@"Add your license key."];

[doc AddParagraphWithText:@"Note: the license key is required before any other call."];

// Resume the same numbering after the interrupting paragraph.
[steps ContinueList];
[[steps AddItem] AddParagraphWithText:@"Build your first document."];

$steps = $doc->AddList();
$steps->SetNumberFormat(ListContainer::e_decimal, ".", true);
$steps->AddItem()->AddParagraph("Install the SDK.");
$steps->AddItem()->AddParagraph("Add your license key.");

$doc->AddParagraph("Note: the license key is required before any other call.");

// Resume the same numbering after the interrupting paragraph.
$steps->ContinueList();
$steps->AddItem()->AddParagraph("Build your first document.");

steps = doc.AddList()
steps.SetNumberFormat(List.e_decimal, ".", True)
steps.AddItem().AddParagraph("Install the SDK.")
steps.AddItem().AddParagraph("Add your license key.")

doc.AddParagraph("Note: the license key is required before any other call.")

# Resume the same numbering after the interrupting paragraph.
steps.ContinueList()
steps.AddItem().AddParagraph("Build your first document.")

steps = doc.AddList()
steps.SetNumberFormat(List::E_decimal, ".", true)
steps.AddItem().AddParagraph("Install the SDK.")
steps.AddItem().AddParagraph("Add your license key.")

doc.AddParagraph("Note: the license key is required before any other call.")

# Resume the same numbering after the interrupting paragraph.
steps.ContinueList()
steps.AddItem().AddParagraph("Build your first document.")