Chromium |
ChromiumWebBrowser is the WinForms web browser control
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
CefSharp.WinForms.HostChromiumHostControlBase
CefSharp.WinFormsChromiumWebBrowser
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
CefSharp.WinForms.HostChromiumHostControlBase
CefSharp.WinFormsChromiumWebBrowser
Namespace: CefSharp.WinForms
Assembly: CefSharp.WinForms (in CefSharp.WinForms.dll) Version: 129.0.110.0 (129.0.110.0)
SyntaxThe ChromiumWebBrowser type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ChromiumWebBrowser | 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. |
| ChromiumWebBrowser(HtmlString, IRequestContext) | Initializes a new instance of the ChromiumWebBrowser class. **Important** - When using this constructor the Dock property will default to Fill. |
| ChromiumWebBrowser(String, IRequestContext) | Initializes a new instance of the ChromiumWebBrowser class. **Important** - When using this constructor the Dock property will default to Fill. |
Properties| Name | Description | |
|---|---|---|
 | AccessibilityObject | Gets the AccessibleObject assigned to the control. (Inherited from Control) |
| AccessibleDefaultActionDescription | Gets or sets the default action description of the control for use by accessibility client applications. (Inherited from Control) |
| AccessibleDescription | Gets or sets the description of the control used by accessibility client applications. (Inherited from Control) |
| AccessibleName | Gets or sets the name of the control used by accessibility client applications. (Inherited from Control) |
| AccessibleRole | Gets or sets the accessible role of the control (Inherited from Control) |
| ActivateBrowserOnCreation | 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://github.com/chromiumembedded/cef/issues/1856 |
| Address | 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). |
| AllowDrop | Gets or sets a value indicating whether the control can accept data that the user drags onto it. (Inherited from Control) |
| Anchor | 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) |
| AudioHandler | Implement IAudioHandler to handle audio events. |
| AutoScrollOffset | Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). (Inherited from Control) |
| AutoSize | This property is not relevant for this class. (Inherited from Control) |
| BackColor | Gets or sets the background color for the control. (Inherited from Control) |
| BackgroundImage | Gets or sets the background image displayed in the control. (Inherited from Control) |
| BackgroundImageLayout | Gets or sets the background image layout as defined in the ImageLayout enumeration. (Inherited from Control) |
| BindingContext | Gets or sets the BindingContext for the control. (Inherited from Control) |
| Bottom | 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) |
| Bounds | Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. (Inherited from Control) |
| BrowserCore | 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. |
| BrowserHwnd |
IntPtr that represents the CefBrowser Hwnd
Used for sending messages to the browser
e.g. resize
(Inherited from ChromiumHostControlBase) |
| BrowserSettings | Gets or sets the browser settings. |
 | CanEnableIme | Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. (Inherited from Control) |
