From 24d6dca924d0bd15e1c188da5354a608444b6cbf Mon Sep 17 00:00:00 2001 From: Paolo Matarazzo <74918781+paolomatarazzo@users.noreply.github.com> Date: Mon, 13 Jan 2025 12:14:25 -0500 Subject: [PATCH] includes --- .../disable-all-blocked-key-combinations.md | 2 +- .../includes-supported-os-enterprise-plus.md | 10 ++++++++++ windows/configuration/keyboard-filter/index.md | 14 +++++++------- .../keyboardfilter-add-blocked-key-combinations.md | 2 +- .../keyboard-filter/keyboardfilter-key-names.md | 2 +- ...dfilter-list-all-configured-key-combinations.md | 2 +- .../keyboardfilter-powershell-script-samples.md | 2 +- .../keyboardfilter-wmi-provider-reference.md | 2 +- .../keyboard-filter/modify-global-settings.md | 2 +- .../keyboard-filter/predefined-key-combinations.md | 2 +- .../remove-key-combination-configurations.md | 2 +- .../keyboard-filter/wekf-customkey.md | 6 +++--- .../keyboard-filter/wekf-customkeyadd.md | 2 +- .../keyboard-filter/wekf-customkeyremove.md | 2 +- .../keyboard-filter/wekf-predefinedkey.md | 2 +- .../keyboard-filter/wekf-predefinedkeydisable.md | 2 +- .../keyboard-filter/wekf-predefinedkeyenable.md | 2 +- .../configuration/keyboard-filter/wekf-scancode.md | 4 ++-- .../keyboard-filter/wekf-scancodeadd.md | 2 +- .../keyboard-filter/wekf-scancoderemove.md | 2 +- .../configuration/keyboard-filter/wekf-settings.md | 5 ++--- 21 files changed, 40 insertions(+), 31 deletions(-) create mode 100644 windows/configuration/keyboard-filter/includes-supported-os-enterprise-plus.md diff --git a/windows/configuration/keyboard-filter/disable-all-blocked-key-combinations.md b/windows/configuration/keyboard-filter/disable-all-blocked-key-combinations.md index a1e9c9594b..b762451821 100644 --- a/windows/configuration/keyboard-filter/disable-all-blocked-key-combinations.md +++ b/windows/configuration/keyboard-filter/disable-all-blocked-key-combinations.md @@ -13,7 +13,7 @@ ms.topic: article --- # Disable all blocked key combinations - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] The following sample Windows PowerShell script uses the WMI providers to disable all blocked key combinations for Keyboard Filter by using the Windows Management Instrumentation (WMI) providers for Keyboard Filter. The key combination configurations are not removed, but Keyboard Filter stops blocking any keys. diff --git a/windows/configuration/keyboard-filter/includes-supported-os-enterprise-plus.md b/windows/configuration/keyboard-filter/includes-supported-os-enterprise-plus.md new file mode 100644 index 0000000000..7e36da09ab --- /dev/null +++ b/windows/configuration/keyboard-filter/includes-supported-os-enterprise-plus.md @@ -0,0 +1,10 @@ +--- +author: TerryWarwick +ms.author: twarwick +ms.service: windows-iot +ms.subservice: iot +ms-topic: include +ms.date: 09/30/2024 +--- + +**Supported Editions**
✅ IoT Enterprise LTSC
✅ IoT Enterprise
✅ Enterprise LTSC
✅ Enterprise
✅ Education diff --git a/windows/configuration/keyboard-filter/index.md b/windows/configuration/keyboard-filter/index.md index 892bb4a653..d323739c8b 100644 --- a/windows/configuration/keyboard-filter/index.md +++ b/windows/configuration/keyboard-filter/index.md @@ -12,9 +12,9 @@ ms.topic: article --- # Keyboard Filter - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] -You can use Keyboard Filter to suppress undesirable key presses or key combinations. Normally, a customer can use certain Microsoft Windows key combinations like Ctrl+Alt+Delete or Ctrl+Shift+Tab to alter the operation of a device by locking the screen or using Task Manager to close a running application. This behavior might not be desirable if your device is intended for a dedicated purpose. +You can use Keyboard Filter to suppress undesirable key presses or key combinations. Normally, a customer can use certain Microsoft Windows key combinations like Ctrl+Alt+Delete or Ctrl+Shift+Tab to alter the operation of a device by locking the screen or using Task Manager to close a running application. This behavior might not be desirable if your device is intended for a dedicated purpose. The Keyboard Filter feature works with physical keyboards, the Windows on-screen keyboard, and the touch keyboard. Switching from one language to another might cause the location of suppressed keys on the keyboard layout to change. Keyboard Filter detects these dynamic layout changes and continues to suppress keys correctly. @@ -27,9 +27,9 @@ The Keyboard Filter feature works with physical keyboards, the Windows on-screen * **Configure:** To customize the setting or subsettings. -* **Embedded Keyboard Filter:** This feature is called Embedded Keyboard Filter in Windows 10, version 1511. +* **Embedded Keyboard Filter:** This feature is called Embedded Keyboard Filter in Windows 10, version 1511. -* **Keyboard Filter:** This feature is called Keyboard Filter in Windows 10, version 1607 and later. +* **Keyboard Filter:** This feature is called Keyboard Filter in Windows 10, version 1607 and later. ## Turn on Keyboard Filter @@ -92,7 +92,7 @@ Keyboard Filter has the following features: ## Keyboard scan codes and layouts -When a key is pressed on a physical keyboard, the keyboard sends a scan code to the keyboard driver. The driver then sends the scan code to the OS and the OS converts the scan code into a virtual key based on the current active layout. The layout defines the mapping of keys on the physical keyboard, and has many variants. A key on a keyboard always sends the same scan code when pressed, however this scan code can map to different virtual keys for different layouts. For example, in the English (United States) keyboard layout, the key to the right of the P key maps to “{“. However, in the Swedish (Sweden) keyboard layout, the same key maps to “Å”. +When a key is pressed on a physical keyboard, the keyboard sends a scan code to the keyboard driver. The driver then sends the scan code to the OS and the OS converts the scan code into a virtual key based on the current active layout. The layout defines the mapping of keys on the physical keyboard, and has many variants. A key on a keyboard always sends the same scan code when pressed, however this scan code can map to different virtual keys for different layouts. For example, in the English (United States) keyboard layout, the key to the right of the P key maps to `{`. However, in the Swedish (Sweden) keyboard layout, the same key maps to `Å`. Keyboard Filter can block keys either by the scan code or the virtual key. Blocking keys by the scan code is useful for custom keyboards that have special scan codes that don't translate into any single virtual key. Blocking keys by the virtual key is more convenient because it's easier to read and Keyboard Filter suppresses the key correctly even when the location of the key changes because of a layout change. @@ -138,9 +138,9 @@ Keyboard filter can't block the Sleep key. Some hardware keys, such as rotation lock, don't have a defined virtual key. You can still block these keys by using the scan code of the key. -The add (+), multiply (\*), subtract (-), divide (/), and decimal (.) keys have different virtual keys and scan codes on the numeric keypad than on the main keyboard. You must block both keys to block these keys. For example, to block the multiply key, you must add a rule to block “\*” and a rule to block Multiply. +The add (+), multiply (\*), subtract (-), divide (/), and decimal (.) keys have different virtual keys and scan codes on the numeric keypad than on the main keyboard. You must block both keys to block these keys. For example, to block the multiply key, you must add a rule to block "\*" and a rule to block Multiply. -When locking the screen by using the on-screen keyboard, or a combination of a physical keyboard and the on-screen keyboard, the on-screen keyboard sends an extra Windows logo key keystroke to the OS. If your device is using the Windows 10 shell and you use keyboard filter to block Windows logo key+L, the extra Windows logo key keystroke causes the shell to switch between the **Start** screen and the last active app when a user attempts to lock the device by using the on-screen keyboard, which may be unexpected behavior. +When locking the screen by using the on-screen keyboard, or a combination of a physical keyboard and the on-screen keyboard, the on-screen keyboard sends an extra Windows logo key keystroke to the OS. If your device is using the Windows 10 shell and you use keyboard filter to block Windows logo key+L, the extra Windows logo key keystroke causes the shell to switch between the **Start** screen and the last active app when a user attempts to lock the device by using the on-screen keyboard, which may be unexpected behavior. Some custom keyboard software, such as Microsoft IntelliType Pro, can install Keyboard Filter drivers that prevent Keyboard Filter from being able to block some or all keys, typically extended keys like BrowserHome and Search. diff --git a/windows/configuration/keyboard-filter/keyboardfilter-add-blocked-key-combinations.md b/windows/configuration/keyboard-filter/keyboardfilter-add-blocked-key-combinations.md index 3b5147e625..16a6eb3de3 100644 --- a/windows/configuration/keyboard-filter/keyboardfilter-add-blocked-key-combinations.md +++ b/windows/configuration/keyboard-filter/keyboardfilter-add-blocked-key-combinations.md @@ -13,7 +13,7 @@ ms.topic: article --- # Add blocked key combinations - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to create three functions to configure Keyboard Filter so that Keyboard Filter blocks key combinations. It demonstrates several ways to use each function. diff --git a/windows/configuration/keyboard-filter/keyboardfilter-key-names.md b/windows/configuration/keyboard-filter/keyboardfilter-key-names.md index 67825c91db..a3eb1ecb85 100644 --- a/windows/configuration/keyboard-filter/keyboardfilter-key-names.md +++ b/windows/configuration/keyboard-filter/keyboardfilter-key-names.md @@ -13,7 +13,7 @@ ms.topic: article --- # Keyboard Filter key names - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] You can configure Keyboard Filter to block keys or key combinations. A key combination consists of one or more modifier keys, separated by a plus sign (+), and either a key name or a key scan code. In addition to the keys listed in the following tables, you can use the predefined key combinations names as custom key combinations. However, we recommend using the predefined key settings when enabling or disabling predefined key combinations. diff --git a/windows/configuration/keyboard-filter/keyboardfilter-list-all-configured-key-combinations.md b/windows/configuration/keyboard-filter/keyboardfilter-list-all-configured-key-combinations.md index aeb0399df8..5c88e94fd9 100644 --- a/windows/configuration/keyboard-filter/keyboardfilter-list-all-configured-key-combinations.md +++ b/windows/configuration/keyboard-filter/keyboardfilter-list-all-configured-key-combinations.md @@ -13,7 +13,7 @@ ms.topic: article --- # List all configured key combinations - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to displays all key combination configurations for Keyboard Filter. diff --git a/windows/configuration/keyboard-filter/keyboardfilter-powershell-script-samples.md b/windows/configuration/keyboard-filter/keyboardfilter-powershell-script-samples.md index 88063b903d..e68471a513 100644 --- a/windows/configuration/keyboard-filter/keyboardfilter-powershell-script-samples.md +++ b/windows/configuration/keyboard-filter/keyboardfilter-powershell-script-samples.md @@ -13,7 +13,7 @@ ms.topic: article --- # Windows PowerShell script samples for Keyboard Filter - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] The list below describes sample Windows PowerShell scripts that demonstrate how to use the Windows Management Instrumentation (WMI) providers for Keyboard Filter. diff --git a/windows/configuration/keyboard-filter/keyboardfilter-wmi-provider-reference.md b/windows/configuration/keyboard-filter/keyboardfilter-wmi-provider-reference.md index dffa6315e3..733f298c76 100644 --- a/windows/configuration/keyboard-filter/keyboardfilter-wmi-provider-reference.md +++ b/windows/configuration/keyboard-filter/keyboardfilter-wmi-provider-reference.md @@ -13,7 +13,7 @@ ms.topic: article --- # Keyboard Filter WMI provider reference - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Describes the Windows Management Instrumentation (WMI) provider classes that you use to configure Keyboard Filter during run time. diff --git a/windows/configuration/keyboard-filter/modify-global-settings.md b/windows/configuration/keyboard-filter/modify-global-settings.md index a5ae811750..049d85864a 100644 --- a/windows/configuration/keyboard-filter/modify-global-settings.md +++ b/windows/configuration/keyboard-filter/modify-global-settings.md @@ -13,7 +13,7 @@ ms.topic: article --- # Modify global settings - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] The following sample Windows PowerShell scripts use the Windows Management Instrumentation (WMI) providers to modify global settings for Keyboard Filter. diff --git a/windows/configuration/keyboard-filter/predefined-key-combinations.md b/windows/configuration/keyboard-filter/predefined-key-combinations.md index dee541f232..5eda454969 100644 --- a/windows/configuration/keyboard-filter/predefined-key-combinations.md +++ b/windows/configuration/keyboard-filter/predefined-key-combinations.md @@ -13,7 +13,7 @@ ms.topic: article --- # Predefined key combinations - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] This topic lists a set of key combinations that are predefined by a keyboard filter. You can list the value of the WEKF_PredefinedKey.Id to get a complete list of key combinations defined by a keyboard filter. diff --git a/windows/configuration/keyboard-filter/remove-key-combination-configurations.md b/windows/configuration/keyboard-filter/remove-key-combination-configurations.md index ab2c3c6348..698d0fe360 100644 --- a/windows/configuration/keyboard-filter/remove-key-combination-configurations.md +++ b/windows/configuration/keyboard-filter/remove-key-combination-configurations.md @@ -13,7 +13,7 @@ ms.topic: article --- # Remove key combination configurations - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] The following sample Windows PowerShell script uses the Windows Management Instrumentation (WMI) providers for Keyboard Filter to create two functions to remove custom-defined key combination configurations from Keyboard Filter. It demonstrates several ways to use each function. diff --git a/windows/configuration/keyboard-filter/wekf-customkey.md b/windows/configuration/keyboard-filter/wekf-customkey.md index 653c7daca3..7412c42e3d 100644 --- a/windows/configuration/keyboard-filter/wekf-customkey.md +++ b/windows/configuration/keyboard-filter/wekf-customkey.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_CustomKey - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Adds or removes custom-defined key combinations. @@ -53,9 +53,9 @@ The following tables list any methods and properties that belong to this class. ### Remarks -You can specify key combinations by including the modifier keys in the name. The most common modifier names are “Ctrl”, “Shift”, “Alt”, and “Win”. You cannot block a combination of non-modifier keys. For example, you can block a key combination of “Ctrl+Shift+F”, but you cannot block a key combination of “A+D”. +You can specify key combinations by including the modifier keys in the name. The most common modifier names are "Ctrl”, "Shift”, "Alt”, and "Win”. You cannot block a combination of non-modifier keys. For example, you can block a key combination of "Ctrl+Shift+F”, but you cannot block a key combination of "A+D”. -When you block a shift-modified key, you must enter the key as “Shift” + the unmodified key. For example, to block the % key on an English keyboard layout, you must specify the key as “Shift+5”. Attempting to block “%”, results in Keyboard Filter blocking “5” instead. +When you block a shift-modified key, you must enter the key as "Shift” + the unmodified key. For example, to block the % key on an English keyboard layout, you must specify the key as "Shift+5”. Attempting to block "%”, results in Keyboard Filter blocking "5” instead. When you specify the key combination to block, you must use the English names for the keys. For a list of the key names you can specify, see Keyboard Filter key names. diff --git a/windows/configuration/keyboard-filter/wekf-customkeyadd.md b/windows/configuration/keyboard-filter/wekf-customkeyadd.md index 5f70777e3e..9cdc091e06 100644 --- a/windows/configuration/keyboard-filter/wekf-customkeyadd.md +++ b/windows/configuration/keyboard-filter/wekf-customkeyadd.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_CustomKey.Add - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Creates a new custom key combination and enables Keyboard Filter to block the new key combination. diff --git a/windows/configuration/keyboard-filter/wekf-customkeyremove.md b/windows/configuration/keyboard-filter/wekf-customkeyremove.md index dad47f568f..b84e8d90a7 100644 --- a/windows/configuration/keyboard-filter/wekf-customkeyremove.md +++ b/windows/configuration/keyboard-filter/wekf-customkeyremove.md @@ -11,7 +11,7 @@ ms.subservice: iot --- # WEKF_CustomKey.Remove - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Removes a custom key combination, causing Keyboard Filter to stop blocking the removed key combination. diff --git a/windows/configuration/keyboard-filter/wekf-predefinedkey.md b/windows/configuration/keyboard-filter/wekf-predefinedkey.md index b3acdd2872..7fdbbb67ff 100644 --- a/windows/configuration/keyboard-filter/wekf-predefinedkey.md +++ b/windows/configuration/keyboard-filter/wekf-predefinedkey.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_PredefinedKey - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] This class blocks or unblocks predefined key combinations, such as Ctrl+Alt+Delete. diff --git a/windows/configuration/keyboard-filter/wekf-predefinedkeydisable.md b/windows/configuration/keyboard-filter/wekf-predefinedkeydisable.md index fc567dfc50..68392c8635 100644 --- a/windows/configuration/keyboard-filter/wekf-predefinedkeydisable.md +++ b/windows/configuration/keyboard-filter/wekf-predefinedkeydisable.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_PredefinedKey.Disable - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Unblocks the specified predefined key combination. diff --git a/windows/configuration/keyboard-filter/wekf-predefinedkeyenable.md b/windows/configuration/keyboard-filter/wekf-predefinedkeyenable.md index 12e260feef..f9b2966bf0 100644 --- a/windows/configuration/keyboard-filter/wekf-predefinedkeyenable.md +++ b/windows/configuration/keyboard-filter/wekf-predefinedkeyenable.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_PredefinedKey.Enable - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] This method blocks the specified predefined key combination. diff --git a/windows/configuration/keyboard-filter/wekf-scancode.md b/windows/configuration/keyboard-filter/wekf-scancode.md index 8a7ca0f297..4238deebc4 100644 --- a/windows/configuration/keyboard-filter/wekf-scancode.md +++ b/windows/configuration/keyboard-filter/wekf-scancode.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_Scancode - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Blocks or unblocks key combinations by using the keyboard scan code, which is an integer number that is generated whenever a key is pressed or released. @@ -59,7 +59,7 @@ The following tables list any constructors, methods, fields, and properties that Scan codes are generated by the keyboard whenever a key is pressed. The same physical key will always generate the same scan code, regardless of which keyboard layout is currently being used by the system. -You can specify key combinations by including the modifier keys in the *Modifiers* parameter of the **Add** method or by modifying the **Modifiers** property. The most common modifier names are “Ctrl”, “Shift”, “Alt”, and “Win”. +You can specify key combinations by including the modifier keys in the *Modifiers* parameter of the **Add** method or by modifying the **Modifiers** property. The most common modifier names are "Ctrl”, "Shift”, "Alt”, and "Win”. ## Example diff --git a/windows/configuration/keyboard-filter/wekf-scancodeadd.md b/windows/configuration/keyboard-filter/wekf-scancodeadd.md index 6be6715ce9..248ed944e6 100644 --- a/windows/configuration/keyboard-filter/wekf-scancodeadd.md +++ b/windows/configuration/keyboard-filter/wekf-scancodeadd.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_Scancode.Add - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] This method adds a new custom scan code combination and enables Keyboard Filter to block the new combination. diff --git a/windows/configuration/keyboard-filter/wekf-scancoderemove.md b/windows/configuration/keyboard-filter/wekf-scancoderemove.md index 45836508e3..2fe9b8aa4d 100644 --- a/windows/configuration/keyboard-filter/wekf-scancoderemove.md +++ b/windows/configuration/keyboard-filter/wekf-scancoderemove.md @@ -13,7 +13,7 @@ ms.topic: article --- # WEKF_Scancode.Remove - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] This method removes a custom scan code key combination, causing Keyboard Filter to stop blocking the removed combination. diff --git a/windows/configuration/keyboard-filter/wekf-settings.md b/windows/configuration/keyboard-filter/wekf-settings.md index 64701a6f5d..0ba7c0ab7d 100644 --- a/windows/configuration/keyboard-filter/wekf-settings.md +++ b/windows/configuration/keyboard-filter/wekf-settings.md @@ -7,12 +7,11 @@ ms.service: windows-iot ms.subservice: iot ms.date: 11/12/2024 ms.topic: article - - --- + # WEKF_Settings - +[!INCLUDE [Supported Editions - Enterprise Plus](includes-supported-os-enterprise-plus.md)] Enables or disables settings for Keyboard Filter.