API Reference
IWorkPagesNumberedList
Owns a decimal list whose items occupy separate paragraphs in one newly created Pages document.
Inheritance
- Object
- IWorkPagesNumberedList
Remarks
Items use nine non-tiered levels and whole-point font sizes. Markers remain plain black in the list's font family; their size follows the first character run. Rich runs can vary their size, font family, opaque color and character decorations. Plain paragraphs and attachments preserve counters. Returning to this list after another list resumes its counters. Advancing or restarting a parent resets all its descendant counters. Instances are not thread safe.
Usage
Explore 3 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
Methods
public IWorkPagesParagraphData AddItem(String text, Int32 level = 0, Int32? restartAt = null, IWorkPagesParagraphLayout? layout = null) #IWorkPagesParagraphDataAdds one numbered body paragraph, continuing its level unless a positive restart is supplied.
Parameters
- text System.String
- Item text without line breaks. TAB text requires an explicit layout.
- level System.Int32 = 0
- Zero-based native level from zero through eight. A nested item requires an earlier parent at the preceding level in this list.
- restartAt System.Int32? = null
- Optional positive counter value. The first parent starts at one by default.
- layout OfficeIMO.IWork.IWorkPagesParagraphLayout? = null
- Optional immutable paragraph spacing and tab stops.
public IWorkPagesParagraphData AddRichItem(IEnumerable<IWorkTextRunData> runs, Int32 level = 0, Int32? restartAt = null, IWorkPagesParagraphLayout? layout = null) #IWorkPagesParagraphDataAdds a snapshot of rich character runs as one numbered body paragraph.
Parameters
- runs System.Collections.Generic.IEnumerable<OfficeIMO.IWork.IWorkTextRunData>
- Runs with whole-point sizes. Sizes, font families, opaque colors and character decorations may vary.
- level System.Int32 = 0
- Zero-based native level from zero through eight. A nested item requires an earlier parent at the preceding level in this list.
- restartAt System.Int32? = null
- Optional positive counter value. The first parent starts at one by default.
- layout OfficeIMO.IWork.IWorkPagesParagraphLayout? = null
- Optional immutable paragraph spacing and tab stops.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String FontName { get; } #Gets the marker font and default body font.
public Single FontSizePoints { get; } #Gets the default whole-point body size, also used for paragraph-relative indentation.
public IWorkDecimalListMarkerStyle MarkerStyle { get; } #Gets the decimal marker punctuation shared by every level of this list.
public IReadOnlyList<IWorkPagesParagraphData> Items { get; } #Gets this list's items in their body insertion order.