| CanExecuteJavascriptInMainFrame | 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 |
| CanFocus | Gets a value indicating whether the control can receive focus. (Inherited from Control) |
| CanGoBack | A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false). |
| CanGoForward | A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false). |
| CanRaiseEvents | Determines if events can be raised on the control. (Inherited from Control) |
| CanSelect | Gets a value indicating whether the control can be selected. (Inherited from Control) |
| Capture | Gets or sets a value indicating whether the control has captured the mouse. (Inherited from Control) |
| CausesValidation | 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) |
| ClientRectangle | Gets the rectangle that represents the client area of the control. (Inherited from Control) |
| ClientSize | Gets or sets the height and width of the client area of the control. (Inherited from Control) |
| CompanyName | Gets the name of the company or creator of the application containing the control. (Inherited from Control) |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| ContainsFocus | Gets a value indicating whether the control, or one of its child controls, currently has the input focus. (Inherited from Control) |
| ContextMenu | Gets or sets the shortcut menu associated with the control. (Inherited from Control) |
| ContextMenuStrip | Gets or sets the ContextMenuStrip associated with this control. (Inherited from Control) |
| Controls | Gets the collection of controls contained within the control. (Inherited from Control) |
| Created | Gets a value indicating whether the control has been created. (Inherited from Control) |
| CreateParams | Gets the required creation parameters when the control handle is created. (Inherited from Control) |
| Cursor | Gets or sets the cursor that is displayed when the mouse pointer is over the control. (Inherited from Control) |
| DataBindings | Gets the data bindings for the control. (Inherited from Control) |
| DefaultCursor | Gets or sets the default cursor for the control. (Inherited from Control) |
| DefaultImeMode | Gets the default Input Method Editor (IME) mode supported by the control. (Inherited from Control) |
| DefaultMargin | Gets the space, in pixels, that is specified by default between controls. (Inherited from Control) |
| DefaultMaximumSize | Gets the length and height, in pixels, that is specified as the default maximum size of a control. (Inherited from Control) |
| DefaultMinimumSize | Gets the length and height, in pixels, that is specified as the default minimum size of a control. (Inherited from Control) |
| DefaultPadding | Gets the internal spacing, in pixels, of the contents of a control. (Inherited from Control) |
| DefaultSize |
Gets the default size of the control.
(Inherited from ChromiumHostControlBase) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| DialogHandler | Implement IDialogHandler and assign to handle dialog events. |
| DisplayHandler | Implement IDisplayHandler and assign to handle events related to browser display state. |
| DisplayRectangle | Gets the rectangle that represents the display area of the control. (Inherited from Control) |
| Disposing | Gets a value indicating whether the base Control class is in the process of disposing. (Inherited from Control) |
| Dock | 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) |
| DoubleBuffered | 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) |
| DownloadHandler | Implement IDownloadHandler and assign to handle events related to downloading files. |
| DragHandler | Implement IDragHandler and assign to handle events related to dragging. |
| Enabled | Gets or sets a value indicating whether the control can respond to user interaction. (Inherited from Control) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| FindHandler | Implement IFindHandler to handle events related to find results. |
| Focused |
Manually implement Focused because cef does not implement it.
(Overrides ControlFocused) |
| FocusHandler | The IFocusHandler for this ChromiumWebBrowser. |
| Font | Gets or sets the font of the text displayed by the control. (Inherited from Control) |
| FontHeight | Gets or sets the height of the font of the control. (Inherited from Control) |
| ForeColor | Gets or sets the foreground color of the control. (Inherited from Control) |
| FrameHandler | Implement IFrameHandler to handle frame events. |
| Handle | Gets the window handle that the control is bound to. (Inherited from Control) |
| HasChildren | Gets a value indicating whether the control contains one or more child controls. (Inherited from Control) |
| Height | Gets or sets the height of the control. (Inherited from Control) |
| ImeMode | Gets or sets the Input Method Editor (IME) mode of the control. (Inherited from Control) |
| ImeModeBase | Gets or sets the IME mode of a control. (Inherited from Control) |
| InvokeRequired | 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) |
| IsAccessible | Gets or sets a value indicating whether the control is visible to accessibility applications. (Inherited from Control) |
| IsActivating |
Set to true while handing an activating WM_ACTIVATE message.
MUST ONLY be cleared by DefaultFocusHandler.
(Inherited from ChromiumHostControlBase) |
| IsBrowserInitialized | A flag that indicates whether the WebBrowser is initialized (true) or not (false). |
| IsDisposed | Gets a value indicating whether this instance is disposed. |
| IsHandleCreated | Gets a value indicating whether the control has a handle associated with it. (Inherited from Control) |
| IsLoading | A flag that indicates whether the control is currently loading one or more web pages (true) or not (false). |
| IsMirrored | Gets a value indicating whether the control is mirrored. (Inherited from Control) |
| JavascriptObjectRepository | The javascript object repository, one repository per ChromiumWebBrowser instance. |
| JsDialogHandler | Implement IJsDialogHandler and assign to handle events related to JavaScript Dialogs. |
| KeyboardHandler | Implement IKeyboardHandler and assign to handle events related to key press. |
| LayoutEngine | Gets a cached instance of the control's layout engine. (Inherited from Control) |
| Left | 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) |
| LifeSpanHandler | Implement ILifeSpanHandler and assign to handle events related to popups. |
| LoadHandler | Implement ILoadHandler and assign to handle events related to browser load status. |
| Location | 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) |
| Margin | Gets or sets the space between controls. (Inherited from Control) |
| MaximumSize | Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. (Inherited from Control) |
| MenuHandler | Implement IContextMenuHandler and assign to handle events related to the browser context menu |
| MinimumSize | Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. (Inherited from Control) |
| Name | Gets or sets the name of the control. (Inherited from Control) |
| Padding | Gets or sets padding within the control. (Inherited from Control) |
| Parent | Gets or sets the parent container of the control. (Inherited from Control) |
| ParkControlOnHandleDestroyed | 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. |
| PermissionHandler | Implement IPermissionHandler to handle events related to permission requests. |
| PreferredSize | Gets the size of a rectangular area into which the control can fit. (Inherited from Control) |
| ProductName | Gets the product name of the assembly containing the control. (Inherited from Control) |
| ProductVersion | Gets the version of the assembly containing the control. (Inherited from Control) |
| RecreatingHandle | Gets a value indicating whether the control is currently re-creating its handle. (Inherited from Control) |
| Region | Gets or sets the window region associated with the control. (Inherited from Control) |
| RenderProcessMessageHandler | Implement IRenderProcessMessageHandler and assign to handle messages from the render process. |
| RenderRightToLeft | Obsolete. This property is now obsolete. (Inherited from Control) |
| RequestContext | Gets or sets the request context. |
| RequestHandler | Implement IRequestHandler and assign to handle events related to browser requests. |
| ResizeRedraw | Gets or sets a value indicating whether the control redraws itself when resized. (Inherited from Control) |
| ResourceRequestHandlerFactory | Implement IResourceRequestHandlerFactory and control the loading of resources |
| Right | 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) |
| RightToLeft | Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. (Inherited from Control) |
| ScaleChildren | Gets a value that determines the scaling of child controls. (Inherited from Control) |
| ShowFocusCues | Gets a value indicating whether the control should display focus rectangles. (Inherited from Control) |
| ShowKeyboardCues | Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. (Inherited from Control) |
| Site | Gets or sets the site of the control. (Inherited from Control) |
| Size | Gets or sets the height and width of the control. (Inherited from Control) |
| TabIndex | Gets or sets the tab order of the control within its container. (Inherited from Control) |
| TabStop | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. (Inherited from Control) |
| Tag | Gets or sets the object that contains data about the control. (Inherited from Control) |
| Text | Gets or sets the text associated with this control. (Inherited from Control) |
| TooltipText | The text that will be displayed as a ToolTip |
| Top | 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) |
| TopLevelControl | 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) |
| UseParentFormMessageInterceptor | 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. |
| UseWaitCursor | Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. (Inherited from Control) |
| Visible | Gets or sets a value indicating whether the control and all its child controls are displayed. (Inherited from Control) |
| Width | Gets or sets the width of the control. (Inherited from Control) |
| WindowTarget | This property is not relevant for this class. (Inherited from Control) |
Methods| Name | Description | |
|---|---|---|
 | AccessibilityNotifyClients(AccessibleEvents, Int32) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. (Inherited from Control) |
