KryptonWebView2 API Reference

Namespace

Krypton.Utilities

Assembly

Krypton.Utilities.dll

Inheritance Hierarchy

System.Object
└── System.MarshalByRefObject
    └── System.ComponentModel.Component
        └── System.Windows.Forms.Control
            └── Microsoft.Web.WebView2.WinForms.WebView2
                └── Krypton.Utilities.KryptonWebView2

Conditional compilation overview

This control is only available when WEBVIEW2_AVAILABLE is defined and the target framework is .NET 8.0 or greater (NET8_0_OR_GREATER).

Class: KryptonWebView2

Summary

Provide a WebView2 control with Krypton styling applied. A modern web browser control that integrates Microsoft's WebView2 engine with the Krypton Toolkit's theming system.

Attributes

[ToolboxItem(true)] - Available in Visual Studio toolbox
[ToolboxBitmap(typeof(KryptonWebView2), "ToolboxBitmaps.WebView2.bmp")] - Custom toolbox icon
[Designer(typeof(KryptonWebView2Designer))] - Custom designer support
[DesignerCategory("code")] - Code-based designer category
[Description("Enables the user to browse web pages using the modern WebView2 engine with Krypton theming support.")] - Control description
[CLSCompliant(false)] - Not CLS compliant

Constructors

KryptonWebView2()

Summary: Initialize a new instance of the KryptonWebView2 class.

Remarks:

Enables double buffering for smooth rendering
Sets up resize redraw for proper repainting
Initializes the Krypton palette system
Registers for global palette change notifications
WebView2 engine is not initialized until EnsureCoreWebView2Async() is called

Example:

var webView = new KryptonWebView2();
webView.Size = new Size(800, 600);
await webView.EnsureCoreWebView2Async();

Properties

KryptonContextMenu property

Type: KryptonContextMenu?

Access: Public get/set

Attributes:

[Category("Behavior")]
[Description("The shortcut menu to show when the user right-clicks the page.")]
[DefaultValue(null)]

Summary: Gets and sets the KryptonContextMenu to show when right-clicked.

Value: A KryptonContextMenu instance that will be displayed when the user right-clicks on the web content, or null if no custom context menu should be shown.

Behavior:

When set to a non-null value, overrides the default WebView2 context menu
Shows at mouse position for right-clicks
Centers on control for keyboard activation (Menu key)
Setting to null restores default WebView2 context menu behavior

Example:

var contextMenu = new KryptonContextMenu();
contextMenu.Items.Add(new KryptonContextMenuItem("Copy"));
contextMenu.Items.Add(new KryptonContextMenuItem("Paste"));
webView.KryptonContextMenu = contextMenu;

AllowExternalDrop

Type: bool

Access: Public get/set

Attributes:

[Category("Behavior")]
[Description("Indicates whether the control allows external drag and drop operations.")]
[DefaultValue(false)]

Summary: Gets or sets a value indicating whether the control allows external drag and drop operations.

Value: true if external drag and drop is allowed; otherwise, false.

Remarks: This property forwards to the base WebView2 AllowExternalDrop property.

Example:

webView.AllowExternalDrop = true;

CreationProperties

Type: object?

Access: Public get/set

Attributes:

[Category("Behavior")]
[Description("Gets or sets the creation properties for the WebView2 control.")]
[DefaultValue(null)]

Summary: Gets or sets the creation properties for the WebView2 control.

Value: The creation properties, or null to use default properties.

Remarks: This property forwards to the base WebView2 CreationProperties property.

DefaultBackgroundColor

Type: Color

Access: Public get/set

Attributes:

[Category("Appearance")]
[Description("Gets or sets the default background color for the WebView2 control.")]

Summary: Gets or sets the default background color for the WebView2 control.

Value: The default background color.

Remarks: This property forwards to the base WebView2 DefaultBackgroundColor property.

Example:

webView.DefaultBackgroundColor = Color.White;

ZoomFactor

Type: double

Access: Public get/set

Attributes:

[Category("Behavior")]
[Description("Gets or sets the zoom factor for the WebView2 control.")]
[DefaultValue(1.0)]

Summary: Gets or sets the zoom factor for the WebView2 control.

Value: The zoom factor (1.0 = 100%).

Remarks: This property forwards to the base WebView2 ZoomFactor property.

Example:

webView.ZoomFactor = 1.5; // 150% zoom

Dock

Type: DockStyle

Access: Public get/set

Attributes:

[Category("Layout")]
[Description("Gets or sets which edge of the parent container a control is docked to.")]
[DefaultValue(DockStyle.None)]

Summary: Gets or sets which edge of the parent container a control is docked to.

Value: One of the DockStyle values. The default is DockStyle.None.

Remarks: This property forwards to the base Control Dock property.

Example:

webView.Dock = DockStyle.Fill;

Methods

CreateToolStripRenderer()

Signature: public ToolStripRenderer? CreateToolStripRenderer()

Attributes:

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Advanced)]

Summary: Create a tool strip renderer appropriate for the current renderer/palette pair.

