Click or drag to resize

ChromiumWebBrowser Class

Version 104.4.240
ChromiumWebBrowser is the WinForms web browser control
Inheritance Hierarchy

Namespace:  CefSharp.WinForms
Assembly:  CefSharp.WinForms (in CefSharp.WinForms.dll) Version: 104.4.240.0 (104.4.240.0)
Syntax
public class ChromiumWebBrowser : ChromiumHostControlBase, 
	IWebBrowser, IChromiumWebBrowserBase, IDisposable, IWinFormsWebBrowser, IWinFormsChromiumWebBrowser, 
	IWin32Window, IComponent, ISynchronizeInvoke

The ChromiumWebBrowser type exposes the following members.

Constructors
  NameDescription
Public methodChromiumWebBrowser
Important!!! This constructor exists as the WinForms designer requires a parameterless constructor, if you are instantiating an instance of this class in code then use the ChromiumWebBrowser(String, IRequestContext) constructor overload instead. Using this constructor in code is unsupported and you may experience NullReferenceException's when attempting to access some of the properties immediately after instantiation.
Public methodChromiumWebBrowser(String, IRequestContext)
Initializes a new instance of the ChromiumWebBrowser class. **Important** - When using this constructor the Dock property will default to Fill.
Public methodChromiumWebBrowser(HtmlString, IRequestContext)
Initializes a new instance of the ChromiumWebBrowser class. **Important** - When using this constructor the Dock property will default to Fill.
Top
Properties
  NameDescription
