New-HTMLSummary

Namespace PSWriteHTML

Creates a new HTML summary section with customizable content.

Remarks

The New-HTMLSummary function creates an HTML summary section with customizable content. It allows you to display a summary with a title, additional information, and summary items.

Examples

Authored help example

EXAMPLE 1


New-HTMLSummary -SummaryItems {
    "Summary Item 1"
    "Summary Item 2"
} -Title "Summary Title" -TitleRight "Additional Info"

Creates a new HTML summary section with the title "Summary Title", displaying "Summary Item 1" and "Summary Item 2" as summary items, and additional information "Additional Info" on the right side of the title.

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

New-HTMLSummary [-SummaryItems <ScriptBlock>] [-Title <String>] [-TitleRight <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

SummaryItems ScriptBlock optionalposition: 0pipeline: False: Specifies the script block containing the summary items to be displayed within the summary section.
Title String optionalposition: 1pipeline: False: Specifies the title of the summary section.
TitleRight String optionalposition: 2pipeline: False: Specifies the additional information to be displayed on the right side of the title.