New-HTMLList

Namespace PSWriteHTML

Creates an HTML list with customizable styling options.

Remarks

The New-HTMLList function generates an HTML list with various styling options such as color, font size, font weight, alignment, and more.

Examples

Authored help example

EXAMPLE 1


New-HTMLList -ListItems { 'Item 1', 'Item 2', 'Item 3' } -Type Unordered -Color 'blue' -FontSize 12 -FontWeight 'bold' -Alignment 'center'

Creates an unordered HTML list with three items ('Item 1', 'Item 2', 'Item 3') displayed in blue color, font size 12, bold font weight, and centered alignment.

EXAMPLE 2


New-HTMLList -ListItems { 'Apple', 'Banana', 'Cherry' } -Type Ordered -FontFamily 'Arial' -TextDecoration 'underline' -Direction 'rtl'

Creates an ordered HTML list with three items ('Apple', 'Banana', 'Cherry') using Arial font family, underlined text decoration, and right-to-left text direction.

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-HTMLList [-Alignment <left|center|right|justify>] [-BackGroundColor <String>] [-Color <String>] [-Direction <rtl>] [-FontFamily <String>] [-FontSize <Object>] [-FontStyle <normal|italic|oblique>] [-FontVariant <normal|small-caps>] [-FontWeight <normal>] [-LineBreak] [-ListItems <ScriptBlock>] [-Reversed] [-TextDecoration <line-through|overline|underline>] [-TextTransform <uppercase|lowercase|capitalize>] [-Type <Unordered|Ordered>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Alignment String optionalposition: namedpipeline: Falsevalues: 4: Specifies the alignment of the text within the list. Valid values are 'left', 'center', 'right', and 'justify'.; Possible values: left, center, right, justify
BackGroundColor String optionalposition: namedpipeline: False: Specifies the background color of the list.
Color String optionalposition: namedpipeline: False: Specifies the color of the text in the list.
Direction String optionalposition: namedpipeline: Falsevalues: 1: Specifies the direction of the text. Valid value is 'rtl' (right-to-left).; Possible values: rtl
FontFamily String optionalposition: namedpipeline: False: Specifies the font family for the text in the list.
FontSize Object optionalposition: namedpipeline: False: Specifies the font size of the text in the list.
FontStyle String optionalposition: namedpipeline: Falsevalues: 3: Specifies the style of the font. Valid values are 'normal', 'italic', and 'oblique'.; Possible values: normal, italic, oblique
FontVariant String optionalposition: namedpipeline: Falsevalues: 2: Specifies the variant of the font. Valid values are 'normal' and 'small-caps'.; Possible values: normal, small-caps
FontWeight String optionalposition: namedpipeline: Falsevalues: 13: Specifies the weight of the font. Valid values include 'normal', 'bold', 'bolder', 'lighter', and numeric values from 100 to 900.; Possible values: normal, bold, bolder, lighter, 100, 200, 300, 400, 500, 600, 700, 800, 900
LineBreak SwitchParameter optionalposition: namedpipeline: False: Indicates whether to include line breaks between list items.
ListItems ScriptBlock optionalposition: 0pipeline: False: Specifies the list items to be included in the HTML list.
Reversed SwitchParameter optionalposition: namedpipeline: False: Indicates whether the list should be displayed in reverse order.
TextDecoration String optionalposition: namedpipeline: Falsevalues: 3: Specifies the decoration of the text. Valid values are 'none', 'line-through', 'overline', and 'underline'.; Possible values: line-through, overline, underline
TextTransform String optionalposition: namedpipeline: Falsevalues: 3: Specifies the transformation of the text. Valid values are 'uppercase', 'lowercase', and 'capitalize'.; Possible values: uppercase, lowercase, capitalize
Type String optionalposition: namedpipeline: Falsevalues: 2: Specifies the type of list to create. Valid values are 'Unordered' (default) and 'Ordered'.; Possible values: Unordered, Ordered