Get Started

API Reference

Class

PdfListItem

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Model/PdfListItem.cs:17
Modifiers sealed

List item text with optional rich inline runs.

Inheritance

  • Object
  • PdfListItem

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

PdfListItem 2 overloads
public PdfListItem(String text, String bookmarkName = null, String marker = null) #
OfficeIMO.Pdf/Model/PdfListItem.cs:17

Create a plain list item.

Parameters

text System.String requiredposition: 0
bookmarkName System.String = null optionalposition: 1
marker System.String = null optionalposition: 2
public PdfListItem(IEnumerable<TextRun> runs, String bookmarkName = null, String marker = null) #
OfficeIMO.Pdf/Model/PdfListItem.cs:33

Create a rich list item from inline text runs.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
bookmarkName System.String = null optionalposition: 1
marker System.String = null optionalposition: 2

Methods

public static PdfListItem Plain(String text, String bookmarkName = null, String marker = null) #
OfficeIMO.Pdf/Model/PdfListItem.cs:61
Returns: PdfListItem

Create a normal unstyled item.

Parameters

text System.String requiredposition: 0
bookmarkName System.String = null optionalposition: 1
marker System.String = null optionalposition: 2
public static PdfListItem Rich(IEnumerable<TextRun> runs, String bookmarkName = null, String marker = null) #
OfficeIMO.Pdf/Model/PdfListItem.cs:64
Returns: PdfListItem

Create a rich item from inline text runs.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
bookmarkName System.String = null optionalposition: 1
marker System.String = null optionalposition: 2

Properties

public String Text { get; } #
OfficeIMO.Pdf/Model/PdfListItem.cs:8

Plain text value for readback, wrapping fallback, and simple item APIs.

public IReadOnlyList<TextRun> Runs { get; } #
OfficeIMO.Pdf/Model/PdfListItem.cs:10

Rich inline runs rendered as the list item body.

public String BookmarkName { get; } #
OfficeIMO.Pdf/Model/PdfListItem.cs:12

Optional named destination anchored to this list item.

public String Marker { get; } #
OfficeIMO.Pdf/Model/PdfListItem.cs:14

Optional explicit marker rendered instead of the list block default marker.