Remove-UDElement

Removes an element from the page.

Synopsis

Removes an element from the page.

Syntax

Remove-UDElement [-Id] <String> [[-ParentId] <String>] [-Broadcast] [<CommonParameters>]

Description

Removes an element from the page.

Parameters

-Id

The ID of the element to remove.

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

-ParentId

Not used

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

    -Broadcast [<SwitchParameter>]
        Whether to remove this element from the page of all connected users.

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 -Id 'removeElement1' -Tag 'div' -Content {
PS >     New-UDTypography -Text 'Hello World'
PS > }
PS > New-UDButton -Text 'Click Me' -OnClick {
PS >     Remove-UDElement -Id 'removeElement1'
PS > }

Remove Element|Removes an element from the page.




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

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

Broadcast|Removes an element from the page and broadcasts it to all connected dashboards.