| AccessibilityNotifyClients(AccessibleEvents, Int32, Int32) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control . (Inherited from Control) |
| BeginInvoke(Delegate) | Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. (Inherited from Control) |
| BeginInvoke(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) |
| BringToFront | Brings the control to the front of the z-order. (Inherited from Control) |
| CaptureScreenshotAsync | Capture page screenshot. |
| Contains | Retrieves a value indicating whether the specified control is a child of the control. (Inherited from Control) |
| CreateAccessibilityInstance | Creates a new accessibility object for the control. (Inherited from Control) |
 | CreateBrowserWindowInfo | 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. |
| CreateControl | Forces the creation of the visible control, including the creation of the handle and any visible child controls. (Inherited from Control) |
| CreateControlsInstance | Creates a new instance of the control collection for the control. (Inherited from Control) |
| CreateGraphics | Creates the Graphics for the control. (Inherited from Control) |
| CreateHandle | Creates a handle for the control. (Inherited from Control) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| DefWndProc | Sends the specified message to the default window procedure. (Inherited from Control) |
| DestroyHandle | Destroys the handle associated with the control. (Inherited from Control) |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
| Dispose(Boolean) |
If not in design mode; Releases unmanaged and - optionally - managed resources for the ChromiumWebBrowser (Overrides ChromiumHostControlBaseDispose(Boolean)) |
| DoDragDrop | Begins a drag-and-drop operation. (Inherited from Control) |
| DrawToBitmap | Supports rendering to the specified bitmap. (Inherited from Control) |
| EndInvoke | Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. (Inherited from Control) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) |
| FindForm | Retrieves the form that the control is on. (Inherited from Control) |
| Focus | Sets input focus to the control. (Inherited from Control) |
 | FromBrowser | Gets the ChromiumWebBrowser associated with a specific IBrowser instance. |