Returns: A ToolStripRenderer instance that provides Krypton-themed rendering for tool strips, or null if no renderer is available.

Remarks:

Creates a renderer that matches the current Krypton theme and palette
Used internally by the control to ensure consistent theming
Can be used by advanced users who need custom tool strip rendering

Example:

var renderer = webView.CreateToolStripRenderer();
if (renderer != null)
{
    myToolStrip.Renderer = renderer;
}

GetResolvedPalette()

Signature: public PaletteBase GetResolvedPalette()

Attributes:

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]

Summary: Gets the resolved palette to actually use when drawing.

Returns: A PaletteBase instance that represents the currently active palette for this control.

Remarks:

Returns the palette currently being used for rendering this control
Determined by the control's palette mode and global palette settings
Primarily used internally by the Krypton framework for rendering operations

Example:

var palette = webView.GetResolvedPalette();
var primaryColor = palette.GetColorTable().Color1;

Protected Methods

Dispose(bool disposing)

Signature: protected override void Dispose(bool disposing)

Parameters:

disposing (bool): true if managed resources should be disposed; otherwise, false.

Summary: Clean up any resources being used.

Remarks:

Unhooks from global palette change notifications
Disposes of the associated KryptonContextMenu if present
Calls the base class Dispose method to clean up WebView2 resources
WebView2 engine automatically cleans up native resources when disposed

Example:

protected override void Dispose(bool disposing)
{
    if (disposing)
    {
        // Custom cleanup code here
    }
    base.Dispose(disposing);
}

WndProc(ref Message m)

Signature: protected override void WndProc(ref Message m)

Parameters:

m (ref Message): A Windows-based message.

Summary: Process Windows-based messages.

Remarks:

Intercepts context menu messages and provides custom KryptonContextMenu handling
Processes WM_CONTEXTMENU and WM_PARENTNOTIFY with WM_RBUTTONDOWN messages
When KryptonContextMenu is assigned:
- Extracts mouse position from message parameters
- Handles keyboard activation by centering menu on control
- Adjusts position to match standard context menu behavior
- Shows KryptonContextMenu if mouse is within client area
- Consumes message to prevent default WebView2 context menu
If no KryptonContextMenu is assigned, passes message to base class

Example:

protected override void WndProc(ref Message m)
{
    // Custom message handling before calling base
    base.WndProc(ref m);
}

OnGlobalPaletteChanged(object? sender, EventArgs e)

Signature: protected virtual void OnGlobalPaletteChanged(object? sender, EventArgs e)

Parameters:

sender (object?): Source of the event.
e (EventArgs): An EventArgs that contains the event data.

Summary: Occurs when the global palette has been changed.

Remarks:

Only responds if using the global palette mode
Updates the control with the new global palette
Can be overridden to provide custom palette change handling

Example:

protected override void OnGlobalPaletteChanged(object? sender, EventArgs e)
{
    base.OnGlobalPaletteChanged(sender, e);
    // Custom palette change handling
    ApplyCustomTheme();
}

Private Methods

SetPalette(PaletteBase palette)

Signature: private void SetPalette(PaletteBase palette)

Parameters:

palette (PaletteBase): The chosen palette.

Summary: Sets the palette being used.

Remarks:

Unhooks from current palette events
Remembers the new palette
Gets the renderer associated with the palette
Hooks to new palette events

OnBaseChanged(object? sender, EventArgs e)

Signature: private void OnBaseChanged(object? sender, EventArgs e)

Parameters:

sender (object?): The sender.
e (EventArgs): The EventArgs instance containing the event data.

Summary: Called when there is a change in base renderer or base palette.

Remarks:

Changes in base renderer or base palette require fetching the latest renderer
Updates the internal renderer reference

OnKryptonContextMenuDisposed(object? sender, EventArgs e)

Signature: private void OnKryptonContextMenuDisposed(object? sender, EventArgs e)

Parameters:

sender (object?): The sender.
e (EventArgs): The EventArgs instance containing the event data.

Summary: Handles disposal of the KryptonContextMenu.

Remarks:

When the current krypton context menu is disposed, removes it to prevent exceptions
Prevents using a disposed context menu

Inherited Properties (from WebView2)

CoreWebView2

Type: CoreWebView2?

Summary: Gets the CoreWebView2 object for the WebView2 control.

Remarks:

Returns null until EnsureCoreWebView2Async() is called
Provides access to WebView2's core functionality
Used for navigation, JavaScript execution, and event handling

Example:

await webView.EnsureCoreWebView2Async();
if (webView.CoreWebView2 != null)
{
    webView.CoreWebView2.Navigate("https://example.com");
}

Source

Type: Uri?

Summary: Gets or sets the URI of the current top-level document.

Example:

webView.Source = new Uri("https://example.com");

DocumentTitle

Type: string

Summary: Gets the title of the current top-level document.

Example:

string title = webView.DocumentTitle;

CanGoBack

Type: bool

Summary: Gets whether the WebView2 can navigate to a previous page in the navigation history.

Example:

if (webView.CanGoBack)
{
    webView.GoBack();
}

CanGoForward

Type: bool

Summary: Gets whether the WebView2 can navigate to a next page in the navigation history.

Example:

if (webView.CanGoForward)
{
    webView.GoForward();
}

Inherited Methods (from WebView2)

EnsureCoreWebView2Async()

Signature: public Task EnsureCoreWebView2Async()

Summary: Ensures that the WebView2 runtime is installed and initializes the CoreWebView2 object.

Returns: A Task that represents the asynchronous operation.

Remarks:

Must be called before using CoreWebView2
Downloads WebView2 runtime if not installed
Initializes the WebView2 engine

Example:

await webView.EnsureCoreWebView2Async();

Navigate(string uri)

Signature: public void Navigate(string uri)

Parameters:

uri (string): The URI to navigate to.

Summary: Navigates the WebView2 to the specified URI.

Example:

webView.Navigate("https://example.com");

GoBack()

Signature: public void GoBack()

Summary: Navigates the WebView2 to the previous page in the navigation history.

Example:

webView.GoBack();

GoForward()

Signature: public void GoForward()

Summary: Navigates the WebView2 to the next page in the navigation history.

Example:

webView.GoForward();

Reload()

Signature: public void Reload()

Summary: Reloads the current page.

Example:

webView.Reload();

Stop()

Signature: public void Stop()

Summary: Stops all navigations and pending resource fetches on the current page.

Example:

webView.Stop();

Events

NavigationStarting

Type: EventHandler<CoreWebView2NavigationStartingEventArgs>

Summary: Occurs when the WebView2 is about to navigate to a new page.

Example:

webView.CoreWebView2.NavigationStarting += (sender, e) =>
{
    if (e.Uri.Contains("blocked-site.com"))
    {
        e.Cancel = true;
    }
};

NavigationCompleted

Type: EventHandler<CoreWebView2NavigationCompletedEventArgs>

Summary: Occurs when the WebView2 has finished navigating to a new page.

Example:

webView.CoreWebView2.NavigationCompleted += (sender, e) =>
{
    if (e.IsSuccess)
    {
        Console.WriteLine($"Loaded: {webView.DocumentTitle}");
    }
};

DocumentTitleChanged

Type: EventHandler<object>

Summary: Occurs when the document title changes.

Example:

webView.CoreWebView2.DocumentTitleChanged += (sender, e) =>
{
    this.Text = webView.DocumentTitle;
};

NewWindowRequested

Type: EventHandler<CoreWebView2NewWindowRequestedEventArgs>

Summary: Occurs when a new window is requested.

Example:

webView.CoreWebView2.NewWindowRequested += (sender, e) =>
{
    // Open in same window instead of new window
    e.NewWindow = webView.CoreWebView2;
    e.Handled = true;
};

Requirements

System Requirements

Windows 10 version 1803 (build 17134) or later
WebView2 Runtime installed on target system
.NET 8.0 or later (.NET Framework is not supported for this control)

Dependencies

Microsoft.Web.WebView2.WinForms NuGet package
Microsoft.Web.WebView2.Core (included with WinForms package)
WebView2Loader.dll (included with WinForms package)

Conditional compilation details

The control is only available when WEBVIEW2_AVAILABLE is defined and the target framework is .NET 8.0 or greater (NET8_0_OR_GREATER). This ensures compatibility with systems that don't have WebView2 dependencies and limits availability to supported frameworks.

KryptonContextMenu class

Custom context menu system that integrates with Krypton theming.

PaletteBase

Base class for Krypton palette system.

IRenderer

Interface for Krypton rendering system.

ToolStripRenderer

Base class for tool strip rendering.

KryptonWebView2 API Reference

Namespace

Assembly

Inheritance Hierarchy

Conditional compilation overview

Class: KryptonWebView2

Summary

Attributes

Constructors

KryptonWebView2()

Properties

KryptonContextMenu property

AllowExternalDrop

CreationProperties

DefaultBackgroundColor

ZoomFactor

Dock

Methods

CreateToolStripRenderer()

GetResolvedPalette()

Protected Methods

Dispose(bool disposing)

WndProc(ref Message m)

OnGlobalPaletteChanged(object? sender, EventArgs e)

Private Methods

SetPalette(PaletteBase palette)

OnBaseChanged(object? sender, EventArgs e)

OnKryptonContextMenuDisposed(object? sender, EventArgs e)

Inherited Properties (from WebView2)

CoreWebView2

Source

DocumentTitle

CanGoBack

CanGoForward

Inherited Methods (from WebView2)

EnsureCoreWebView2Async()

Navigate(string uri)

GoBack()

GoForward()

Reload()

Stop()

Events

NavigationStarting

NavigationCompleted

DocumentTitleChanged

NewWindowRequested

Requirements

System Requirements

Dependencies

Conditional compilation details

Related Types

KryptonContextMenu class

PaletteBase

IRenderer

ToolStripRenderer

See Also