Cmdlet

Add-OfficeWordList

Aliases: WordList

Module: PSWriteOffice
Aliases: WordList
Inputs: None
Outputs: OfficeIMO.Word.WordList
Source: AddOfficeWordListCommand.cs:18 Edit on GitHub

Starts a list inside the current section or paragraph anchor.

Syntax

Add-OfficeWordList
[[-Content] <ScriptBlock>]
[-Numbered]
[-PassThru]
[-Style <WordListStyle>]
[<CommonParameters>]

Parameter set: Content

Add-OfficeWordList
[-Items] <String[]>
[-Numbered]
[-PassThru]
[-Style <WordListStyle>]
[<CommonParameters>]

Parameter set: Items

Description

Creates a temporary anchor paragraph, spawns an OfficeIMO list, and runs child WordListItem commands.

Examples

Numbered checklist.

Add-OfficeWordList -Style 'Numbered' { Add-OfficeWordListItem -Text 'Plan'; Add-OfficeWordListItem -Text 'Execute' }

Creates a numbered list with two steps.

Parameters

-Content ScriptBlock optionalposition: 0sets: Content: Scriptblock executed within the list scope.
-Numbered SwitchParameter optional: Use the native numbered list style.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Style WordListStyle optional: Built-in list style or custom numbering scheme.; Possible values: Bulleted, ArticleSections, Headings111, HeadingIA1, Chapters, BulletedChars, Heading1ai, Headings111Shifted, LowerLetterWithBracket, LowerLetterWithDot, UpperLetterWithDot, UpperLetterWithBracket, Custom, Numbered
-Items String[] requiredposition: 0sets: Items: Plain list items.

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.