| GetAccessibilityObjectById | Retrieves the specified AccessibleObject. (Inherited from Control) |
| GetAutoSizeMode | Retrieves a value indicating how a control will behave when its AutoSize property is enabled. (Inherited from Control) |
| GetBrowser | Returns the current IBrowser Instance |
| GetChildAtPoint(Point) | Retrieves the child control that is located at the specified coordinates. (Inherited from Control) |
| GetChildAtPoint(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) |
| GetContainerControl | Returns the next ContainerControl up the control's chain of parent controls. (Inherited from Control) |
| GetContentSizeAsync | Size of scrollable area in CSS pixels |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetNextControl | Retrieves the next control forward or back in the tab order of child controls. (Inherited from Control) |
| GetPreferredSize | Retrieves the size of a rectangular area into which a control can be fitted. (Inherited from Control) |
| GetScaledBounds | Retrieves the bounds within which the control is scaled. (Inherited from Control) |
| GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetStyle | Retrieves the value of the specified control style bit for the control. (Inherited from Control) |
| GetTopLevel | Determines if the control is a top-level control. (Inherited from Control) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Hide | Conceals the control from the user. (Inherited from Control) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| InitLayout | Called after the control has been added to another container. (Inherited from Control) |
| Invalidate | Invalidates the entire surface of the control and causes the control to be redrawn. (Inherited from Control) |
| Invalidate(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) |
| Invalidate(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) |
| Invalidate(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) |
| Invalidate(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) |
| Invalidate(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) |
| Invoke(Delegate) | Executes the specified delegate on the thread that owns the control's underlying window handle. (Inherited from Control) |
| Invoke(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) |
| InvokeGotFocus | Raises the GotFocus event for the specified control. (Inherited from Control) |
| InvokeLostFocus | Raises the LostFocus event for the specified control. (Inherited from Control) |
| InvokeOnClick | Raises the Click event for the specified control. (Inherited from Control) |
| InvokePaint | Raises the Paint event for the specified control. (Inherited from Control) |
| InvokePaintBackground | Raises the PaintBackground event for the specified control. (Inherited from Control) |
| IsInputChar | Determines if a character is an input character that the control recognizes. (Inherited from Control) |
| IsInputKey |
Makes certain keys as Input keys when CefSettings.MultiThreadedMessageLoop = false
(Inherited from ChromiumHostControlBase) |
| Load | Loads the specified url in the Main Frame. If IsDisposed is true then the method call will be ignored. Same as calling LoadUrl(String) |
| LoadUrl | Loads the specified url in the Main Frame. Same as calling Load(String) |
| LoadUrlAsync | Load the url in the main frame of the browser |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| NotifyInvalidate | Raises the Invalidated event with a specified region of the control to invalidate. (Inherited from Control) |
| OnAutoSizeChanged | Raises the AutoSizeChanged event. (Inherited from Control) |
| OnBackColorChanged | Raises the BackColorChanged event. (Inherited from Control) |
| OnBackgroundImageChanged | Raises the BackgroundImageChanged event. (Inherited from Control) |
| OnBackgroundImageLayoutChanged | Raises the BackgroundImageLayoutChanged event. (Inherited from Control) |
| OnBindingContextChanged | Raises the BindingContextChanged event. (Inherited from Control) |
| OnCausesValidationChanged | Raises the CausesValidationChanged event. (Inherited from Control) |
| OnChangeUICues | Raises the ChangeUICues event. (Inherited from Control) |
| OnClick | Raises the Click event. (Inherited from Control) |
| OnClientSizeChanged | Raises the ClientSizeChanged event. (Inherited from Control) |
| OnContextMenuChanged | Raises the ContextMenuChanged event. (Inherited from Control) |
| OnContextMenuStripChanged | Raises the ContextMenuStripChanged event. (Inherited from Control) |
| OnControlAdded | Raises the ControlAdded event. (Inherited from Control) |
| OnControlRemoved | Raises the ControlRemoved event. (Inherited from Control) |
| OnCreateControl | Raises the CreateControl method. (Inherited from Control) |
| OnCursorChanged | Raises the CursorChanged event. (Inherited from Control) |
| OnDockChanged | Raises the DockChanged event. (Inherited from Control) |
| OnDoubleClick | Raises the DoubleClick event. (Inherited from Control) |
| OnDragDrop | Raises the DragDrop event. (Inherited from Control) |
| OnDragEnter | Raises the DragEnter event. (Inherited from Control) |
| OnDragLeave | Raises the DragLeave event. (Inherited from Control) |
| OnDragOver | Raises the DragOver event. (Inherited from Control) |
| OnEnabledChanged | Raises the EnabledChanged event. (Inherited from Control) |
| OnEnter | Raises the Enter event. (Inherited from Control) |
| OnFontChanged | Raises the FontChanged event. (Inherited from Control) |
| OnForeColorChanged | Raises the ForeColorChanged event. (Inherited from Control) |
| OnGiveFeedback | Raises the GiveFeedback event. (Inherited from Control) |
| OnGotFocus | Raises the GotFocus event. (Overrides ControlOnGotFocus(EventArgs)) |
| OnHandleCreated |
Raises the HandleCreated event.
(Overrides ControlOnHandleCreated(EventArgs)) |
| OnHandleDestroyed | (Overrides ControlOnHandleDestroyed(EventArgs)) |
| OnHelpRequested | Raises the HelpRequested event. (Inherited from Control) |
| OnImeModeChanged | Raises the ImeModeChanged event. (Inherited from Control) |
| OnInvalidated | Raises the Invalidated event. (Inherited from Control) |
| OnKeyDown | Raises the KeyDown event. (Inherited from Control) |
| OnKeyPress | Raises the KeyPress event. (Inherited from Control) |
| OnKeyUp | Raises the KeyUp event. (Inherited from Control) |
| OnLayout | Raises the Layout event. (Inherited from Control) |
| OnLeave | Raises the Leave event. (Inherited from Control) |
| OnLocationChanged | Raises the LocationChanged event. (Inherited from Control) |
| OnLostFocus | Raises the LostFocus event. (Inherited from Control) |
| OnMarginChanged | Raises the MarginChanged event. (Inherited from Control) |
| OnMouseCaptureChanged | Raises the MouseCaptureChanged event. (Inherited from Control) |
| OnMouseClick | Raises the MouseClick event. (Inherited from Control) |
| OnMouseDoubleClick | Raises the MouseDoubleClick event. (Inherited from Control) |
| OnMouseDown | Raises the MouseDown event. (Inherited from Control) |
| OnMouseEnter | Raises the MouseEnter event. (Inherited from Control) |
| OnMouseHover | Raises the MouseHover event. (Inherited from Control) |
| OnMouseLeave | Raises the MouseLeave event. (Inherited from Control) |
| OnMouseMove | Raises the MouseMove event. (Inherited from Control) |
| OnMouseUp | Raises the MouseUp event. (Inherited from Control) |
| OnMouseWheel | Raises the MouseWheel event. (Inherited from Control) |
| OnMove | Raises the Move event. (Inherited from Control) |
| OnNotifyMessage | Notifies the control of Windows messages. (Inherited from Control) |
| OnPaddingChanged | Raises the PaddingChanged event. (Inherited from Control) |
| OnPaint | Raises the Paint event. (Inherited from Control) |
| OnPaintBackground | Paints the background of the control. (Inherited from Control) |
| OnParentBackColorChanged | Raises the BackColorChanged event when the BackColor property value of the control's container changes. (Inherited from Control) |
| OnParentBackgroundImageChanged | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes. (Inherited from Control) |
| OnParentBindingContextChanged | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes. (Inherited from Control) |
| OnParentChanged | Raises the ParentChanged event. (Inherited from Control) |
| OnParentCursorChanged | Raises the CursorChanged event. (Inherited from Control) |
| OnParentEnabledChanged | Raises the EnabledChanged event when the Enabled property value of the control's container changes. (Inherited from Control) |
| OnParentFontChanged | Raises the FontChanged event when the Font property value of the control's container changes. (Inherited from Control) |
| OnParentForeColorChanged | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes. (Inherited from Control) |
| OnParentRightToLeftChanged | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes. (Inherited from Control) |
| OnParentVisibleChanged | Raises the VisibleChanged event when the Visible property value of the control's container changes. (Inherited from Control) |
| OnPreviewKeyDown | Raises the PreviewKeyDown event. (Inherited from Control) |
| OnPrint | Raises the Paint event. (Inherited from Control) |
| OnQueryContinueDrag | Raises the QueryContinueDrag event. (Inherited from Control) |
| OnRegionChanged | Raises the RegionChanged event. (Inherited from Control) |
| OnResize | Raises the Resize event. (Inherited from Control) |
| OnRightToLeftChanged | Raises the RightToLeftChanged event. (Inherited from Control) |
| OnSetBrowserInitialFocus | Called from OnAfterBrowserCreated(IBrowser) when we set focus to the CefBrowser instance via SetFocus(Boolean). Method is only called if the browser got focus via OnGotFocus(EventArgs) before the call to OnAfterBrowserCreated(IBrowser). Can be overridden to provide custom behaviour. |
| OnSizeChanged |
Raises the SizeChanged event.
(Inherited from ChromiumHostControlBase) |
| OnStyleChanged | Raises the StyleChanged event. (Inherited from Control) |
| OnSystemColorsChanged | Raises the SystemColorsChanged event. (Inherited from Control) |
| OnTabIndexChanged | Raises the TabIndexChanged event. (Inherited from Control) |
| OnTabStopChanged | Raises the TabStopChanged event. (Inherited from Control) |
| OnTextChanged | Raises the TextChanged event. (Inherited from Control) |
| OnValidated | Raises the Validated event. (Inherited from Control) |
| OnValidating | Raises the Validating event. (Inherited from Control) |
| OnVisibleChanged | Raises the VisibleChanged event. (Inherited from ChromiumHostControlBase) |
| PerformLayout | Forces the control to apply layout logic to all its child controls. (Inherited from Control) |
| PerformLayout(Control, String) | Forces the control to apply layout logic to all its child controls. (Inherited from Control) |
| PointToClient | Computes the location of the specified screen point into client coordinates. (Inherited from Control) |
| PointToScreen | Computes the location of the specified client point into screen coordinates. (Inherited from Control) |
| PreProcessControlMessage | Preprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from Control) |
| PreProcessMessage | Preprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from Control) |
| ProcessCmdKey | Processes a command key. (Inherited from Control) |
| ProcessDialogChar | Processes a dialog character. (Inherited from Control) |
| ProcessDialogKey | Processes a dialog key. (Inherited from Control) |
| ProcessKeyEventArgs | Processes a key message and generates the appropriate control events. (Inherited from Control) |
| ProcessKeyMessage | Processes a keyboard message. (Inherited from Control) |
| ProcessKeyPreview | Previews a keyboard message. (Inherited from Control) |
| ProcessMnemonic | Processes a mnemonic character. (Inherited from Control) |
| RaiseDragEvent | Raises the appropriate drag event. (Inherited from Control) |
| RaiseKeyEvent | Raises the appropriate key event. (Inherited from Control) |
| RaiseMouseEvent | Raises the appropriate mouse event. (Inherited from Control) |
| RaisePaintEvent | Raises the appropriate paint event. (Inherited from Control) |
| RecreateHandle | Forces the re-creation of the handle for the control. (Inherited from Control) |
| RectangleToClient | Computes the size and location of the specified screen rectangle in client coordinates. (Inherited from Control) |
| RectangleToScreen | Computes the size and location of the specified client rectangle in screen coordinates. (Inherited from Control) |
| Refresh | Forces the control to invalidate its client area and immediately redraw itself and any child controls. (Inherited from Control) |
| ResetBackColor | Resets the BackColor property to its default value. (Inherited from Control) |
| ResetBindings | Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. (Inherited from Control) |
| ResetCursor | Resets the Cursor property to its default value. (Inherited from Control) |
| ResetFont | Resets the Font property to its default value. (Inherited from Control) |
| ResetForeColor | Resets the ForeColor property to its default value. (Inherited from Control) |
| ResetImeMode | Resets the ImeMode property to its default value. (Inherited from Control) |
| ResetMouseEventArgs | Resets the control to handle the MouseLeave event. (Inherited from Control) |
| ResetRightToLeft | Resets the RightToLeft property to its default value. (Inherited from Control) |
| ResetText | Resets the Text property to its default value. (Inherited from Control) |
| ResizeBrowser |
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)) |
| ResumeLayout | Resumes usual layout logic. (Inherited from Control) |
| ResumeLayout(Boolean) | Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. (Inherited from Control) |
| RtlTranslateAlignment(ContentAlignment) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. (Inherited from Control) |
| RtlTranslateAlignment(HorizontalAlignment) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. (Inherited from Control) |
| RtlTranslateAlignment(LeftRightAlignment) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. (Inherited from Control) |
| RtlTranslateContent | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. (Inherited from Control) |
| RtlTranslateHorizontal | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. (Inherited from Control) |
| RtlTranslateLeftRight | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. (Inherited from Control) |
| Scale(Single) | Obsolete. Scales the control and any child controls. (Inherited from Control) |
| Scale(SizeF) | Scales the control and all child controls by the specified scaling factor. (Inherited from Control) |
| Scale(Single, Single) | Obsolete. Scales the entire control and any child controls. (Inherited from Control) |
| ScaleControl | Scales a control's location, size, padding and margin. (Inherited from Control) |
| ScaleCore | This method is not relevant for this class. (Inherited from Control) |
| Select | Activates the control. (Inherited from Control) |
| Select(Boolean, Boolean) | Activates a child control. Optionally specifies the direction in the tab order to select the control from. (Inherited from Control) |
| SelectNextControl | Activates the next control. (Inherited from Control) |
| SendToBack | Sends the control to the back of the z-order. (Inherited from Control) |
| SetAutoSizeMode | Sets a value indicating how a control will behave when its AutoSize property is enabled. (Inherited from Control) |
| SetBounds(Int32, Int32, Int32, Int32) | Sets the bounds of the control to the specified location and size. (Inherited from Control) |
| SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) | Sets the specified bounds of the control to the specified location and size. (Inherited from Control) |
| SetBoundsCore | Performs the work of setting the specified bounds of this control. (Inherited from Control) |
| SetClientSizeCore | Sets the size of the client area of the control. (Inherited from Control) |
| SetStyle | Sets a specified ControlStyles flag to either true or false. (Inherited from Control) |
| SetTopLevel | Sets the control as the top-level control. (Inherited from Control) |
| SetVisibleCore | Sets the control to the specified visible state. (Inherited from Control) |
| Show | Displays the control to the user. (Inherited from Control) |
| SizeFromClientSize | Determines the size of the entire control from the height and width of its client area. (Inherited from Control) |
| SuspendLayout | Temporarily suspends the layout logic for the control. (Inherited from Control) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
| TryGetBrowserCoreById | 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. |
| UnregisterShutdownHandler | To control how Shutdown is called, this method will unsubscribe from ApplicationExit, |
| Update | Causes the control to redraw the invalidated regions within its client area. (Inherited from Control) |
| UpdateBounds | Updates the bounds of the control with the current size and location. (Inherited from Control) |
| UpdateBounds(Int32, Int32, Int32, Int32) | Updates the bounds of the control with the specified size and location. (Inherited from Control) |
| UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32) | Updates the bounds of the control with the specified size, location, and client size. (Inherited from Control) |
| UpdateStyles | Forces the assigned styles to be reapplied to the control. (Inherited from Control) |
| UpdateZOrder | Updates the control in its parent's z-order. (Inherited from Control) |
| WaitForInitialLoadAsync | Wait for the Browser to finish loading the initial web page. |
| WaitForNavigationAsync | 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. |
| WndProc | Processes Windows messages. (Inherited from Control) |
Events| Name | Description | |
|---|---|---|
 | AddressChanged | 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. |
