Namespace: Consultingwerk.Windows.CefBrowser
Class 
BrowserControl Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs

File:BrowserControl
Purpose:Wrapper User Control for the CefSharp Browser Control
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 08 12:35:25 CET 2023



Top Method Summary
Options Name Purpose
+ AddRequestCallbackHandler (ICefBrowserRequestCallbackService) Allows to inject an ICefBrowserRequestCallbackService
+ CancelLoad () Cancels loading the page
- ChromiumWebBrowser_AddressChanged (Object, AddressChangedEventArgs) Handler method for the browsers AddressChanged event
- ChromiumWebBrowser_ConsoleMessage (Object, ConsoleMessageEventArgs) Handler method for the browsers ConsoleMessage event
- ChromiumWebBrowser_FrameLoadEnd (Object, FrameLoadEndEventArgs) Handler method for the browsers FrameLoadEnd event
- ChromiumWebBrowser_FrameLoadStart (Object, FrameLoadStartEventArgs) Handler method for the browsers FrameLoadStart event
- ChromiumWebBrowser_IsBrowserInitializedChanged (Object, EventArgs) Handler method for the browsers IsBrowserInitializedChanges
- ChromiumWebBrowser_JavascriptMessageReceived (Object, JavascriptMessageReceivedEventArgs) Handler method for the browsers JavascriptMessageReceived event
- ChromiumWebBrowser_LoadError (Object, LoadErrorEventArgs) Handler method for the browsers LoadError event
- ChromiumWebBrowser_LoadingStateChanged (Object, LoadingStateChangedEventArgs) Handler method for the browsers LoadingStatechanged event
- ChromiumWebBrowser_StatusMessage (Object, StatusMessageEventArgs) Handler method for the browsers StatusMessage event
- ChromiumWebBrowser_TitleChanged (Object, TitleChangedEventArgs) Handler method for the browsers TitleChanged event
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- InitializeComponent () Initializes the Visual Design
+ NavigateBack () Navigates to the previous page
+ NavigateForward () Navigates to the next page
+ NavigateTo (character) Navigate the browser to a different page
# OnAddressChanged (AddressChangedEventArgs) Raises the AddressChanged event
# OnCancelEnabledChanged (EventArgs) Raises the CancelEnabledChanged event
# OnConsoleMessage (ConsoleMessageEventArgs) Raises the ConsoleMessage event
# OnFrameLoadEnd (FrameLoadEndEventArgs) Raises the FrameLoadEnd event
# OnFrameLoadStart (FrameLoadStartEventArgs) Raises the FrameLoadStart event
# OnIsBrowserInitializedChanged (EventArgs) Raises the IsBrowserInitializedChanged event
# OnJavascriptMessageReceived (JavascriptMessageReceivedEventArgs) Raises the JavascriptMessageReceived event
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# OnLoadError (LoadErrorEventArgs) Raises the LoadError event
# OnLoadingStateChanged (LoadingStateChangedEventArgs) Raises the LoadingStateChanged event
# OnNavigateBackEnabledChanged (EventArgs) Raises the NavigateBackEnabledChanged event
# OnNavigateForwardEnabledChanged (EventArgs) Raises the NavigateForwardEnabledChanged event
# OnStatusMessage (StatusMessageEventArgs) Raises the StatusMessage event
# OnTitleChanged (TitleChangedEventArgs) Raises the TitleChanged event
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the Destroyed event of the parent form
Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:ParentFormDestroyedHandler (Object, EventArgs)
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Top Constructor Summary
Options Name Purpose
+ BrowserControl () Constructor for the BrowserControl class

Top Event Summary
Options Name Purpose
+ AddressChanged (Object, AddressChangedEventArgs) Event to republish the event of the same name of the browser
+ CancelEnabledChanged DELEGATE System.EventHandler Published when the CancelEnabled property is changed
+ ConsoleMessage (Object, ConsoleMessageEventArgs) Event to republish the event of the same name of the browser
+ FrameLoadEnd (Object, FrameLoadEndEventArgs) Event to republish the event of the same name of the browser
+ FrameLoadStart (Object, FrameLoadStartEventArgs) Event to republish the event of the same name of the browser
+ IsBrowserInitializedChanged DELEGATE System.EventHandler Event to republish the event of the same name of the browser
+ JavascriptMessageReceived (Object, JavascriptMessageReceivedEventArgs) Event to republish the event of the same name of the browser
+ LoadError (Object, LoadErrorEventArgs) Event to republish the event of the same name of the browser
+ LoadingStateChanged (Object, LoadingStateChangedEventArgs) Event to republish the event of the same name of the browser
+ NavigateBackEnabledChanged DELEGATE System.EventHandler Published when the NavigateBackEnabled property is changed
+ NavigateForwardEnabledChanged DELEGATE System.EventHandler Published when the NavigateForwardEnabled property is changed
+ StatusMessage (Object, StatusMessageEventArgs) Event to republish the event of the same name of the browser
+ TitleChanged (Object, TitleChangedEventArgs) Event to republish the event of the same name of the browser

