Add-OfficeWordList

Aliases: WordList

Namespace PSWriteOffice

Aliases

WordList

Inputs

None

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordListCommand.cs:17 Edit on GitHub

Starts a list inside the current section or paragraph anchor.

Remarks

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

Examples

Authored help example

Numbered checklist.

PS>


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

Creates a numbered list with two steps.

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-OfficeWordList [-Content <ScriptBlock>] [-PassThru] [-Style <Bulleted>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Content ScriptBlock optionalposition: 0pipeline: False: Scriptblock executed within the list scope.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the object created or changed by the command.
Style WordListStyle optionalposition: 1pipeline: Falsealiases: Typevalues: 14: Built-in list style or custom numbering scheme.; Possible values: Bulleted, ArticleSections, Headings111, HeadingIA1, Chapters, BulletedChars, Heading1ai, Headings111Shifted, LowerLetterWithBracket, LowerLetterWithDot, UpperLetterWithDot, UpperLetterWithBracket, Custom, Numbered