| AutoSizeChanged | This event is not relevant for this class. (Inherited from Control) |
| BackColorChanged | Occurs when the value of the BackColor property changes. (Inherited from Control) |
| BackgroundImageChanged | Occurs when the value of the BackgroundImage property changes. (Inherited from Control) |
| BackgroundImageLayoutChanged | Occurs when the BackgroundImageLayout property changes. (Inherited from Control) |
| BindingContextChanged | Occurs when the value of the BindingContext property changes. (Inherited from Control) |
| CausesValidationChanged | Occurs when the value of the CausesValidation property changes. (Inherited from Control) |
| ChangeUICues | Occurs when the focus or keyboard user interface (UI) cues change. (Inherited from Control) |
| Click | Occurs when the control is clicked. (Inherited from Control) |
| ClientSizeChanged | Occurs when the value of the ClientSize property changes. (Inherited from Control) |
| ConsoleMessage | 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). |
| ContextMenuChanged | Occurs when the value of the ContextMenu property changes. (Inherited from Control) |
| ContextMenuStripChanged | Occurs when the value of the ContextMenuStrip property changes. (Inherited from Control) |
| ControlAdded | Occurs when a new control is added to the ControlControlCollection. (Inherited from Control) |
| ControlRemoved | Occurs when a control is removed from the ControlControlCollection. (Inherited from Control) |
| CursorChanged | Occurs when the value of the Cursor property changes. (Inherited from Control) |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| DockChanged | Occurs when the value of the Dock property changes. (Inherited from Control) |
| DoubleClick | Occurs when the control is double-clicked. (Inherited from Control) |
| DragDrop | Occurs when a drag-and-drop operation is completed. (Inherited from Control) |
| DragEnter | Occurs when an object is dragged into the control's bounds. (Inherited from Control) |
| DragLeave | Occurs when an object is dragged out of the control's bounds. (Inherited from Control) |
| DragOver | Occurs when an object is dragged over the control's bounds. (Inherited from Control) |
| EnabledChanged | Occurs when the Enabled property value has changed. (Inherited from Control) |
| Enter | Occurs when the control is entered. (Inherited from Control) |
| FontChanged | Occurs when the Font property value changes. (Inherited from Control) |
| ForeColorChanged | Occurs when the ForeColor property value changes. (Inherited from Control) |
| FrameLoadEnd | 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. |
| FrameLoadStart | 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. |
| GiveFeedback | Occurs during a drag operation. (Inherited from Control) |
| GotFocus | Occurs when the control receives focus. (Inherited from Control) |
| HandleCreated | Occurs when a handle is created for the control. (Inherited from Control) |
| HandleDestroyed | Occurs when the control's handle is in the process of being destroyed. (Inherited from Control) |
| HelpRequested | Occurs when the user requests help for a control. (Inherited from Control) |
| ImeModeChanged | Occurs when the ImeMode property has changed. (Inherited from Control) |
| Invalidated | Occurs when a control's display requires redrawing. (Inherited from Control) |
| IsBrowserInitializedChanged |
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) |
| JavascriptMessageReceived | Event handler that will get called when the message that originates from CefSharp.PostMessage |
| KeyDown | Occurs when a key is pressed while the control has focus. (Inherited from Control) |
| KeyPress | Occurs when a character. space or backspace key is pressed while the control has focus. (Inherited from Control) |
| KeyUp | Occurs when a key is released while the control has focus. (Inherited from Control) |
| Layout | Occurs when a control should reposition its child controls. (Inherited from Control) |
| Leave | Occurs when the input focus leaves the control. (Inherited from Control) |
| LoadError | 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. |
| LoadingStateChanged | 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. |
| LocationChanged | Occurs when the Location property value has changed. (Inherited from Control) |
| LostFocus | Occurs when the control loses focus. (Inherited from Control) |
| MarginChanged | Occurs when the control's margin changes. (Inherited from Control) |
| MouseCaptureChanged | Occurs when the control loses mouse capture. (Inherited from Control) |
| MouseClick | Occurs when the control is clicked by the mouse. (Inherited from Control) |
| MouseDoubleClick | Occurs when the control is double clicked by the mouse. (Inherited from Control) |
| MouseDown | Occurs when the mouse pointer is over the control and a mouse button is pressed. (Inherited from Control) |
| MouseEnter | Occurs when the mouse pointer enters the control. (Inherited from Control) |
| MouseHover | Occurs when the mouse pointer rests on the control. (Inherited from Control) |
| MouseLeave | Occurs when the mouse pointer leaves the control. (Inherited from Control) |
| MouseMove | Occurs when the mouse pointer is moved over the control. (Inherited from Control) |
| MouseUp | Occurs when the mouse pointer is over the control and a mouse button is released. (Inherited from Control) |
| MouseWheel | Occurs when the mouse wheel moves while the control has focus. (Inherited from Control) |
| Move | Occurs when the control is moved. (Inherited from Control) |
| PaddingChanged | Occurs when the control's padding changes. (Inherited from Control) |
| Paint | Occurs when the control is redrawn. (Inherited from Control) |
| ParentChanged | Occurs when the Parent property value changes. (Inherited from Control) |
| PreviewKeyDown | Occurs before the KeyDown event when a key is pressed while focus is on this control. (Inherited from Control) |
| QueryAccessibilityHelp | Occurs when AccessibleObject is providing help to accessibility applications. (Inherited from Control) |
| QueryContinueDrag | 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) |
| RegionChanged | Occurs when the value of the Region property changes. (Inherited from Control) |
| Resize | Occurs when the control is resized. (Inherited from Control) |
| RightToLeftChanged | Occurs when the RightToLeft property value changes. (Inherited from Control) |
| SizeChanged | Occurs when the Size property value changes. (Inherited from Control) |
| StatusMessage | 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). |
| StyleChanged | Occurs when the control style changes. (Inherited from Control) |
| SystemColorsChanged | Occurs when the system colors change. (Inherited from Control) |
| TabIndexChanged | Occurs when the TabIndex property value changes. (Inherited from Control) |
| TabStopChanged | Occurs when the TabStop property value changes. (Inherited from Control) |
| TextChanged | Occurs when the Text property value changes. (Inherited from Control) |
| TitleChanged | 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. |
| Validated | Occurs when the control is finished validating. (Inherited from Control) |
| Validating | Occurs when the control is validating. (Inherited from Control) |
| VisibleChanged | Occurs when the Visible property value changes. (Inherited from Control) |
Fields| Name | Description | |
|---|---|---|
 | BrowserNotInitializedExceptionErrorMessage |