Top Property Summary
Options Name Purpose
+ LOGICAL CancelEnabled
+ CefSharp.WinForms.ChromiumWebBrowser ChromiumWebBrowser
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL NavigateBackEnabled
+ LOGICAL NavigateForwardEnabled
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ CHARACTER Title
+ CHARACTER Url
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PUBLIC AddRequestCallbackHandler (ICefBrowserRequestCallbackService)

Purpose: Allows to inject an ICefBrowserRequestCallbackService
Notes:

Parameters:
poRequestHandler Consultingwerk.Windows.CefBrowser.ICefBrowserRequestCallbackService
The ICefBrowserRequestCallbackService instance
Top

PUBLIC CancelLoad ()

Purpose: Cancels loading the page
Notes:

Top

PRIVATE ChromiumWebBrowser_AddressChanged (Object, AddressChangedEventArgs)

Purpose: Handler method for the browsers AddressChanged event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.AddressChangedEventArgs
The AddressChangedEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_ConsoleMessage (Object, ConsoleMessageEventArgs)

Purpose: Handler method for the browsers ConsoleMessage event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.ConsoleMessageEventArgs
The ConsoleMessageEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_FrameLoadEnd (Object, FrameLoadEndEventArgs)

Purpose: Handler method for the browsers FrameLoadEnd event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.FrameLoadEndEventArgs
The FrameLoadEndEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_FrameLoadStart (Object, FrameLoadStartEventArgs)

Purpose: Handler method for the browsers FrameLoadStart event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.FrameLoadStartEventArgs
The FrameLoadStartEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_IsBrowserInitializedChanged (Object, EventArgs)

Purpose: Handler method for the browsers IsBrowserInitializedChanges
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_JavascriptMessageReceived (Object, JavascriptMessageReceivedEventArgs)

Purpose: Handler method for the browsers JavascriptMessageReceived event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.JavascriptMessageReceivedEventArgs
The JavascriptMessageReceivedEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_LoadError (Object, LoadErrorEventArgs)

Purpose: Handler method for the browsers LoadError event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.LoadErrorEventArgs
The LoadErrorEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_LoadingStateChanged (Object, LoadingStateChangedEventArgs)

Purpose: Handler method for the browsers LoadingStatechanged event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.LoadingStateChangedEventArgs
The LoadingStateChangedEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_StatusMessage (Object, StatusMessageEventArgs)

Purpose: Handler method for the browsers StatusMessage event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.StatusMessageEventArgs
The StatusMessageEventArgs with the data for this event
Top

PRIVATE ChromiumWebBrowser_TitleChanged (Object, TitleChangedEventArgs)

Purpose: Handler method for the browsers TitleChanged event
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.TitleChangedEventArgs
The TitleChangedEventArgs with the data for this event
Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PUBLIC NavigateBack ()

Purpose: Navigates to the previous page
Notes:

Top

PUBLIC NavigateForward ()

Purpose: Navigates to the next page
Notes:

Top

PUBLIC NavigateTo (character)

Purpose: Navigate the browser to a different page
Notes:

Parameters:
pcUrl CHARACTER
The url of the page to navigate to
Top

PROTECTED OnAddressChanged (AddressChangedEventArgs)

Purpose: Raises the AddressChanged event
Notes:

Parameters:
e CefSharp.AddressChangedEventArgs
The AddressChangedEventArgs with the data for this event
Top

PROTECTED OnCancelEnabledChanged (EventArgs)

Purpose: Raises the CancelEnabledChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnConsoleMessage (ConsoleMessageEventArgs)

Purpose: Raises the ConsoleMessage event
Notes:

Parameters:
e CefSharp.ConsoleMessageEventArgs
The ConsoleMessageEventArgs with the data for this event
Top

PROTECTED OnFrameLoadEnd (FrameLoadEndEventArgs)

Purpose: Raises the FrameLoadEnd event
Notes:

Parameters:
e CefSharp.FrameLoadEndEventArgs
The FrameLoadEndEventArgs with the data for this event
Top

PROTECTED OnFrameLoadStart (FrameLoadStartEventArgs)

Purpose: Raises the FrameLoadStart event
Notes:

Parameters:
e CefSharp.FrameLoadStartEventArgs
The FrameLoadStartEventArgs with the data for this event
Top

PROTECTED OnIsBrowserInitializedChanged (EventArgs)

Purpose: Raises the IsBrowserInitializedChanged event
Notes:

Parameters:
e System.EventArgs
The FrameLoadStartEventArgs with the data for this event
Top

PROTECTED OnJavascriptMessageReceived (JavascriptMessageReceivedEventArgs)

Purpose: Raises the JavascriptMessageReceived event
Notes:

Parameters:
e CefSharp.JavascriptMessageReceivedEventArgs
The JavascriptMessageReceivedEventArgs with the data for this event
Top

PROTECTED OnLoad (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Raises the Load event
Notes: Subscribes the FormDestroyed event from the ParentForm

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnLoadError (LoadErrorEventArgs)

Purpose: Raises the LoadError event
Notes:

Parameters:
e CefSharp.LoadErrorEventArgs
The LoadErrorEventArgs with the data for this event
Top

PROTECTED OnLoadingStateChanged (LoadingStateChangedEventArgs)

Purpose: Raises the LoadingStateChanged event
Notes:

Parameters:
e CefSharp.LoadingStateChangedEventArgs
The LoadingStateChangedEventArgs with the data for this event
Top

PROTECTED OnNavigateBackEnabledChanged (EventArgs)

Purpose: Raises the NavigateBackEnabledChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnNavigateForwardEnabledChanged (EventArgs)

Purpose: Raises the NavigateForwardEnabledChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnStatusMessage (StatusMessageEventArgs)

Purpose: Raises the StatusMessage event
Notes:

Parameters:
e CefSharp.StatusMessageEventArgs
The StatusMessageEventArgs with the data for this event
Top

PROTECTED OnTitleChanged (TitleChangedEventArgs)

Purpose: Raises the TitleChanged event
Notes:

Parameters:
e CefSharp.TitleChangedEventArgs
The TitleChangedEventArgs with the data for this event
Top

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcDesignerVerb CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:ParentFormDestroyedHandler (Object, EventArgs)
Purpose: Event handler for the Destroyed event of the parent form
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PUBLIC SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control



Constructor Detail
Top

PUBLIC BrowserControl ()

Purpose: Constructor for the BrowserControl class
Notes:



Event Detail
Top

PUBLIC AddressChanged (Object, AddressChangedEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.AddressChangedEventArgs
The AddressChangedEventArgs with the data for this event
Top

PUBLIC CancelEnabledChanged DELEGATE System.EventHandler

Purpose: Published when the CancelEnabled property is changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC ConsoleMessage (Object, ConsoleMessageEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.ConsoleMessageEventArgs
The ConsoleMessageEventArgs with the data for this event
Top

PUBLIC FrameLoadEnd (Object, FrameLoadEndEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.FrameLoadEndEventArgs
The FrameLoadEndEventArgs with the data for this event
Top

PUBLIC FrameLoadStart (Object, FrameLoadStartEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.FrameLoadStartEventArgs
The FrameLoadStartEventArgs with the data for this event
Top

PUBLIC IsBrowserInitializedChanged DELEGATE System.EventHandler

Purpose: Event to republish the event of the same name of the browser
Notes:

Delegate: System.EventHandler
Top

PUBLIC JavascriptMessageReceived (Object, JavascriptMessageReceivedEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.JavascriptMessageReceivedEventArgs
The JavascriptMessageReceivedEventArgs with the data for this event
Top

PUBLIC LoadError (Object, LoadErrorEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.LoadErrorEventArgs
The LoadErrorEventArgs with the data for this event
Top

PUBLIC LoadingStateChanged (Object, LoadingStateChangedEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.LoadingStateChangedEventArgs
The LoadingStateChangedEventArgs with the data for this event
Top

PUBLIC NavigateBackEnabledChanged DELEGATE System.EventHandler

Purpose: Published when the NavigateBackEnabled property is changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC NavigateForwardEnabledChanged DELEGATE System.EventHandler

Purpose: Published when the NavigateForwardEnabled property is changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC StatusMessage (Object, StatusMessageEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.StatusMessageEventArgs
The StatusMessageEventArgs with the data for this event
Top

PUBLIC TitleChanged (Object, TitleChangedEventArgs)

Purpose: Event to republish the event of the same name of the browser
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e CefSharp.TitleChangedEventArgs
The TitleChangedEventArgs with the data for this event


Property Detail
Top

PUBLIC LOGICAL CancelEnabled


Returns LOGICAL
Top

PUBLIC CefSharp.WinForms.ChromiumWebBrowser ChromiumWebBrowser


Returns CefSharp.WinForms.ChromiumWebBrowser
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL NavigateBackEnabled


Returns LOGICAL
Top

PUBLIC LOGICAL NavigateForwardEnabled


Returns LOGICAL
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC CHARACTER Title


Returns CHARACTER
Top

PUBLIC CHARACTER Url


Returns CHARACTER
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:18:06