{"id":3058,"date":"2025-12-23T14:59:00","date_gmt":"2025-12-23T14:59:00","guid":{"rendered":"https:\/\/mindfusion.dev\/blog\/?p=3058"},"modified":"2025-12-24T10:10:42","modified_gmt":"2025-12-24T10:10:42","slug":"crafting-a-custom-wpf-virtual-keyboard-a-step-by-step-guide","status":"publish","type":"post","link":"https:\/\/mindfusion.dev\/blog\/crafting-a-custom-wpf-virtual-keyboard-a-step-by-step-guide\/","title":{"rendered":"Building a Custom-Styled WPF Virtual Keyboard: A How-To Guide"},"content":{"rendered":"\n

Creating a custom user interface often requires tailoring components to fit your application’s specific design language. In this guide, we’ll walk you through how to build and style a WPF virtual keyboard from the ground up, using the powerful MindFusion’s WPF Virtual Keyboard component<\/a>. The result will be a beautiful, resizable keyboard with custom icons, animations, and a clean, maintainable structure.<\/p>\n\n\n\n

\"A<\/a><\/p>\n\n\n

Step 1: Project Setup & NuGet Packages<\/h2>\n

First, create a new WPF Application project in Visual Studio. Once your project is ready, you’ll need to add the virtual keyboard component. You can do this easily via the NuGet Package Manager.<\/p>\n

Search for and install the following package:
\u00a0MindFusion.Keyboard.Wpf (version 5.1.0)<\/a><\/p>\n

This will add all the necessary assemblies to your project.<\/p>\n

<\/h2>\n

Step 2: Defining the Keyboard Layout<\/h2>\n\n\n

The structure of the keyboard\u2014what keys are present and where they are located\u2014is defined in a simple XML file. This approach cleanly separates the keyboard’s layout from its visual styling.<\/p>\n\n\n\n

Create an XML file in your project named device.xml<\/code>. Here’s a snippet showing how to define a few keys:<\/p>\n\n\n\n

<?xml version=\"1.0\"?>\n<KeyboardLayout xmlns:xsd=\"http:\/\/www.w3.org\/2001\/XMLSchema\" xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\">\n  <Keys>\n    <!-- A special key, like Enter or Shift -->\n    <Key xsi:type=\"SpecialKey\">\n      <Content xsi:type=\"xsd:string\">Enter<\/Content>\n      <Left>555<\/Left>\n      <Top>102<\/Top>\n      <Width>105<\/Width>\n      <Height>40<\/Height>\n      <VirtualKey>13<\/VirtualKey>\n    <\/Key>\n    \n    <!-- A regular character key -->\n    <Key xsi:type=\"RegularKey\">\n      <Left>105<\/Left>\n      <Top>101<\/Top>\n      <Width>40<\/Width>\n      <Height>40<\/Height>\n      <VirtualKey>65<\/VirtualKey> <!-- 'A' key -->\n    <\/Key>\n  <\/Keys>\n  <Width>675<\/Width>\n  <Height>250<\/Height>\n<\/KeyboardLayout>\n\n<\/code><\/pre>\n\n\n\n
Each key is defined with its position, size, and most importantly, its VirtualKey<\/code> code. This numeric code is what the operating system uses to identify the key, and we’ll use it later for styling.<\/p>\n\n\n\n
You can create the XML template for the keyboard fast and easy using online UI keyboard editor: the Virtual Keyboard Creator.<\/a><\/p>\n\n\n\n
Step 3: Adding and Initializing the Keyboard<\/h2>\n\n\n\n
With the layout defined, let’s add the keyboard to our main window.<\/p>\n\n\n\n
In ‘MainWindow.xaml’:
We’ll create a simple Grid<\/code> layout with two rows: one for the keyboard and one for a TextBox<\/code> to see our output.<\/p>\n\n\n\n
<Window x:Class=\"KeyboardTest.MainWindow\"\n        xmlns=\"http:\/\/schemas.microsoft.com\/winfx\/2006\/xaml\/presentation\"\n        xmlns:x=\"http:\/\/schemas.microsoft.com\/winfx\/2006\/xaml\"\n        xmlns:vk=\"http:\/\/mindfusion.eu\/keyboard\/wpf\"\n        mc:Ignorable=\"d\"\n        Title=\"MainWindow\" Height=\"500\" Width=\"1150\">\n    <Window.Resources>\n        <ResourceDictionary>\n            <ResourceDictionary.MergedDictionaries>\n                <ResourceDictionary Source=\"MedicalVKStyle.xaml\"\/>\n            <\/ResourceDictionary.MergedDictionaries>\n        <\/ResourceDictionary>\n    <\/Window.Resources>\n\n    <Grid>\n        <Grid.RowDefinitions>\n            <RowDefinition Height=\"*\"\/>\n            <RowDefinition Height=\"Auto\"\/>\n        <\/Grid.RowDefinitions>\n\n        <Border Grid.Row=\"0\" Background=\"#D0E9F2\" BorderThickness=\"5\" BorderBrush=\"#20788C\">\n            <vk:VirtualKeyboard x:Name=\"vk\" Margin=\"0 0 0 0\" \/>\n        <\/Border>\n\n        <TextBox Grid.Row=\"1\" x:Name=\"outputTextBox\" Margin=\"10\" MinHeight=\"50\" AcceptsReturn=\"True\" VerticalScrollBarVisibility=\"Auto\"\/>\n    <\/Grid>\n<\/Window><\/code><\/pre>\n\n\n\n
Notice we’ve also added a “ResourceDictionary” that points to “MedicalVKStyle.xaml”\u2014this is where we’ll put all our styling.<\/p>\n\n\n\n
In “MainWindow.xaml.cs”:
In the code-behind, we initialize the keyboard, load our “device.xml” layout, and link the keyboard’s output to our “TextBox”.<\/p>\n\n\n\n
public partial class MainWindow : Window\n{\n    public MainWindow()\n    {\n        InitializeComponent();\n        \n        vk.IsStandAlone = false;\n        vk.TemplateLayout = KeyboardLayout.Create(\"device.xml\");\n        vk.Background = Brushes.SkyBlue;\n        vk.LayoutRing.Add(KeyboardLayout.Create(\"device.xml\"));\n        vk.ApplyTemplate();\n        \n        \/\/ Link the keyboard to the TextBox\n        vk.InputTarget = outputTextBox;\n    }\n}<\/code><\/pre>\n\n\n\n
Step 4: Creating a Custom Style in XAML<\/h2>\n\n\n\n
This is where the styling happens. We create a new “ResourceDictionary” file named “MedicalVKStyle.xaml” to define the keyboard’s look and feel. This approach keeps our styles neatly organized and separate from the main window’s layout.<\/p>\n\n\n\n
The Base Style for All Keys<\/strong>
To avoid repeating code, we define a single base style that all keys will use. This BaseKeyStyle<\/code> defines the background gradient, border, drop shadow, and interactive animations (like changing color on mouse-over or click).<\/p>\n\n\n\n
<!-- Base Style for all keys -->\n<Style x:Key=\"BaseKeyStyle\" TargetType=\"{x:Type ContentControl}\">\n    <Setter Property=\"Template\">\n        <Setter.Value>\n            <ControlTemplate TargetType=\"{x:Type ContentControl}\">\n                <!-- ... Storyboards for animations ... -->\n                <Grid>\n                    <Rectangle x:Name=\"rectangle\" RadiusY=\"3\" RadiusX=\"3\">\n                        <Rectangle.Effect>\n                            <DropShadowEffect ShadowDepth=\"1\" BlurRadius=\"2\" Direction=\"267\"\/>\n                        <\/Rectangle.Effect>\n                        <Rectangle.Fill>\n                            <LinearGradientBrush EndPoint=\"0.5,1\" StartPoint=\"0.5,0\">\n                                <GradientStop Color=\"#FF20788C\" Offset=\"0\"\/>\n                                <GradientStop Color=\"#FF2aa1bb\" Offset=\"1\"\/>\n                            <\/LinearGradientBrush>\n                        <\/Rectangle.Fill>\n                    <\/Rectangle>\n                    <ContentPresenter HorizontalAlignment=\"Center\" VerticalAlignment=\"Center\"\/>\n                <\/Grid>\n                <!-- ... ControlTemplate.Triggers for events ... -->\n            <\/ControlTemplate>\n        <\/Setter.Value>\n    <\/Setter>\n<\/Style>\n\n<!-- Implicitly apply this style to all ContentControls -->\n<Style TargetType=\"{x:Type ContentControl}\" BasedOn=\"{StaticResource BaseKeyStyle}\"\/><\/code><\/pre>\n\n\n\n
Styling Special Keys with DataTriggers<\/strong>
For special keys like ‘Shift’, ‘Enter’, and ‘Backspace’, we want to display custom icons instead of text. We achieve this declaratively in XAML using “DataTrigger”s.<\/p>\n\n\n\n
First, we define simple “DataTemplate”s that contain only the icon “Path” data.<\/p>\n\n\n\n
<!-- DataTemplate for the Backspace icon -->\n<DataTemplate x:Key=\"key_BACKSPACE\">\n    <Grid>\n        <Path Fill=\"#FFD0E9F2\" Stretch=\"None\" Stroke=\"#FF20788C\" \n              Data=\"M21,11H6.83l3.58-3.59L9,6l-6,6,6,6,1.41-1.41L6.83,13H21V11Z\" \n              HorizontalAlignment=\"Center\" VerticalAlignment=\"Center\"\/>\n    <\/Grid>\n<\/DataTemplate><\/code><\/pre>\n\n\n\n
Then, in the “DataTemplate” for “vk:SpecialKey”, we create a “Style” that switches the “ContentTemplate” based on the key’s “VirtualKey” code.<\/p>\n\n\n\n
<DataTemplate DataType=\"{x:Type vk:SpecialKey}\">\n    <ContentControl Content=\"{Binding .}\" VerticalContentAlignment=\"Center\" HorizontalContentAlignment=\"Center\">\n        <ContentControl.Style>\n            <Style TargetType=\"ContentControl\" BasedOn=\"{StaticResource BaseKeyStyle}\">\n                <Setter Property=\"ContentTemplate\" Value=\"{StaticResource key_Def}\"\/>\n                <Style.Triggers>\n                    <!-- When VirtualKey is 16 (Shift), use the Shift icon template -->\n                    <DataTrigger Binding=\"{Binding VirtualKey}\" Value=\"16\">\n                        <Setter Property=\"ContentTemplate\" Value=\"{StaticResource key_SHIFT}\"\/>\n                    <\/DataTrigger>\n                    <!-- When VirtualKey is 8 (Backspace), use the Backspace icon template -->\n                    <DataTrigger Binding=\"{Binding VirtualKey}\" Value=\"8\">\n                        <Setter Property=\"ContentTemplate\" Value=\"{StaticResource key_BACKSPACE}\"\/>\n                    <\/DataTrigger>\n                    <!-- ... Other triggers for Enter, Tab, etc. ... -->\n                <\/Style.Triggers>\n            <\/Style>\n        <\/ContentControl.Style>\n    <\/ContentControl>\n<\/DataTemplate>\n\n\n<\/code><\/pre>\n\n\n\n
In Addition: Applying the Predefined Virtual Keyboard Styles<\/h2>\n\n\n\n
The Virtual Keyboard component itself comes with 10+ predefined styles. There’s plenty to choose from, so you might want to utilize what is already available. Here’s how it’s done:<\/p>\n\n\n\n
    \n
  1. Comment the code that loads the custom template file (MedicalVKStyle.xaml) in MainWindow.xaml:<\/li>\n<\/ol>\n\n\n\n
    ...................   \n xmlns:local=\"clr-namespace:KeyboardTest\"\n    mc:Ignorable=\"d\"\n    Title=\"MainWindow\" Height=\"500\" Width=\"1150\">\n<!--<Window.Resources>\n    <ResourceDictionary>\n        <ResourceDictionary.MergedDictionaries>\n            <ResourceDictionary Source=\"MedicalVKStyle.xaml\"><\/ResourceDictionary>\n        <\/ResourceDictionary.MergedDictionaries>\n    <\/ResourceDictionary>\n<\/Window.Resources>-->\n\n<Grid>\n    <Grid.RowDefinitions>\n................<\/code><\/pre>\n\n\n\n
    2. Import the namespace “MindFusion.UI.Wpf;”, which is part of the Virtual Keyboard NuGet package. In the constructor, specify the desired colour scheme this way:<\/p>\n\n\n\n
    using MindFusion.UI.Wpf;\n...........\n\n {\n     InitializeComponent();\n\t\n     ColorScheme.Scheme = Scheme.OfficeGreen;\n}<\/code><\/pre>\n\n\n\n
    Note that you do not need to apply the theme on the VirtualKeyboard instance directly. <\/p>\n\n\n\n
    Now, when you run the sample, instead of the custom-styled medical keyboard, the Office-Green styled keyboard is loaded:<\/p>\n\n\n\n
    \"MindFusion<\/a><\/figure>\n\n\n\n
    Download the sample: complete source code and links to the NuGet package<\/a><\/strong><\/p>\n\n\n\n
    Conclusion<\/h2>\n\n\n\n
    And there you have it! By combining an XML layout file with a powerful and reusable XAML styling system, we’ve created a fully custom and visually appealing WPF virtual keyboard<\/a>. This approach keeps the design clean, maintainable, and easy to update, separating the keyboard’s structure from its appearance and behavior.<\/p>\n\n\n\n
    \n\n\n\n
    About MindFusion Virtual Keyboard for WPF: <\/em>The MindFusion Virtual Keyboard for WPF<\/a> is a powerful and highly customizable on-screen input solution, perfect for touch-enabled applications in specialized environments. As demonstrated in this guide for creating a custom medical keyboard, its flexible design empowers developers to create bespoke layouts tailored to unique industry demands,ensuring secure and intuitive data entry. Integrate it seamlessly into your WPF applications to provide a robust and adaptable user experience.<\/p>\n\n\n\n
    <\/p>\n","protected":false},"excerpt":{"rendered":"
    Creating a custom user interface often requires tailoring components to fit your application’s specific design language. In this guide, we’ll walk you through how to build and style a WPF virtual keyboard from the ground up, using the powerful MindFusion’s … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false},"version":2}},"categories":[74,343,732],"tags":[730,702,654,391,58],"class_list":["post-3058","post","type-post","status-publish","format-standard","hentry","category-sample-code","category-ui","category-wpf","tag-dev-tools","tag-programming","tag-tutorial","tag-virtual-keyboard","tag-wpf"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p3RlKs-Nk","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/posts\/3058","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/comments?post=3058"}],"version-history":[{"count":22,"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/posts\/3058\/revisions"}],"predecessor-version":[{"id":3083,"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/posts\/3058\/revisions\/3083"}],"wp:attachment":[{"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/media?parent=3058"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/categories?post=3058"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mindfusion.dev\/blog\/wp-json\/wp\/v2\/tags?post=3058"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}