Extension Methods| Name | Description | |
|---|---|---|
 | AddWordToDictionary |
Add the specified word to the spelling dictionary.
(Defined by WebBrowserExtensions) |
| Back |
Navigates back, must check CanGoBack before calling this method.
(Defined by WebBrowserExtensions) |
| CloseDevTools |
Explicitly close the developer tools window if one exists for this browser instance.
(Defined by WebBrowserExtensions) |
| Copy |
Execute Copy on the focused frame.
(Defined by WebBrowserExtensions) |
| Cut |
Execute Cut on the focused frame.
(Defined by WebBrowserExtensions) |
| Delete |
Execute Delete on the focused frame.
(Defined by WebBrowserExtensions) |
| DestroyWindow |
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) |
| DisposeDevToolsContext |
Dispose of the DevToolsContext (if any). Used in conjunction with CefSharp.Dom
(Defined by WebBrowserExtensions) |
| EnsureObjectBoundAsync |
Make sure an object is bound in javascript. Executes against the main frame
(Defined by JavascriptBindingExtensions) |
| EvaluateScriptAsPromiseAsync |
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) |
| EvaluateScriptAsync |
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) |
| EvaluateScriptAsync |
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) |
| EvaluateScriptAsync |
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) |
| EvaluateScriptAsyncT |
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 WebBrowserExtensionsEx) |
| ExecuteDevToolsMethodAsync |
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) |
| ExecuteScriptAsync |
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) |
| ExecuteScriptAsync |
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) |
| ExecuteScriptAsyncWhenPageLoaded |
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) |
| Find |
Search for text within the current page.
(Defined by WebBrowserExtensions) |
| Forward |
Navigates forward, must check CanGoForward before calling this method.
(Defined by WebBrowserExtensions) |
| FreeDevToolsContext |
Set the DevToolsContext property to null. Used in conjunction with CefSharp.Dom
(Defined by WebBrowserExtensions) |
| GetBrowserHost |
Shortcut method to get the browser IBrowserHost.
(Defined by WebBrowserExtensions) |
| GetCookieManager |
Gets the default cookie manager associated with the IChromiumWebBrowserBase instance.
(Defined by WebBrowserExtensions) |
| GetDevToolsClient |
Gets a new Instance of the DevTools client for the chromiumWebBrowser
instance.
(Defined by DevToolsExtensions) |
| GetFocusedFrame |
Returns the focused frame for the browser window.
(Defined by WebBrowserExtensions) |
| GetMainFrame |
Returns the main (top-level) frame for the browser window.
(Defined by WebBrowserExtensions) |
| GetRequestContext |
Gets the RequestContext associated with the IChromiumWebBrowserBase instance.
(Defined by WebBrowserExtensions) |
| GetSourceAsync |
Retrieve the main frame's HTML source using a TaskTResult.
(Defined by WebBrowserExtensions) |
| GetTextAsync |
Retrieve the main frame's display text using a TaskTResult.
(Defined by WebBrowserExtensions) |
| GetVisibleNavigationEntryAsync |
Retrieve the current NavigationEntry. Contains information like
HttpStatusCode and SslStatus (Defined by WebBrowserExtensionsEx) |
| GetZoomLevelAsync |
Asynchronously gets the current Zoom Level.
(Defined by WebBrowserExtensions) |
| LoadHtml |
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions) |
| LoadHtml |
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) |
| LoadHtml |
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions) |
| LoadUrlWithPostData |
Creates a new instance of IRequest with the specified Url and Method = POST and then calls
LoadRequest(IRequest).
(Defined by WebBrowserExtensions) |
| Paste |
Execute Paste on the focused frame.
(Defined by WebBrowserExtensions) |
|
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
(Defined by WebBrowserExtensions) | |
| PrintToPdfAsync |
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file
when done.
(Defined by WebBrowserExtensions) |
| Redo |
Execute Redo on the focused frame.
(Defined by WebBrowserExtensions) |
| RegisterAsyncJsObject | Asynchronously registers a Javascript object in this specific browser instance. Only methods of the object will be availabe. (Defined by WebBrowserExtensions) |
| RegisterJsObject |
Registers a Javascript object in this specific browser instance.
(Defined by WebBrowserExtensions) |
| RegisterResourceHandler |
Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of
DefaultResourceHandlerFactory.
(Defined by WebBrowserExtensions) |
| Reload |
Reloads the page being displayed. This method will use data from the browser's cache, if available.
(Defined by WebBrowserExtensions) |
| Reload |
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) |
| ReplaceMisspelling |
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
(Defined by WebBrowserExtensions) |
| SelectAll |
Execute SelectAll on the focused frame.
(Defined by WebBrowserExtensions) |
| SendMouseWheelEvent |
Send a mouse wheel event to the browser.
(Defined by WebBrowserExtensions) |
| SetAsPopup |
An IWebBrowser extension method that sets the HasParent
property used when passing a ChromiumWebBrowser instance to OnBeforePopup(IWebBrowser, IBrowser, IFrame, String, String, WindowOpenDisposition, Boolean, IPopupFeatures, IWindowInfo, IBrowserSettings, Boolean, IWebBrowser) (Defined by WebBrowserExtensions) |
| SetMainFrameDocumentContentAsync |
Set the Document Content for the Main Frame using DevTools Protocol.
(Defined by DevToolsExtensions) |
| SetZoomLevel |
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
(Defined by WebBrowserExtensions) |
| ShowDevTools |
Open developer tools in its own window.
(Defined by WebBrowserExtensions) |
| ShowDevToolsDocked |
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) |
| ShowDevToolsDocked |
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) |
| StartDownload |
Download the file at url using IDownloadHandler.
(Defined by WebBrowserExtensions) |
| Stop |
Stops loading the current page.
(Defined by WebBrowserExtensions) |
| StopFinding |
Cancel all searches that are currently going on.
(Defined by WebBrowserExtensions) |
| ToggleAudioMute |
Toggles audio mute for the current browser.
If the browser is null or has been disposed
then this command will be a no-op.
(Defined by WebBrowserExtensionsEx) |
| Undo |
Execute Undo on the focused frame.
(Defined by WebBrowserExtensions) |
| UnRegisterResourceHandler |
Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of
DefaultResourceHandlerFactory.
(Defined by WebBrowserExtensions) |
| ViewSource |
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) |
| WaitForSelectorAsync |
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) |
See Also