Clear-UDElement

Removes all children from the specified element.

Synopsis

Removes all children from the specified element.

Syntax

Clear-UDElement [-Id] <String> [-Broadcast] [<CommonParameters>]

Description

Removes all children from the specified element. This cmdlet may behave differently depending on the type of parent element.

Parameters

-Id

The ID of the element to clear.

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

    -Broadcast [<SwitchParameter>]
        Whether to clear the element on all connected clients.

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

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

Outputs

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDElement -Tag 'div' -Id 'clearElement1' -Content {
PS >     New-UDTypography -Text 'Hello World'
PS > }
PS > New-UDButton -Text 'Click Me' -OnClick {
PS >     Clear-UDElement -Id 'clearElement1'
PS > }

Clear Element|Clears an element.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDElement -Tag 'div' -Id 'clearElement2' -Content {
PS >     New-UDTypography -Text 'Hello World'
PS > }
PS > New-UDButton -Text 'Click Me' -OnClick {
PS >     Clear-UDElement -Id 'clearElement2' -Broadcast
PS > }

Broadcast|Clears an element and broadcasts it to all connected dashboards.