Add-OfficeWordListItem

Aliases: WordListItem

Namespace PSWriteOffice

Aliases

WordListItem

Inputs

OfficeIMO.Word.WordList

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordListItemCommand.cs:24 Edit on GitHub

Adds a single list item.

Remarks

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

Examples

Authored help example

Add bullet text.

PS>


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

Creates a bullet with the text “First task”.

Append to an existing list.

PS>


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

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

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.

Syntax

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

Parameter set: All Parameter Sets

Parameters

Level Int32 optionalposition: namedpipeline: False: Zero-based list level.
List WordList optionalposition: namedpipeline: True (ByValue): Existing list to append to. When omitted, the current DSL list is used.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the created WordParagraph.
Text String optionalposition: 0pipeline: False: List item text.