New-AMTextBlock

New-AMTextBlock

New-AMTextBlock

SYNOPSIS

Creates a TextBlock element for an Adaptive Card.

SYNTAX

1

New-AMTextBlock [-Text <String>] [-Size <String>] [-Weight <String>] [-Color <String>] [-Wrap <String>] [<CommonParameters>]

DESCRIPTION

The New-AMTextBlock function creates a TextBlock element that displays formatted text within an Adaptive Card. TextBlocks are the primary way to display text content and can be styled with different sizes, weights, and colors. They also support simple markdown formatting for basic text styling.

TextBlocks are highly versatile and can be used for headings, body text, or labels. They can be configured to wrap text, truncate long text, or display inline with other elements.

EXAMPLES

EXAMPLE 1

1
2
3

# Create a simple text block
$text = New-AMTextBlock -Text "Hello World!"
Add-AMElement -Card $card -Element $text

EXAMPLE 2

1
2

# Create a heading with larger text and bold weight
$heading = New-AMTextBlock -Text "Important Notification" -Size "Large" -Weight "Bolder" -Color "Accent"

EXAMPLE 3

1
2

# Create text with markdown formatting
$markdownText = New-AMTextBlock -Text "Please **review** the [documentation](https://docs.example.com) before continuing."

EXAMPLE 4

1
2

# Create a text block with wrapping disabled
$noWrapText = New-AMTextBlock -Text "This is a long line of text that will be truncated if it doesn't fit." -Wrap $false

PARAMETERS

-Text

The text to display in the TextBlock. This can include simple markdown formatting such as bold, italic, and links.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Size

Controls the size of the text. Valid values: “Small”, “Default”, “Medium”, “Large”, “ExtraLarge” Default: “Medium”

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Weight

Controls the font weight (boldness) of the text. Valid values: “Lighter”, “Default”, “Bolder” Default: “Default”

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Color

Sets the color of the text. Valid values: “Default”, “Dark”, “Light”, “Accent”, “Good”, “Warning”, “Attention” Default: “Default”

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Wrap

Specifies whether the text should wrap to multiple lines when it doesn’t fit on a single line. When set to $false, text that doesn’t fit will be truncated. Default: $true

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

None. You cannot pipe input to New-AMTextBlock.

OUTPUTS

System.Collections.Hashtable

Returns a hashtable representing the TextBlock element.

NOTES

TextBlocks are the most common element in Adaptive Cards. Some best practices:

  • Use different sizes and weights to create a visual hierarchy.
  • Set Wrap to $true for longer text to ensure readability.
  • Use markdown sparingly for emphasis, but avoid complex formatting.
  • Consider using different colors to highlight important information.
  • Test your cards in the target environment to ensure proper rendering.