Get-HtmlBrowserElement

August 3, 2026 ยท View on GitHub

SYNOPSIS

Returns browser-observed DOM element information from an active session.

SYNTAX

__AllParameterSets

Get-HtmlBrowserElement [[-Session] <HtmlBrowserSession>] [[-Selector] <string>] [-VisibleOnly] [-IncludeAttributes] [-IncludeHtml] [-Limit <int>] [-Timeout <int>] [-CancellationToken <CancellationToken>] [<CommonParameters>]

DESCRIPTION

Returns browser-observed DOM element information from an active session.

EXAMPLES

EXAMPLE 1

$session = Start-HtmlBrowserSession -Url https://example.org/catalog
Get-HtmlBrowserElement -Session $session -Selector '.product-card' -VisibleOnly -IncludeAttributes

PARAMETERS

-CancellationToken

Token used to cancel the operation.

Type: CancellationToken
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-IncludeAttributes

Include all element attributes.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-IncludeHtml

Include inner and outer HTML for each element.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Limit

Maximum number of matching elements to inspect.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Selector

CSS selector to inspect.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Session

Existing browser session.

Type: HtmlBrowserSession
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Timeout

Timeout in milliseconds while waiting for the selector.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-VisibleOnly

Return only visible elements.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
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

  • HtmlTinkerX.HtmlBrowserSession

OUTPUTS

  • HtmlTinkerX.HtmlBrowserElementInfo
  • None