CefSharp Documentation

File: README.md Copy Chapter

Got a quick question? Discussions here on GitHub is the preferred place to ask!

CefSharp lets you embed Chromium in .NET apps. It is a lightweight .NET wrapper around the Chromium Embedded Framework (CEF) by Marshall A. Greenblatt. About 30% of the bindings are written in C++/CLI with the majority of code here is C#. It can be used from C# or VB, or any other CLR language. CefSharp provides both WPF and WinForms web browser control implementations.

CefSharp is BSD licensed, so it can be used in both proprietary and free/open source applications. For the full details, see the LICENSE file.

If you like and use CefSharp please consider signing up for a small monthly donation, even $25 can help tremendously. See Financial Support for more details.

Releases Copy Chapter

Stable binaries are released on NuGet, and contain everything you need to embed Chromium in your .Net/CLR application. For usage see the Quick Start guide or checkout CefSharp.MinimalExample project for basic demos using the CefSharp NuGet packages.

• CefSharp.WinForms
• CefSharp.Wpf
• CefSharp.OffScreen
• CefSharp.Wpf.HwndHost (A HwndHost based WPF implementation, similar to hosting the WinForms version in WPF, supports data binding, airspace issues apply).

Documentation Copy Chapter

• See the CefSharp.Wpf.Example or CefSharp.WinForms.Example projects for example web browsers built with CefSharp. They demo most of the available features.
• See the CefSharp.MinimalExample project for a basic demo of using the CefSharp NuGet packages.
• See the General Usage Guide in help getting started/dealing with common scenarios.
• See the Wiki for work-in-progress documentation
• See the FAQ for help with common issues
• Upgrading from an earlier version of CefSharp? See the ChangeLog for breaking changes and upgrade tips.
• CefSharp API generated from the source code comments.

Contact Copy Chapter

Please keep the Issue Tracker for Bugs only please! Before submitting a PR please read CONTRIBUTING.

• CefSharp Discussions is generally where CefSharp specific questions should be asked, please search before posting, thanks!
• Stackoverflow is where generic html/javascript/C# questions can be asked.
• Chromium Embedded Framework(CEF) Forum

Branches & Forks Copy Chapter

This is the official CefSharp fork, as maintained by the CefSharp community. You can also view the entire network of public forks/branches.

Development is done in the master branch. New features are preferably added in feature branches, if the changes are more than trivial. New PR's should be targeted against master.

When a new release is imminent a release branch is created. We try to avoid making public facing API changes in release branches (Adding new features is fine, just not breaking changes).

Releases Copy Section

CI Builds
Every commit on master produces a Nuget package. Use at your own risk!

Pre-release

Stable

Release Branches Copy Section

With each release a new branch is created, for example the 92.0.260 release corresponds to the cefsharp/92 branch.
If you're new to CefSharp and are downloading the source to check it out, please use a Release branch.

* VC++ 2022 is required starting with version 138
** For NetCore packages .Net 6 or greater is required.

* VC++ 2022 is required starting with version 138
** For NetCore packages .Net 6 or greater is required.

Financial Support Copy Chapter

Is your company making money thanks to CefSharp? Do you rely on regular updates to the project? Alex Maitland needs your support! Signup to GitHub Sponsors.

One-Time or Recurring contributions can be made through GitHub Sponsors it only takes a GitHub account and a credit card. You can also make a One-Time contribution via PayPal.

As a stay at home dad I (@amaitland) rely on your contributions to help support my family.

Links Copy Chapter

• CefGlue: An alternative .NET CEF wrapper built using P/Invoke.
• CEF GitHub Project : The official CEF issue tracker
• CEF Forum : The official CEF Forum
• CEF API Docs : Well worth a read if you are implementing a new feature
• CefSharp API Doc

Projects using CefSharp Copy Chapter

• HtmlView : Visual Studio extension bringing CefSharp for showing HTML pages inside VS.
• SharpBrowser : The fastest web browser for C# with tabbed browsing and HTML5/CSS3.
• Chromely CefSharp : Build HTML Desktop Apps on .NET/.NET Core 3/.NET 5 using native GUI, HTML5/CSS.

File: CefSharp.Wpf.Example/Controls/TouchKeyboard/Readme.md Copy Chapter

Code in this folder is adapted from https://github.com/Microsoft/WPF-Samples/tree/master/Input%20and%20Commands/TouchKeyboard/TouchKeyboardNotifier

Licensed under an MIT license, see https://github.com/Microsoft/WPF-Samples/blob/master/LICENSE

The files aren't included in the .csproj file intentially as they require the Windows 10 SDK

It is reccomended that you obtain and use the https://github.com/Microsoft/WPF-Samples/tree/master/Input%20and%20Commands/TouchKeyboard/TouchKeyboardNotifier
solution provided by Microsoft. It has more advanced features including TouchKeyboardAwareDecorator, which can be used
to resize your window when the touch keyboard is visible. Please read https://github.com/Microsoft/WPF-Samples/blob/master/Input%20and%20Commands/TouchKeyboard/TouchKeyboardNotifier/Readme.md

File: CefSharp/Internals/Partial/Readme.md Copy Chapter

The ChromiumWebBrowser class in this folder is not directly included in CefSharp.dll
it is shared between the WPF, OffScreen and WinForms implementations with #if def's
to allow for the partial class to be used between the three implementations.

File: CefSharp/ModelBinding/Readme.md Copy Chapter

TODO:

• Move these classes into the JavascriptBinding namespace
  things are spead out currently and they should be consolidated.

File: README.WPF.md Copy Chapter

README (WPF)

This file provides some basic information about how to use the CefSharp.Wpf NuGet package.

CefSharp is based on CEF (Chromium Embeddable Framework), which is composed of a number of .dll and .pak files. For this reason, it's not enough to just add .NET reference to the CefSharp.Wpf and the CefSharp assemblies; the other .dll/.pak files must also exist in your projects "Output path" (as defined in the Visual Studio project properties.

This is done automatically by the CefSharp.Wpf NuGet package (or the packages it depend on). However, it is only possible to copy these files into either the Debug or Release target of your project. Because it is the default when creating a new project, and the target which is normally used when developing .NET applications, I have chosen to place them in the bin\Debug folder for now. This means that if you want to run your application in Release mode, you need to copy these files from bin\Debug to bin\Release for the moment.

To be able to use CefSharp.Wpf, you basically just have to add a ChromiumWebBrowser like this:

<Window x:Class="WpfApplication3.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:cefSharp="clr-namespace:CefSharp.Wpf;assembly=CefSharp.Wpf" Title="MainWindow" Height="350" Width="525">
    <Grid>
        <cefSharp:ChromiumWebBrowser x:Name="Browser" Address="http://www.google.com.au" />
    </Grid>
</Window>

...and in the code-behind some code like this:

public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            Cef.Initialize(new CefSettings());
        }
    }