OfficeIMO

API Reference

Class

ListBuilder

Namespace OfficeIMO.Word.Fluent
Assembly OfficeIMO.Word

Builder for lists.

Inheritance

  • Object
  • ListBuilder

Methods

public ListBuilder BulletCharacter(String character) #
Returns: ListBuilder

Sets a custom bullet character for the current list level.

Parameters

character System.String requiredposition: 0
Bullet character to use.
public ListBuilder Bulleted(WordListStyle style = Bulleted) #
Returns: ListBuilder

Starts a bulleted list using the specified style.

Parameters

style OfficeIMO.Word.WordListStyle = Bulleted optionalposition: 0
Optional list style.
public ListBuilder Indent() #
Returns: ListBuilder

Increases nesting level for subsequent items.

public ListBuilder Item(String text) #
Returns: ListBuilder

Adds an item to the list at the current level.

Parameters

text System.String requiredposition: 0
Item text.
public ListBuilder ItemTask(String text, Boolean done = false) #
Returns: ListBuilder

Adds a task (checkbox) item to the list (Markdown parity helper).

Parameters

text System.String requiredposition: 0
done System.Boolean = false optionalposition: 1
public ListBuilder Level(Int32 level) #
Returns: ListBuilder

Sets the nesting level for subsequent items.

Parameters

level System.Int32 requiredposition: 0
The explicit level to apply.
public ListBuilder Numbered(WordListStyle style = Numbered) #
Returns: ListBuilder

Starts a numbered list using the specified style.

Parameters

style OfficeIMO.Word.WordListStyle = Numbered optionalposition: 0
Optional numbered list style.
public ListBuilder NumberFormat(NumberFormatValues format) #
Returns: ListBuilder

Sets the numbering format for the current list level.

Parameters

format DocumentFormat.OpenXml.Wordprocessing.NumberFormatValues requiredposition: 0
Number format to apply.
public ListBuilder Outdent() #
Returns: ListBuilder

Decreases nesting level for subsequent items.

public ListBuilder StartAt(Int32 start) #
Returns: ListBuilder

Sets the starting number for the list.

Parameters

start System.Int32 requiredposition: 0
Starting number.