New-UDHeading

Synopsis

Defines a new heading

Syntax

New-UDHeading [-Id <String>] [-Content <ScriptBlock>] [-Size <String>] [-Color <DashboardColor>] [-ClassName <String>] [<CommonParameters>]

New-UDHeading [-Id <String>] [-Text <String>] [-Size <String>] [-Color <DashboardColor>] [-ClassName <String>] [<CommonParameters>]

Description

Defines a new heading. This generates a new H tag.

Parameters

-Id

The ID of this component.

Required?                    false
Position?                    named
Default value                ([Guid]::NewGuid())
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Content

The content of the heading.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Text

The text of the heading.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Size

This size of this heading. This can be 1,2,3,4,5 or 6.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Color

The text color.

Required?                    false
Position?                    named
Default value                black
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ClassName

A CSS class to apply to the heading.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Outputs

Examples

Example 1: Basic Heading

New-UDHeading -Text 'Hello World' -Size 1 -Color 'red'

Creates a basic heading.