PdfOrderedList class

Represents the ordered list.

//Create a new PDF document.
PdfDocument document = PdfDocument();
//Create a new ordered list.
PdfOrderedList(
    items: PdfListItemCollection(['PDF', 'XlsIO', 'DocIO', 'PPT']),
    font: PdfStandardFont(PdfFontFamily.helvetica, 16,
        style: PdfFontStyle.italic),
    format: PdfStringFormat(lineSpacing: 20),
    marker: PdfOrderedMarker(style: PdfNumberStyle.numeric),
    style: PdfNumberStyle.numeric,
    indent: 15,
    textIndent: 10)
  ..draw(
      page: document.pages.add(), bounds: const Rect.fromLTWH(20, 20, 0, 0));
//Save the document.
List<int> bytes = await document.save();
//Dispose the document.
document.dispose();
Inheritance

Constructors

PdfOrderedList({PdfOrderedMarker? marker, PdfListItemCollection? items, String? text, PdfFont? font, PdfNumberStyle style = PdfNumberStyle.numeric, PdfStringFormat? format, bool markerHierarchy = false, double indent = 10, double textIndent = 5})
Initialize a new instance of the PdfOrderedList class.

Properties

beginItemLayout ↔ BeginItemLayoutCallback?
Event that rises when item begin layout.
getter/setter pairinherited
beginPageLayout ↔ BeginPageLayoutCallback?
Raises before the element should be printed on the page.
getter/setter pairinherited
brush ↔ PdfBrush?
The brush for the list.
getter/setter pairinherited
endItemLayout ↔ EndItemLayoutCallback?
Event that rises when item end layout.
getter/setter pairinherited
endPageLayout ↔ EndPageLayoutCallback?
Raises after the element was printed on the page.
getter/setter pairinherited
font ↔ PdfFont?
Gets or sets the list font.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
indent ↔ double
Tabulation for items.
getter/setter pairinherited
items → PdfListItemCollection
Gets items of the list.
no setterinherited
marker ↔ PdfOrderedMarker
Gets or sets marker of the list items.
getter/setter pair
markerHierarchy ↔ bool
True if user want to use numbering hierarchy, otherwise false.
getter/setter pair
pen ↔ PdfPen?
The pen for the list.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringFormat ↔ PdfStringFormat?
The string format for the list.
getter/setter pairinherited
textIndent ↔ double
Indent between marker and text.
getter/setter pairinherited

Methods

draw({PdfGraphics? graphics, PdfPage? page, Rect? bounds, PdfLayoutFormat? format}) → PdfLayoutResult?
Draws an element on the graphics or page.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited