Property

Description

Return Type

CanGoBack

Gets a value that indicates whether a previous page in navigation history is available, which allows the GoBack method to succeed.

Boolean

CanGoForward

Gets a value that indicates whether a subsequent page in navigation history is available, which allows the GoForward method to succeed.

Boolean

DocumentTitle

Gets the title of the document currently displayed in the web browser control.

String

EncryptionLevel

Gets a value indicating the encryption method used by the document currently displayed in the web browser control.

Encryption Level

FullName

Gets the fully-qualified name of the web browser object.

String

IsBusy

Gets a value that indicates whether the web browser control is currently loading a new document.

Boolean

IsCreated

Indicates whether the browser has been created (matched). For more information, see Wait For Create.

Boolean

IsOffline

Gets a value that indicates whether the web browser control is in offline mode.

Boolean

Key

Gets or sets the unique Key value for this browser.

String

Name

Gets or sets the name assigned to the web browser.

String

NextKey

Sets the key value that will be assigned to the next clone created.

ICloneableControl

ReadyState

Gets a value indicating the current state of the web browser control.

ReadyState

StatusText

Gets the status text of the web browser control.

String

SuppressScriptErrors

Sets or gets a value that indicates whether the web browser will hide script errors from the user when they occur.

Boolean

This

A reference to the Web Browser Component object.

String

Timeout

Specifies the timeout for the Created event. For more information, see Wait For Create.

Milliseconds

UniqueId

The system-generated unique identifier of the web browser.

String

URL

Gets or sets the URL of the current document.

Uri

UseKeys

Indicates whether clones of the Browser can be created, if there are multiple matching targets found.

Boolean

WaitHandle

A control's WaitHandle is a signal that is turned on when a control is created and off when the control is destroyed. The WaitHandle allows callers to wait for the component's creation signal when using the WaitAny or WaitAll components. For more information, see WaitAny and WaitAll Components.

WaitHandle

Method

Description

Parameters

Return Type

Close

Closes the web browser.

None

Void

Detach

Unmatches the browser control.

None

Void

GetClones

Returns a collection of cloned objects. Use the GetClones method in combination with a ListLoop component to iterate over the list of cloned objects to extract individual list items.

None

CloneCollection

GetEvent

Initiates downstream logic pending the occurrence of a particular eventAn occurrence that is significant to a program and which may call for a response from a program. For example, when a button is clicked.. Click the Name parameter in the GetEvent design block to view a list of events applicable for the componentAn object developed by Pega for use in Studio solutions and automations.. Select the event, and then create a proxy from the GetEvent result.

For more information, see Get Event for Windows Controls and Forms.

EventName Name

Event

GoBack

Navigates the web browser control to the previous page in the navigation history, if one is available.

None

Boolean

GoForward

Navigates the web browser control to the next page in the navigation history, if one is available.

None

Boolean

GoHome

Navigates the web browser control to the home page of the current user.

None

Void

GoSearch

Navigates the web browser control to the default search page of the current user.

None

Void

IsKeyAssigned

Verifies that Key is assigned.

String key

Boolean

Navigate (1 param)

Loads the document at the specified location into the web browser control.

URL String

Void

Navigate (2 params)

Loads the document at the specified location into the web browser control. Set the NewWindow parameter to True to have the navigated page open in a new Browser window.

URL String, Boolean)

Void

Print

Prints the document currently displayed in the web browser control using the current print and page settings.

None

Void

Refresh

Reloads the document currently displayed in the web browser control.

None

Void

Refresh (1 param)

Reloads the document currently displayed in the web browser control using the specified refresh options. Your options are:

Normal – A refresh that requests a copy of the current webpage that has been cached on the server.

IfExpired – A refresh that requests an update only if the current webpage has expired.

Continue – For internal use only. Do not use.

Completely – A refresh that requests the latest version of the current webpage.

RefreshOption

Void

RelativeNavigate (1 param)

Navigates the browser to a relative path. If no document is loaded navigates using the normal navigate method.

URL String

Boolean

RelativeNavigate (1 param)

Navigates the browser to a relative path. If no document is loaded navigates using the normal navigate method.

URI String

Boolean

Rematch

Refreshes matching on the web browser control and all controls under the browser. If the control is currently matched, Studio detaches (unmatches) the control and children before attempting to rematch. If the control is currently unmatched, you can only call Rematch if the parent is matched.

None

Void

RematchChildren

Refreshes matching on all objects under the browser control. Set the detach property to True to unmatch all targets before attempting to rematch.

Boolean detach

Void

ResetState

Reserved for .NET requirements.

None

Void

SetNextKey

Set Next key Control using unique key.

String key

Void

ShowPageSetupDialog

Opens the Internet Explorer Page Setup window.

None

Void

ShowPrintDialog

Opens the Internet Explorer Print dialog without setting header and footer values.

None

Void

ShowPrintDialog (2 params)

Opens the Internet Explorer Print dialog with parameters for setting header and footer values.

String, String

Void

ShowPringPreviewDialog

Opens the Internet Explorer Print Preview window.

None

Void

ShowPropertiesDialog

Opens the Internet Explorer Properties dialog for the current document.

None

Void

ShowSaveAsDialog

Opens the Internet Explorer Save Web Page dialog or the Save dialog of the hosted document if it is not an HTML page.

None

Void

Stop

Cancels any pending navigation and stops any dynamic page elements, such as background sounds and animations.

None

Void

WaitForCreate

Waits for the web browser control to be created (matched). Returns True if the browser is created before the WaitTimeout period elapses; otherwise, it returns False. For more information, see Wait For Create.

None

Boolean

WaitForCreate (1 param)

Waits for the web browser control to be created (matched). Returns True if the Browser is created before the specified number of milliseconds has elapsed; otherwise, it returns False. For more information, see Wait For Create.

Milliseconds

Boolean

Event

Description

CanGoBackChanged

Occurs when the CanGoBack property value changes.

CanGoForwardChanged

Occurs when the CanGoForward property value changes.

Created

Occurs when the web browser is matched. For more information, see Wait For Create.

Destroyed

Occurs when the web browser is unmatched.

Disposed

Occurs when the browser is disposed by a call to the Dispose method.

DocumentCompleted

Occurs when the web browser control finishes loading a document.

DocumentTitleChanged

Occurs when the DocumentTitle property value changes.

EncryptionLevelChanged

Occurs when the web browser control navigates to or away from a website that uses encryption.

FileDownload

Occurs when the web browser control downloads a file.

Navigated

Occurs when the web browser control has navigated to a new document and has begun loading it.

Navigating

Occurs before the web browser control navigates to a new document.

NavigationError

Occurs when an error occurs when the browser is attempting to go to a new page.

NewWindow

Occurs before a new browser window is opened.

ProgressChanged

Occurs when the web browser control has updated information on the download progress of a document it is navigating to.

StatusTextChanged

Occurs when the StatusText property value changes.