Cmdlet

Add-OfficeWordListItem

Aliases: WordListItem

Module: PSWriteOffice
Aliases: WordListItem
Inputs: OfficeIMO.Word.WordList
Outputs: OfficeIMO.Word.WordParagraph
Source: AddOfficeWordListItemCommand.cs:25 Edit on GitHub

Adds a single list item.

Syntax

Add-OfficeWordListItem
[-Level <Int32>]
[-List <WordList>]
[-PassThru]
[-Text] <String>
[<CommonParameters>]

Parameter set: Text

Add-OfficeWordListItem
[-Content] <ScriptBlock>
[-Level <Int32>]
[-List <WordList>]
[-PassThru]
[<CommonParameters>]

Parameter set: Content

Description

Can be called within Add-OfficeWordList/WordList or against an existing WordList from the pipeline; supports nesting via -Level.

Examples

Add bullet text.

WordList { Add-OfficeWordListItem -Text 'First task' }

Creates a bullet with the text “First task”.

Append to an existing list.

Find-OfficeWordList -Document $doc -Text 'Initial review' | Add-OfficeWordListItem -Text 'Final approval'

Finds a list in an existing document and appends a new item.

Parameters

-Level Int32 optional: One-based list level, from 1 to 9.
-List WordList optionalpipeline: True (ByValue): Existing list to append to. When omitted, the current DSL list is used.
-PassThru SwitchParameter optional: Emit the created WordParagraph.
-Text String requiredposition: 0sets: Text: List item text.
-Content ScriptBlock requiredposition: 0sets: Content: Rich item content composed with WordText.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.