New NotionRichTextAnnotation

New-NotionRichTextAnnotation

SYNOPSIS

Creates a new annotation object for Notion rich text.

SYNTAX

None (Default)

New-NotionRichTextAnnotation [<CommonParameters>]

WithObject

New-NotionRichTextAnnotation -Annotations <Object> [<CommonParameters>]

WithProperties

New-NotionRichTextAnnotation [-Bold] [-Italic] [-Strikethrough] [-Underline] [-Code] [-Color <String>]
 [<CommonParameters>]

DESCRIPTION

This function creates a new instance of the annotation class. You can create an empty annotation, provide an object with annotation properties, or specify all annotation properties individually.

---

Attention: Due an API limitation, the color can only be set for foreground text, or background, not both. Hopefully this will change in the future.

---

EXAMPLES

EXAMPLE 1

New-NotionRichTextAnnotation

Creates an empty annotation object.

EXAMPLE 2

New-NotionRichTextAnnotation -Annotations @{ bold = $true; color = "red" }

Creates an annotation object with specified properties from a hashtable.

EXAMPLE 3

New-NotionRichTextAnnotation -Bold -Color "blue"

Creates an annotation object with bold text and blue color.

EXAMPLE 4

New-NotionRichTextAnnotation -Underline -Color "purple_background"

Creates an annotation object with underlined text and purple background color.

PARAMETERS

-Annotations

An object with annotation properties (bold, italic, strikethrough, underline, code, color).

Type: Object
Parameter Sets: WithObject
Aliases:

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

-Bold

Indicates if the text is bold.

Type: SwitchParameter
Parameter Sets: WithProperties
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Code

Indicates if the text is code.

Type: SwitchParameter
Parameter Sets: WithProperties
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Color

The color for the annotation (notion_color).

Type: String
Parameter Sets: WithProperties
Aliases:

Required: False
Position: Named
Default value: Default
Accept pipeline input: False
Accept wildcard characters: False

-Italic

Indicates if the text is italic.

Type: SwitchParameter
Parameter Sets: WithProperties
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Strikethrough

Indicates if the text is strikethrough.

Type: SwitchParameter
Parameter Sets: WithProperties
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Underline

Indicates if the text is underlined.

Type: SwitchParameter
Parameter Sets: WithProperties
Aliases:

Required: False
Position: Named
Default value: False
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

OUTPUTS

[notion_annotation]

NOTES

RELATED LINKS