Public propertyAccessibilityObject
Gets the AccessibleObject assigned to the control.
(Inherited from Control.)
Public propertyAccessibleDefaultActionDescription
Gets or sets the default action description of the control for use by accessibility client applications.
(Inherited from Control.)
Public propertyAccessibleDescription
Gets or sets the description of the control used by accessibility client applications.
(Inherited from Control.)
Public propertyAccessibleName
Gets or sets the name of the control used by accessibility client applications.
(Inherited from Control.)
Public propertyAccessibleRole
Gets or sets the accessible role of the control
(Inherited from Control.)
Public propertyActivateBrowserOnCreation
Activates browser upon creation, the default value is false. Prior to version 73 the default behaviour was to activate browser on creation (Equivalent of setting this property to true). To restore this behaviour set this value to true immediately after you create the ChromiumWebBrowser instance. https://bitbucket.org/chromiumembedded/cef/issues/1856/branch-2526-cef-activates-browser-window
Public propertyAddress
The address (URL) which the browser control is currently displaying. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
Public propertyAllowDrop
Gets or sets a value indicating whether the control can accept data that the user drags onto it.
(Inherited from Control.)
Public propertyAnchor
Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
(Inherited from Control.)
Public propertyAudioHandler
Implement IAudioHandler to handle audio events.
Public propertyAutoScrollOffset
Gets or sets where this control is scrolled to in ScrollControlIntoView(Control).
(Inherited from Control.)
Public propertyAutoSize
This property is not relevant for this class.
(Inherited from Control.)
Public propertyBackColor
Gets or sets the background color for the control.
(Inherited from Control.)
Public propertyBackgroundImage
Gets or sets the background image displayed in the control.
(Inherited from Control.)
Public propertyBackgroundImageLayout
Gets or sets the background image layout as defined in the ImageLayout enumeration.
(Inherited from Control.)
Public propertyBindingContext
Gets or sets the BindingContext for the control.
(Inherited from Control.)
Public propertyBottom
Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
(Inherited from Control.)
Public propertyBounds
Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
(Inherited from Control.)
Public propertyBrowserCore
Get access to the core IBrowser instance. Maybe null if the underlying CEF Browser has not yet been created or if this control has been disposed. Check IsDisposed before accessing.
Public propertyBrowserHwnd
IntPtr that represents the CefBrowser Hwnd Used for sending messages to the browser e.g. resize
(Inherited from ChromiumHostControlBase.)
Public propertyBrowserSettings
Gets or sets the browser settings.
Protected propertyCanEnableIme
Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support.
(Inherited from Control.)
Public propertyCanExecuteJavascriptInMainFrame
A flag that indicates if you can execute javascript in the main frame. Flag is set to true in IRenderProcessMessageHandler.OnContextCreated. and false in IRenderProcessMessageHandler.OnContextReleased
Public propertyCanFocus
Gets a value indicating whether the control can receive focus.
(Inherited from Control.)
Public propertyCanGoBack
A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
Public propertyCanGoForward
A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
Protected propertyCanRaiseEvents
Determines if events can be raised on the control.
(Inherited from Control.)
Public propertyCanSelect
Gets a value indicating whether the control can be selected.
(Inherited from Control.)
Public propertyCapture
Gets or sets a value indicating whether the control has captured the mouse.
(Inherited from Control.)
Public propertyCausesValidation
Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
(Inherited from Control.)
Public propertyClientRectangle
Gets the rectangle that represents the client area of the control.
(Inherited from Control.)
Public propertyClientSize
Gets or sets the height and width of the client area of the control.
(Inherited from Control.)
Public propertyCompanyName
Gets the name of the company or creator of the application containing the control.
(Inherited from Control.)
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyContainsFocus
Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
(Inherited from Control.)
Public propertyContextMenu
Gets or sets the shortcut menu associated with the control.
(Inherited from Control.)
Public propertyContextMenuStrip
Gets or sets the ContextMenuStrip associated with this control.
(Inherited from Control.)
Public propertyControls
Gets the collection of controls contained within the control.
(Inherited from Control.)
Public propertyCreated
Gets a value indicating whether the control has been created.
(Inherited from Control.)
Protected propertyCreateParams
Gets the required creation parameters when the control handle is created.
(Inherited from Control.)
Public propertyCursor
Gets or sets the cursor that is displayed when the mouse pointer is over the control.
(Inherited from Control.)
Public propertyDataBindings
Gets the data bindings for the control.
(Inherited from Control.)
Protected propertyDefaultCursor
Gets or sets the default cursor for the control.
(Inherited from Control.)
Protected propertyDefaultImeMode
Gets the default Input Method Editor (IME) mode supported by the control.
(Inherited from Control.)
Protected propertyDefaultMargin
Gets the space, in pixels, that is specified by default between controls.
(Inherited from Control.)
Protected propertyDefaultMaximumSize
Gets the length and height, in pixels, that is specified as the default maximum size of a control.
(Inherited from Control.)
Protected propertyDefaultMinimumSize
Gets the length and height, in pixels, that is specified as the default minimum size of a control.
(Inherited from Control.)
Protected propertyDefaultPadding
Gets the internal spacing, in pixels, of the contents of a control.
(Inherited from Control.)
Protected propertyDefaultSize
Gets the default size of the control.
(Inherited from ChromiumHostControlBase.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Public propertyDialogHandler
Implement IDialogHandler and assign to handle dialog events.
Public propertyDisplayHandler
Implement IDisplayHandler and assign to handle events related to browser display state.
Public propertyDisplayRectangle
Gets the rectangle that represents the display area of the control.
(Inherited from Control.)
Public propertyDisposing
Gets a value indicating whether the base Control class is in the process of disposing.
(Inherited from Control.)
Public propertyDock
Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
(Inherited from Control.)
Protected propertyDoubleBuffered
Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
(Inherited from Control.)
Public propertyDownloadHandler
Implement IDownloadHandler and assign to handle events related to downloading files.
Public propertyDragHandler
Implement IDragHandler and assign to handle events related to dragging.
Public propertyEnabled
Gets or sets a value indicating whether the control can respond to user interaction.
(Inherited from Control.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyFindHandler
Implement IFindHandler to handle events related to find results.
Public propertyFocused
Manually implement Focused because cef does not implement it.
(Overrides ControlFocused.)
Public propertyFocusHandler
The IFocusHandler for this ChromiumWebBrowser.
Public propertyFont
Gets or sets the font of the text displayed by the control.
(Inherited from Control.)
Protected propertyFontHeight
Gets or sets the height of the font of the control.
(Inherited from Control.)
Public propertyForeColor
Gets or sets the foreground color of the control.
(Inherited from Control.)
Public propertyFrameHandler
Implement IFrameHandler to handle frame events.
Public propertyHandle
Gets the window handle that the control is bound to.
(Inherited from Control.)
Public propertyHasChildren
Gets a value indicating whether the control contains one or more child controls.
(Inherited from Control.)
Public propertyHeight
Gets or sets the height of the control.
(Inherited from Control.)
Public propertyImeMode
Gets or sets the Input Method Editor (IME) mode of the control.
(Inherited from Control.)
Protected propertyImeModeBase
Gets or sets the IME mode of a control.
(Inherited from Control.)
Public propertyInvokeRequired
Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
(Inherited from Control.)
Public propertyIsAccessible
Gets or sets a value indicating whether the control is visible to accessibility applications.
(Inherited from Control.)
Public propertyIsActivating
Set to true while handing an activating WM_ACTIVATE message. MUST ONLY be cleared by DefaultFocusHandler.
(Inherited from ChromiumHostControlBase.)
Public propertyIsBrowserInitialized
A flag that indicates whether the WebBrowser is initialized (true) or not (false).
Public propertyIsDisposed
Gets a value indicating whether this instance is disposed.
Public propertyIsHandleCreated
Gets a value indicating whether the control has a handle associated with it.
(Inherited from Control.)
Public propertyIsLoading
A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
Public propertyIsMirrored
Gets a value indicating whether the control is mirrored.
(Inherited from Control.)
Public propertyJavascriptObjectRepository
The javascript object repository, one repository per ChromiumWebBrowser instance.
Public propertyJsDialogHandler
Implement IJsDialogHandler and assign to handle events related to JavaScript Dialogs.
Public propertyKeyboardHandler
Implement IKeyboardHandler and assign to handle events related to key press.
Public propertyLayoutEngine
Gets a cached instance of the control's layout engine.
(Inherited from Control.)
Public propertyLeft
Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
(Inherited from Control.)
Public propertyLifeSpanHandler
Implement ILifeSpanHandler and assign to handle events related to popups.
Public propertyLoadHandler
Implement ILoadHandler and assign to handle events related to browser load status.
Public propertyLocation
Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
(Inherited from Control.)
Public propertyMargin
Gets or sets the space between controls.
(Inherited from Control.)
Public propertyMaximumSize
Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify.
(Inherited from Control.)
Public propertyMenuHandler
Implement IContextMenuHandler and assign to handle events related to the browser context menu
Public propertyMinimumSize
Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify.
(Inherited from Control.)
Public propertyName
Gets or sets the name of the control.
(Inherited from Control.)
Public propertyPadding
Gets or sets padding within the control.
(Inherited from Control.)
Public propertyParent
Gets or sets the parent container of the control.
(Inherited from Control.)
Public propertyParkControlOnHandleDestroyed
By default when OnHandleDestroyed(EventArgs) is called the underlying Browser Hwnd is only parked (moved to a temp parent) when RecreatingHandle is true, there are a few other cases where parking of the control is desired, you can force parking by setting this property to true.
Public propertyPermissionHandler
Implement IPermissionHandler to handle events related to permission requests.
Public propertyPreferredSize
Gets the size of a rectangular area into which the control can fit.
(Inherited from Control.)
Public propertyProductName
Gets the product name of the assembly containing the control.
(Inherited from Control.)
Public propertyProductVersion
Gets the version of the assembly containing the control.
(Inherited from Control.)
Public propertyRecreatingHandle
Gets a value indicating whether the control is currently re-creating its handle.
(Inherited from Control.)
Public propertyRegion
Gets or sets the window region associated with the control.
(Inherited from Control.)
Public propertyRenderProcessMessageHandler
Implement IRenderProcessMessageHandler and assign to handle messages from the render process.
Protected propertyRenderRightToLeft Obsolete.
This property is now obsolete.
(Inherited from Control.)
Public propertyRequestContext
Gets or sets the request context.
Public propertyRequestHandler
Implement IRequestHandler and assign to handle events related to browser requests.
Protected propertyResizeRedraw
Gets or sets a value indicating whether the control redraws itself when resized.
(Inherited from Control.)
Public propertyResourceRequestHandlerFactory
Implement IResourceRequestHandlerFactory and control the loading of resources
Public propertyRight
Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
(Inherited from Control.)
Public propertyRightToLeft
Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
(Inherited from Control.)
Protected propertyScaleChildren
Gets a value that determines the scaling of child controls.
(Inherited from Control.)
Protected propertyShowFocusCues
Gets a value indicating whether the control should display focus rectangles.
(Inherited from Control.)
Protected propertyShowKeyboardCues
Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators.
(Inherited from Control.)
Public propertySite
Gets or sets the site of the control.
(Inherited from Control.)
Public propertySize
Gets or sets the height and width of the control.
(Inherited from Control.)
Public propertyTabIndex
Gets or sets the tab order of the control within its container.
(Inherited from Control.)
Public propertyTabStop
Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
(Inherited from Control.)
Public propertyTag
Gets or sets the object that contains data about the control.
(Inherited from Control.)
Public propertyText
Gets or sets the text associated with this control.
(Inherited from Control.)
Public propertyTooltipText
The text that will be displayed as a ToolTip
Public propertyTop
Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
(Inherited from Control.)
Public propertyTopLevelControl
Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
(Inherited from Control.)
Public propertyUseParentFormMessageInterceptor
ParentFormMessageInterceptor hooks the Form handle and forwards the move/active messages to the browser, the default is true and should only be required when using MultiThreadedMessageLoop set to true.
Public propertyUseWaitCursor
Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls.
(Inherited from Control.)
Public propertyVisible
Gets or sets a value indicating whether the control and all its child controls are displayed.
(Inherited from Control.)
Public propertyWidth
Gets or sets the width of the control.
(Inherited from Control.)
Public propertyWindowTarget
This property is not relevant for this class.
(Inherited from Control.)
Top
Methods
  NameDescription
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32)
Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
(Inherited from Control.)
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32, Int32)
Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control .
(Inherited from Control.)
Public methodBeginInvoke(Delegate)
Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public methodBeginInvoke(Delegate, Object)
Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public methodBringToFront
Brings the control to the front of the z-order.
(Inherited from Control.)
Public methodCaptureScreenshotAsync
Capture page screenshot.
Public methodContains
Retrieves a value indicating whether the specified control is a child of the control.
(Inherited from Control.)
Protected methodCreateAccessibilityInstance
Creates a new accessibility object for the control.
(Inherited from Control.)
Protected methodCode exampleCreateBrowserWindowInfo
Override this method to handle creation of WindowInfo. This method can be used to customise aspects of browser creation including configuration of settings such as ExStyle. Window Activation is disabled by default, you can re-enable it by overriding and removing the WS_EX_NOACTIVATE style from ExStyle.
Public methodCreateControl
Forces the creation of the visible control, including the creation of the handle and any visible child controls.
(Inherited from Control.)
Protected methodCreateControlsInstance
Creates a new instance of the control collection for the control.
(Inherited from Control.)
Public methodCreateGraphics
Creates the Graphics for the control.
(Inherited from Control.)
Protected methodCreateHandle
Creates a handle for the control.
(Inherited from Control.)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Protected methodDefWndProc
Sends the specified message to the default window procedure.
(Inherited from Control.)
Protected methodDestroyHandle
Destroys the handle associated with the control.
(Inherited from Control.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
If not in design mode; Releases unmanaged and - optionally - managed resources for the ChromiumWebBrowser
(Overrides ChromiumHostControlBaseDispose(Boolean).)
Public methodDoDragDrop
Begins a drag-and-drop operation.
(Inherited from Control.)
Public methodDrawToBitmap
Supports rendering to the specified bitmap.
(Inherited from Control.)
Public methodEndInvoke
Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed.
(Inherited from Control.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodFindForm
Retrieves the form that the control is on.
(Inherited from Control.)
Public methodFocus
Sets input focus to the control.
(Inherited from Control.)
Public methodStatic memberFromBrowser
Gets the ChromiumWebBrowser associated with a specific IBrowser instance.
Protected methodGetAccessibilityObjectById
Retrieves the specified AccessibleObject.
(Inherited from Control.)
Protected methodGetAutoSizeMode
Retrieves a value indicating how a control will behave when its AutoSize property is enabled.
(Inherited from Control.)
Public methodGetBrowser
Returns the current IBrowser Instance
Public methodGetChildAtPoint(Point)
Retrieves the child control that is located at the specified coordinates.
(Inherited from Control.)
Public methodGetChildAtPoint(Point, GetChildAtPointSkip)
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
(Inherited from Control.)
Public methodGetContainerControl
Returns the next ContainerControl up the control's chain of parent controls.
(Inherited from Control.)
Public methodGetContentSizeAsync
Size of scrollable area in CSS pixels
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetNextControl
Retrieves the next control forward or back in the tab order of child controls.
(Inherited from Control.)
Public methodGetPreferredSize
Retrieves the size of a rectangular area into which a control can be fitted.
(Inherited from Control.)
Protected methodGetScaledBounds
Retrieves the bounds within which the control is scaled.
(Inherited from Control.)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Protected methodGetStyle
Retrieves the value of the specified control style bit for the control.
(Inherited from Control.)
Protected methodGetTopLevel
Determines if the control is a top-level control.
(Inherited from Control.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHide
Conceals the control from the user.
(Inherited from Control.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodInitLayout
Called after the control has been added to another container.
(Inherited from Control.)
Public methodInvalidate
Invalidates the entire surface of the control and causes the control to be redrawn.
(Inherited from Control.)
Public methodInvalidate(Region)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
(Inherited from Control.)
Public methodInvalidate(Boolean)
Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public methodInvalidate(Rectangle)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
(Inherited from Control.)
Public methodInvalidate(Region, Boolean)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public methodInvalidate(Rectangle, Boolean)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public methodInvoke(Delegate)
Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control.)
Public methodInvoke(Delegate, Object)
Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
(Inherited from Control.)
Protected methodInvokeGotFocus
Raises the GotFocus event for the specified control.
(Inherited from Control.)
Protected methodInvokeLostFocus
Raises the LostFocus event for the specified control.
(Inherited from Control.)
Protected methodInvokeOnClick
Raises the Click event for the specified control.
(Inherited from Control.)
Protected methodInvokePaint
Raises the Paint event for the specified control.
(Inherited from Control.)
Protected methodInvokePaintBackground
Raises the PaintBackground event for the specified control.
(Inherited from Control.)
Protected methodIsInputChar
Determines if a character is an input character that the control recognizes.
(Inherited from Control.)
Protected methodIsInputKey
Makes certain keys as Input keys when CefSettings.MultiThreadedMessageLoop = false
(Inherited from ChromiumHostControlBase.)
Public methodLoad
Loads the specified url in the Main Frame. If [!:IsDisposed] is true then the method call will be ignored. Same as calling [!:LoadUrl(string)]
Public methodLoadUrl
Loads the specified url in the Main Frame. Same as calling [!:Load(string)]
Public methodLoadUrlAsync
Load the url in the main frame of the browser
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodNotifyInvalidate
Raises the Invalidated event with a specified region of the control to invalidate.
(Inherited from Control.)
Protected methodOnAutoSizeChanged (Inherited from Control.)
Protected methodOnBackColorChanged
Raises the BackColorChanged event.
(Inherited from Control.)
Protected methodOnBackgroundImageChanged
Raises the BackgroundImageChanged event.
(Inherited from Control.)
Protected methodOnBackgroundImageLayoutChanged (Inherited from Control.)
Protected methodOnBindingContextChanged
Raises the BindingContextChanged event.
(Inherited from Control.)
Protected methodOnCausesValidationChanged
Raises the CausesValidationChanged event.
(Inherited from Control.)
Protected methodOnChangeUICues
Raises the ChangeUICues event.
(Inherited from Control.)
Protected methodOnClick
Raises the Click event.
(Inherited from Control.)
Protected methodOnClientSizeChanged
Raises the ClientSizeChanged event.
(Inherited from Control.)
Protected methodOnContextMenuChanged
Raises the ContextMenuChanged event.
(Inherited from Control.)
Protected methodOnContextMenuStripChanged
Raises the ContextMenuStripChanged event.
(Inherited from Control.)
Protected methodOnControlAdded
Raises the ControlAdded event.
(Inherited from Control.)
Protected methodOnControlRemoved
Raises the ControlRemoved event.
(Inherited from Control.)
Protected methodOnCreateControl (Inherited from Control.)
Protected methodOnCursorChanged
Raises the CursorChanged event.
(Inherited from Control.)
Protected methodOnDockChanged
Raises the DockChanged event.
(Inherited from Control.)
Protected methodOnDoubleClick
Raises the DoubleClick event.
(Inherited from Control.)
Protected methodOnDragDrop
Raises the DragDrop event.
(Inherited from Control.)
Protected methodOnDragEnter
Raises the DragEnter event.
(Inherited from Control.)
Protected methodOnDragLeave
Raises the DragLeave event.
(Inherited from Control.)
Protected methodOnDragOver
Raises the DragOver event.
(Inherited from Control.)
Protected methodOnEnabledChanged
Raises the EnabledChanged event.
(Inherited from Control.)
Protected methodOnEnter
Raises the Enter event.
(Inherited from Control.)
Protected methodOnFontChanged
Raises the FontChanged event.
(Inherited from Control.)
Protected methodOnForeColorChanged
Raises the ForeColorChanged event.
(Inherited from Control.)
Protected methodOnGiveFeedback
Raises the GiveFeedback event.
(Inherited from Control.)
Protected methodOnGotFocus
Raises the GotFocus event.
(Overrides ControlOnGotFocus(EventArgs).)
Protected methodOnHandleCreated
Raises the HandleCreated event.
(Overrides ControlOnHandleCreated(EventArgs).)
Protected methodOnHandleDestroyed (Overrides ControlOnHandleDestroyed(EventArgs).)
Protected methodOnHelpRequested
Raises the HelpRequested event.
(Inherited from Control.)
Protected methodOnImeModeChanged
Raises the ImeModeChanged event.
(Inherited from Control.)
Protected methodOnInvalidated
Raises the Invalidated event.
(Inherited from Control.)
Protected methodOnKeyDown
Raises the KeyDown event.
(Inherited from Control.)
Protected methodOnKeyPress
Raises the KeyPress event.
(Inherited from Control.)
Protected methodOnKeyUp
Raises the KeyUp event.
(Inherited from Control.)
Protected methodOnLayout
Raises the Layout event.
(Inherited from Control.)
Protected methodOnLeave
Raises the Leave event.
(Inherited from Control.)
Protected methodOnLocationChanged
Raises the LocationChanged event.
(Inherited from Control.)
Protected methodOnLostFocus
Raises the LostFocus event.
(Inherited from Control.)
Protected methodOnMarginChanged
Raises the MarginChanged event.
(Inherited from Control.)
Protected methodOnMouseCaptureChanged
Raises the MouseCaptureChanged event.
(Inherited from Control.)
Protected methodOnMouseClick
Raises the MouseClick event.
(Inherited from Control.)
Protected methodOnMouseDoubleClick
Raises the MouseDoubleClick event.
(Inherited from Control.)
Protected methodOnMouseDown
Raises the MouseDown event.
(Inherited from Control.)
Protected methodOnMouseEnter
Raises the MouseEnter event.
(Inherited from Control.)
Protected methodOnMouseHover
Raises the MouseHover event.
(Inherited from Control.)
Protected methodOnMouseLeave
Raises the MouseLeave event.
(Inherited from Control.)
Protected methodOnMouseMove
Raises the MouseMove event.
(Inherited from Control.)
Protected methodOnMouseUp
Raises the MouseUp event.
(Inherited from Control.)
Protected methodOnMouseWheel
Raises the MouseWheel event.
(Inherited from Control.)
Protected methodOnMove
Raises the Move event.
(Inherited from Control.)
Protected methodOnNotifyMessage
Notifies the control of Windows messages.
(Inherited from Control.)
Protected methodOnPaddingChanged
Raises the PaddingChanged event.
(Inherited from Control.)
Protected methodOnPaint
Raises the Paint event.
(Inherited from Control.)
Protected methodOnPaintBackground
Paints the background of the control.
(Inherited from Control.)
Protected methodOnParentBackColorChanged
Raises the BackColorChanged event when the BackColor property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentBackgroundImageChanged
Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentBindingContextChanged
Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentChanged
Raises the ParentChanged event.
(Inherited from Control.)
Protected methodOnParentCursorChanged
Raises the CursorChanged event.
(Inherited from Control.)
Protected methodOnParentEnabledChanged
Raises the EnabledChanged event when the Enabled property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentFontChanged
Raises the FontChanged event when the Font property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentForeColorChanged
Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentRightToLeftChanged
Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
(Inherited from Control.)
Protected methodOnParentVisibleChanged
Raises the VisibleChanged event when the Visible property value of the control's container changes.
(Inherited from Control.)
Protected methodOnPreviewKeyDown
Raises the PreviewKeyDown event.
(Inherited from Control.)
Protected methodOnPrint
Raises the Paint event.
(Inherited from Control.)
Protected methodOnQueryContinueDrag
Raises the QueryContinueDrag event.
(Inherited from Control.)
Protected methodOnRegionChanged
Raises the RegionChanged event.
(Inherited from Control.)
Protected methodOnResize
Raises the Resize event.
(Inherited from Control.)
Protected methodOnRightToLeftChanged
Raises the RightToLeftChanged event.
(Inherited from Control.)
Protected methodOnSizeChanged
Raises the SizeChanged event.
(Inherited from ChromiumHostControlBase.)
Protected methodOnStyleChanged
Raises the StyleChanged event.
(Inherited from Control.)
Protected methodOnSystemColorsChanged
Raises the SystemColorsChanged event.
(Inherited from Control.)
Protected methodOnTabIndexChanged
Raises the TabIndexChanged event.
(Inherited from Control.)
Protected methodOnTabStopChanged
Raises the TabStopChanged event.
(Inherited from Control.)
Protected methodOnTextChanged
Raises the TextChanged event.
(Inherited from Control.)
Protected methodOnValidated
Raises the Validated event.
(Inherited from Control.)
Protected methodOnValidating
Raises the Validating event.
(Inherited from Control.)
Protected methodOnVisibleChanged
Raises the VisibleChanged event.
(Inherited from ChromiumHostControlBase.)
Public methodPerformLayout
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public methodPerformLayout(Control, String)
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public methodPointToClient
Computes the location of the specified screen point into client coordinates.
(Inherited from Control.)
Public methodPointToScreen
Computes the location of the specified client point into screen coordinates.
(Inherited from Control.)
Public methodPreProcessControlMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public methodPreProcessMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Protected methodProcessCmdKey
Processes a command key.
(Inherited from Control.)
Protected methodProcessDialogChar
Processes a dialog character.
(Inherited from Control.)
Protected methodProcessDialogKey
Processes a dialog key.
(Inherited from Control.)
Protected methodProcessKeyEventArgs
Processes a key message and generates the appropriate control events.
(Inherited from Control.)
Protected methodProcessKeyMessage
Processes a keyboard message.
(Inherited from Control.)
Protected methodProcessKeyPreview
Previews a keyboard message.
(Inherited from Control.)
Protected methodProcessMnemonic
Processes a mnemonic character.
(Inherited from Control.)
Protected methodRaiseDragEvent
Raises the appropriate drag event.
(Inherited from Control.)
Protected methodRaiseKeyEvent
Raises the appropriate key event.
(Inherited from Control.)
Protected methodRaiseMouseEvent
Raises the appropriate mouse event.
(Inherited from Control.)
Protected methodRaisePaintEvent
Raises the appropriate paint event.
(Inherited from Control.)
Protected methodRecreateHandle
Forces the re-creation of the handle for the control.
(Inherited from Control.)
Public methodRectangleToClient
Computes the size and location of the specified screen rectangle in client coordinates.
(Inherited from Control.)
Public methodRectangleToScreen
Computes the size and location of the specified client rectangle in screen coordinates.
(Inherited from Control.)
Public methodRefresh
Forces the control to invalidate its client area and immediately redraw itself and any child controls.
(Inherited from Control.)
Public methodResetBackColor
Resets the BackColor property to its default value.
(Inherited from Control.)
Public methodResetBindings
Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.
(Inherited from Control.)
Public methodResetCursor
Resets the Cursor property to its default value.
(Inherited from Control.)
Public methodResetFont
Resets the Font property to its default value.
(Inherited from Control.)
Public methodResetForeColor
Resets the ForeColor property to its default value.
(Inherited from Control.)
Public methodResetImeMode
Resets the ImeMode property to its default value.
(Inherited from Control.)
Protected methodResetMouseEventArgs
Resets the control to handle the MouseLeave event.
(Inherited from Control.)
Public methodResetRightToLeft
Resets the RightToLeft property to its default value.
(Inherited from Control.)
Public methodResetText
Resets the Text property to its default value (Empty).
(Inherited from Control.)
Protected methodResizeBrowser
Resizes the browser to the specified width and height. If width and height are both 0 then the browser will be hidden and resource usage will be minimised.
(Overrides ChromiumHostControlBaseResizeBrowser(Int32, Int32).)
Public methodResumeLayout
Resumes usual layout logic.
(Inherited from Control.)
Public methodResumeLayout(Boolean)
Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
(Inherited from Control.)
Protected methodRtlTranslateAlignment(HorizontalAlignment)
Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateAlignment(LeftRightAlignment)
Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateAlignment(ContentAlignment)
Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateContent
Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateHorizontal
Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
(Inherited from Control.)
Protected methodRtlTranslateLeftRight
Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
(Inherited from Control.)
Public methodScale(Single) Obsolete.
Scales the control and any child controls.
(Inherited from Control.)
Public methodScale(SizeF)
Scales the control and all child controls by the specified scaling factor.
(Inherited from Control.)
Public methodScale(Single, Single) Obsolete.
Scales the entire control and any child controls.
(Inherited from Control.)
Protected methodScaleControl
Scales a control's location, size, padding and margin.
(Inherited from Control.)
Protected methodScaleCore
This method is not relevant for this class.
(Inherited from Control.)
Public methodSelect
Activates the control.
(Inherited from Control.)
Protected methodSelect(Boolean, Boolean)
Activates a child control. Optionally specifies the direction in the tab order to select the control from.
(Inherited from Control.)
Public methodSelectNextControl
Activates the next control.
(Inherited from Control.)
Public methodSendToBack
Sends the control to the back of the z-order.
(Inherited from Control.)
Protected methodSetAutoSizeMode
Sets a value indicating how a control will behave when its AutoSize property is enabled.
(Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32)
Sets the bounds of the control to the specified location and size.
(Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)
Sets the specified bounds of the control to the specified location and size.
(Inherited from Control.)
Protected methodSetBoundsCore
Performs the work of setting the specified bounds of this control.
(Inherited from Control.)
Protected methodSetClientSizeCore
Sets the size of the client area of the control.
(Inherited from Control.)
Protected methodSetStyle
Sets a specified ControlStyles flag to either or .
(Inherited from Control.)
Protected methodSetTopLevel
Sets the control as the top-level control.
(Inherited from Control.)
Protected methodSetVisibleCore
Sets the control to the specified visible state.
(Inherited from Control.)
Public methodShow
Displays the control to the user.
(Inherited from Control.)
Protected methodSizeFromClientSize
Determines the size of the entire control from the height and width of its client area.
(Inherited from Control.)
Public methodSuspendLayout
Temporarily suspends the layout logic for the control.
(Inherited from Control.)
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Public methodTryGetBrowserCoreById
Try and get a reference to the IBrowser instance that matches the browserId. Primarily used for geting a reference to the IBrowser used by popups.
Public methodUpdate
Causes the control to redraw the invalidated regions within its client area.
(Inherited from Control.)
Protected methodUpdateBounds
Updates the bounds of the control with the current size and location.
(Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32)
Updates the bounds of the control with the specified size and location.
(Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32)
Updates the bounds of the control with the specified size, location, and client size.
(Inherited from Control.)
Protected methodUpdateStyles
Forces the assigned styles to be reapplied to the control.
(Inherited from Control.)
Protected methodUpdateZOrder
Updates the control in its parent's z-order.
(Inherited from Control.)
Public methodWaitForInitialLoadAsync
Wait for the Browser to finish loading the initial web page.
Public methodCode exampleWaitForNavigationAsync
This resolves when the browser navigates to a new URL or reloads. It is useful for when you run code which will indirectly cause the browser to navigate. A common use case would be when executing javascript that results in a navigation. e.g. clicks a link This must be called before executing the action that navigates the browser. It may not resolve correctly if called after.
Protected methodWndProc
Processes Windows messages.
(Inherited from Control.)
Top
Events
  NameDescription
Public eventAddressChanged
Occurs when the browser address changed. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventAutoSizeChanged
This event is not relevant for this class.
(Inherited from Control.)
Public eventBackColorChanged
Occurs when the value of the BackColor property changes.
(Inherited from Control.)
Public eventBackgroundImageChanged
Occurs when the value of the BackgroundImage property changes.
(Inherited from Control.)
Public eventBackgroundImageLayoutChanged
Occurs when the BackgroundImageLayout property changes.
(Inherited from Control.)
Public eventBindingContextChanged
Occurs when the value of the BindingContext property changes.
(Inherited from Control.)
Public eventCausesValidationChanged
Occurs when the value of the CausesValidation property changes.
(Inherited from Control.)
Public eventChangeUICues
Occurs when the focus or keyboard user interface (UI) cues change.
(Inherited from Control.)
Public eventClick
Occurs when the control is clicked.
(Inherited from Control.)
Public eventClientSizeChanged
Occurs when the value of the ClientSize property changes.
(Inherited from Control.)
Public eventConsoleMessage
Event handler for receiving Javascript console messages being sent from web pages. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
Public eventContextMenuChanged
Occurs when the value of the ContextMenu property changes.
(Inherited from Control.)
Public eventContextMenuStripChanged
Occurs when the value of the ContextMenuStrip property changes.
(Inherited from Control.)
Public eventControlAdded (Inherited from Control.)
Public eventControlRemoved (Inherited from Control.)
Public eventCursorChanged
Occurs when the value of the Cursor property changes.
(Inherited from Control.)
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public eventDockChanged
Occurs when the value of the Dock property changes.
(Inherited from Control.)
Public eventDoubleClick
Occurs when the control is double-clicked.
(Inherited from Control.)
Public eventDragDrop
Occurs when a drag-and-drop operation is completed.
(Inherited from Control.)
Public eventDragEnter
Occurs when an object is dragged into the control's bounds.
(Inherited from Control.)
Public eventDragLeave
Occurs when an object is dragged out of the control's bounds.
(Inherited from Control.)
Public eventDragOver
Occurs when an object is dragged over the control's bounds.
(Inherited from Control.)
Public eventEnabledChanged
Occurs when the Enabled property value has changed.
(Inherited from Control.)
Public eventEnter
Occurs when the control is entered.
(Inherited from Control.)
Public eventFontChanged
Occurs when the Font property value changes.
(Inherited from Control.)
Public eventForeColorChanged
Occurs when the ForeColor property value changes.
(Inherited from Control.)
Public eventFrameLoadEnd
Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called for all frames irrespective of whether the request completes successfully. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventFrameLoadStart
Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a particular frame if the load request for that frame fails. For notification of overall browser load status use OnLoadingStateChange instead. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventGiveFeedback
Occurs during a drag operation.
(Inherited from Control.)
Public eventGotFocus
Occurs when the control receives focus.
(Inherited from Control.)
Public eventHandleCreated
Occurs when a handle is created for the control.
(Inherited from Control.)
Public eventHandleDestroyed
Occurs when the control's handle is in the process of being destroyed.
(Inherited from Control.)
Public eventHelpRequested
Occurs when the user requests help for a control.
(Inherited from Control.)
Public eventImeModeChanged
Occurs when the ImeMode property has changed.
(Inherited from Control.)
Public eventInvalidated
Occurs when a control's display requires redrawing.
(Inherited from Control.)
Public eventIsBrowserInitializedChanged
Event called after the underlying CEF browser instance has been created. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(Inherited from ChromiumHostControlBase.)
Public eventJavascriptMessageReceived
Event handler that will get called when the message that originates from CefSharp.PostMessage
Public eventKeyDown
Occurs when a key is pressed while the control has focus.
(Inherited from Control.)
Public eventKeyPress
Occurs when a character. space or backspace key is pressed while the control has focus.
(Inherited from Control.)
Public eventKeyUp
Occurs when a key is released while the control has focus.
(Inherited from Control.)
Public eventLayout
Occurs when a control should reposition its child controls.
(Inherited from Control.)
Public eventLeave
Occurs when the input focus leaves the control.
(Inherited from Control.)
Public eventLoadError
Event handler that will get called when the resource load for a navigation fails or is canceled. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventLoadingStateChanged
Event handler that will get called when the Loading state has changed. This event will be fired twice. Once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventLocationChanged
Occurs when the Location property value has changed.
(Inherited from Control.)
Public eventLostFocus
Occurs when the control loses focus.
(Inherited from Control.)
Public eventMarginChanged
Occurs when the control's margin changes.
(Inherited from Control.)
Public eventMouseCaptureChanged
Occurs when the control loses mouse capture.
(Inherited from Control.)
Public eventMouseClick
Occurs when the control is clicked by the mouse.
(Inherited from Control.)
Public eventMouseDoubleClick
Occurs when the control is double clicked by the mouse.
(Inherited from Control.)
Public eventMouseDown
Occurs when the mouse pointer is over the control and a mouse button is pressed.
(Inherited from Control.)
Public eventMouseEnter
Occurs when the mouse pointer enters the control.
(Inherited from Control.)
Public eventMouseHover
Occurs when the mouse pointer rests on the control.
(Inherited from Control.)
Public eventMouseLeave
Occurs when the mouse pointer leaves the control.
(Inherited from Control.)
Public eventMouseMove
Occurs when the mouse pointer is moved over the control.
(Inherited from Control.)
Public eventMouseUp
Occurs when the mouse pointer is over the control and a mouse button is released.
(Inherited from Control.)
Public eventMouseWheel
Occurs when the mouse wheel moves while the control has focus.
(Inherited from Control.)
Public eventMove
Occurs when the control is moved.
(Inherited from Control.)
Public eventPaddingChanged
Occurs when the control's padding changes.
(Inherited from Control.)
Public eventPaint
Occurs when the control is redrawn.
(Inherited from Control.)
Public eventParentChanged
Occurs when the Parent property value changes.
(Inherited from Control.)
Public eventPreviewKeyDown
Occurs before the KeyDown event when a key is pressed while focus is on this control.
(Inherited from Control.)
Public eventQueryAccessibilityHelp
Occurs when AccessibleObject is providing help to accessibility applications.
(Inherited from Control.)
Public eventQueryContinueDrag
Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
(Inherited from Control.)
Public eventRegionChanged
Occurs when the value of the Region property changes.
(Inherited from Control.)
Public eventResize
Occurs when the control is resized.
(Inherited from Control.)
Public eventRightToLeftChanged
Occurs when the RightToLeft property value changes.
(Inherited from Control.)
Public eventSizeChanged
Occurs when the Size property value changes.
(Inherited from Control.)
Public eventStatusMessage
Event handler for changes to the status message. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
Public eventStyleChanged
Occurs when the control style changes.
(Inherited from Control.)
Public eventSystemColorsChanged
Occurs when the system colors change.
(Inherited from Control.)
Public eventTabIndexChanged
Occurs when the TabIndex property value changes.
(Inherited from Control.)
Public eventTabStopChanged
Occurs when the TabStop property value changes.
(Inherited from Control.)
Public eventTextChanged
Occurs when the Text property value changes.
(Inherited from Control.)
Public eventTitleChanged
Occurs when the browser title changed. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventValidated
Occurs when the control is finished validating.
(Inherited from Control.)
Public eventValidating
Occurs when the control is validating.
(Inherited from Control.)
Public eventVisibleChanged
Occurs when the Visible property value changes.
(Inherited from Control.)
Top
Fields
Extension Methods
  NameDescription
Public Extension MethodAddWordToDictionary
Add the specified word to the spelling dictionary.
(Defined by WebBrowserExtensions.)
Public Extension MethodBack
Navigates back, must check CanGoBack before calling this method.
(Defined by WebBrowserExtensions.)
Public Extension MethodCloseDevTools
Explicitly close the developer tools window if one exists for this browser instance.
(Defined by WebBrowserExtensions.)
Public Extension MethodCopy
Execute Copy on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodCut
Execute Cut on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodDelete
Execute Delete on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodCode exampleDestroyWindow
Manually call https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-destroywindow passing in the handle returned from GetWindowHandle. This method can be used to manually close the underlying CefBrowser instance. This will avoid the WM_Close message that CEF sends by default to the top level window. (Which closes your application). This method should generally only be used in the WinForms version.
(Defined by WebBrowserExtensions.)
Public Extension MethodDisposeDevToolsContext
Dispose of the DevTools Context (if any). Used in conjunction with CefSharp.Puppeteer
(Defined by WebBrowserExtensions.)
Public Extension MethodEnsureObjectBoundAsync
Make sure an object is bound in javascript. Executes against the main frame
(Defined by JavascriptBindingExtensions.)
Public Extension MethodEvaluateScriptAsPromiseAsync
Evaluate Javascript in the context of the MainFrame of the ChromiumWebBrowser. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript. The result of the script execution in javascript is Promise.resolve so even no promise values will be treated as a promise. Your javascript should return a value. The javascript will be wrapped in an Immediately Invoked Function Expression. When the promise either trigger then/catch this returned Task will be completed.
(Defined by WebBrowserExtensions.)
Public Extension MethodEvaluateScriptAsync(String, Object)Overloaded.
Evaluate some Javascript code in the context of this WebBrowser. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.)
Public Extension MethodEvaluateScriptAsync(String, NullableTimeSpan, Boolean)Overloaded.
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript
(Defined by WebBrowserExtensions.)
Public Extension MethodEvaluateScriptAsync(NullableTimeSpan, String, Object)Overloaded.
Evaluate Javascript code in the context of this WebBrowser using the specified timeout. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript This simple helper extension will encapsulate params in single quotes (unless int, uint, etc).
(Defined by WebBrowserExtensions.)
Public Extension MethodExecuteDevToolsMethodAsync
Execute a method call over the DevTools protocol. This is a more structured version of SendDevToolsMessage. ExecuteDevToolsMethod(IBrowserHost, Int32, String, JsonString) can only be called on the CEF UI Thread, this method can be called on any thread. See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details of supported methods and the expected parameters dictionary contents. See the SendDevToolsMessage documentation for additional usage information.
(Defined by DevToolsExtensions.)
Public Extension MethodExecuteScriptAsync(String)Overloaded.
Execute Javascript in the context of this Browsers Main Frame. As the method name implies, the script will be executed asynchronously, and the method therefore returns before the script has actually been executed.
(Defined by WebBrowserExtensions.)
Public Extension MethodExecuteScriptAsync(String, Object)Overloaded.
Execute Javascript code in the context of this Browser. As the method name implies, the script will be executed asynchronously, and the method therefore returns before the script has actually been executed. This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.)
Public Extension MethodExecuteScriptAsyncWhenPageLoaded
Execute Javascript code in the context of this Browsers Main Frame. This extension method uses the LoadingStateChanged event. As the method name implies, the script will be executed asynchronously, and the method therefore returns before the script has actually been executed.
(Defined by WebBrowserExtensions.)
Public Extension MethodFind
Search for text within the current page.
(Defined by WebBrowserExtensions.)
Public Extension MethodForward
Navigates forward, must check CanGoForward before calling this method.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetBrowserHost
Shortcut method to get the browser IBrowserHost.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetCookieManager
Gets the default cookie manager associated with the IChromiumWebBrowserBase instance.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetDevToolsClient
Gets a new Instance of the DevTools client for the chromiumWebBrowser instance.
(Defined by DevToolsExtensions.)
Public Extension MethodGetFocusedFrame
Returns the focused frame for the browser window.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetMainFrame
Returns the main (top-level) frame for the browser window.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetRequestContext
Gets the RequestContext associated with the IChromiumWebBrowserBase instance.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetSourceAsync (Defined by WebBrowserExtensions.)
Public Extension MethodGetTextAsync (Defined by WebBrowserExtensions.)
Public Extension MethodGetVisibleNavigationEntryAsync
Retrieve the current NavigationEntry. Contains information like HttpStatusCode and SslStatus
(Defined by WebBrowserExtensionsEx.)
Public Extension MethodGetZoomLevelAsync
Asynchronously gets the current Zoom Level.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadHtml(String, String)Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadHtml(String, Boolean)Overloaded.
Loads html as Data Uri See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details If base64Encode is false then html will be Uri encoded.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadHtml(String, String, Encoding, Boolean)Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadUrlWithPostData
Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest).
(Defined by WebBrowserExtensions.)
Public Extension MethodPaste
Execute Paste on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodPrint
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
(Defined by WebBrowserExtensions.)
Public Extension MethodPrintToPdfAsync
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done.
(Defined by WebBrowserExtensions.)
Public Extension MethodRedo
Execute Redo on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodRegisterAsyncJsObject

Asynchronously registers a Javascript object in this specific browser instance.

Only methods of the object will be availabe.

(Defined by WebBrowserExtensions.)
Public Extension MethodRegisterJsObject
Registers a Javascript object in this specific browser instance.
(Defined by WebBrowserExtensions.)
Public Extension MethodRegisterResourceHandler
Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.
(Defined by WebBrowserExtensions.)
Public Extension MethodReloadOverloaded.
Reloads the page being displayed. This method will use data from the browser's cache, if available.
(Defined by WebBrowserExtensions.)
Public Extension MethodReload(Boolean)Overloaded.
Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc. resources will be re-fetched).
(Defined by WebBrowserExtensions.)
Public Extension MethodReplaceMisspelling
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
(Defined by WebBrowserExtensions.)
Public Extension MethodSelectAll
Execute SelectAll on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodSendMouseWheelEvent
Send a mouse wheel event to the browser.
(Defined by WebBrowserExtensions.)
Public Extension MethodSetAsPopup (Defined by WebBrowserExtensions.)
Public Extension MethodSetMainFrameDocumentContentAsync
Set the Document Content for the Main Frame using DevTools Protocol.
(Defined by DevToolsExtensions.)
Public Extension MethodSetZoomLevel
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
(Defined by WebBrowserExtensions.)
Public Extension MethodShowDevTools
Open developer tools in its own window.
(Defined by WebBrowserExtensions.)
Public Extension MethodShowDevToolsDocked(Control, String, DockStyle, Int32, Int32)Overloaded.
Open DevTools using parentControl as the parent control. If inspectElementAtX and/or inspectElementAtY are specified then the element at the specified (x,y) location will be inspected. For resize/moving to work correctly you will need to use the LifeSpanHandler implementation. (Set LifeSpanHandler to an instance of LifeSpanHandler)
(Defined by WebBrowserExtensions.)
Public Extension MethodShowDevToolsDocked(ActionChromiumHostControl, String, DockStyle, Int32, Int32)Overloaded.
Open DevTools using your own Control as the parent. If inspectElementAtX and/or inspectElementAtY are specified then the element at the specified (x,y) location will be inspected. For resize/moving to work correctly you will need to use the LifeSpanHandler implementation. (Set LifeSpanHandler to an instance of LifeSpanHandler)
(Defined by WebBrowserExtensions.)
Public Extension MethodStartDownload
Download the file at url using IDownloadHandler.
(Defined by WebBrowserExtensions.)
Public Extension MethodStop
Stops loading the current page.
(Defined by WebBrowserExtensions.)
Public Extension MethodStopFinding
Cancel all searches that are currently going on.
(Defined by WebBrowserExtensions.)
Public Extension MethodUndo
Execute Undo on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodUnRegisterResourceHandler
Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.
(Defined by WebBrowserExtensions.)
Public Extension MethodViewSource
Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is shown.
(Defined by WebBrowserExtensions.)
Public Extension MethodCode exampleWaitForSelectorAsync
Waits for a DOM element specified by the selector string to be added to or removed from the DOM. A simplified version of Puppeteer WaitForSelector. Uses a MutationObserver to wait for the element to become added or removed.
(Defined by WebBrowserExtensions.)
Top
See Also