ColorFilter

resources/Microsoft.Windows.Setting.Accessibility/Microsoft.Windows.Setting.Accessibility.psd1

@@ -15,7 +15,8 @@
         'MousePointer',
         'VisualEffect',
         'Audio',
-        'TextCursor'
+        'TextCursor',
+        'ColorFilter'
     )
     PrivateData = @{
         PSData = @{
@@ -26,7 +27,8 @@
                 'PSDscResource_MousePointer',
                 'PSDscResource_VisualEffect',
                 'PSDscResource_Audio',
-                'PSDscResource_TextCursor'
+                'PSDscResource_TextCursor',
+                'PSDscResource_ColorFilter'
             )
 
             # Prerelease string of this module

resources/Microsoft.Windows.Setting.Accessibility/Microsoft.Windows.Setting.Accessibility.psm1

@@ -28,6 +28,16 @@ enum PointerSize {
     ExtraLarge
 }
 
+enum ColorFilters {
+    KeepCurrentValue
+    Greyscale
+    Inverted
+    GreyscaleInverted
+    Deuteranopia
+    Protanopia
+    Tritanopia
+}
+
 if ([string]::IsNullOrEmpty($env:TestRegistryPath)) {
     $global:AccessibilityRegistryPath = 'HKCU:\Software\Microsoft\Accessibility\'
     $global:MagnifierRegistryPath = 'HKCU:\Software\Microsoft\ScreenMagnifier\'
@@ -37,10 +47,11 @@ if ([string]::IsNullOrEmpty($env:TestRegistryPath)) {
     $global:PersonalizationRegistryPath = 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Themes\Personalize\'
     $global:NTAccessibilityRegistryPath = 'HKCU:\Software\Microsoft\Windows NT\CurrentVersion\Accessibility\'
     $global:CursorIndicatorAccessibilityRegistryPath = 'HKCU:\Software\Microsoft\Accessibility\CursorIndicator\'
-    $global:ControlPanelDesktopRegistryPath= 'HKCU:\Control Panel\Desktop'
+    $global:ControlPanelDesktopRegistryPath = 'HKCU:\Control Panel\Desktop'
+    $global:ColorFilteringRegistryPath = 'HKCU:\Software\Microsoft\ColorFiltering'
 }
 else {
-    $global:AccessibilityRegistryPath = $global:MagnifierRegistryPath = $global:PointerRegistryPath = $global:ControlPanelAccessibilityRegistryPath = $global:AudioRegistryPath = $global:PersonalizationRegistryPath = $global:NTAccessibilityRegistryPath = $global:CursorIndicatorAccessibilityRegistryPath = $global:ControlPanelDesktopRegistryPath = $env:TestRegistryPath
+    $global:AccessibilityRegistryPath = $global:MagnifierRegistryPath = $global:PointerRegistryPath = $global:ControlPanelAccessibilityRegistryPath = $global:AudioRegistryPath = $global:PersonalizationRegistryPath = $global:NTAccessibilityRegistryPath = $global:CursorIndicatorAccessibilityRegistryPath = $global:ControlPanelDesktopRegistryPath = $global:ColorFilteringRegistryPath = $env:TestRegistryPath
 }
 
 [DSCResource()]	
@@ -584,6 +595,128 @@ class TextCursor
     }
 }
 
+[DSCResource()]
+class ColorFilter
+{
+    # Key required. Do not set.
+    [DscProperty(Key)] [string] $SID
+    [DscProperty()] [nullable[bool]] $FilterStatus
+    [DscProperty()] [ColorFilters] $FilterColor
+    [DscProperty()] [nullable[bool]] $KeyboardShortcutStatus
+
+    static hidden [string] $FilterStatusProperty = 'Configuration'
+    static hidden [string] $FilterStatusActiveProperty = 'Active'
+    static hidden [string] $FilterStatusValue = 'colorfiltering'
+    static hidden [string] $FilterColorProperty = 'FilterType'
+    static hidden [string] $KeyboardShortcutStatusProperty = 'HotkeyEnabled'
+
+    static [bool] GetStatus()
+    {
+        $FilterStatusArgs = @{  Path = $global:NTAccessibilityRegistryPath; Name = ([ColorFilter]::FilterStatusProperty)}
+        if (-not(DoesRegistryKeyPropertyExist @FilterStatusArgs))
+        {
+            return $false
+        }
+        else
+        {
+            $colorFilterSetting = (Get-ItemProperty @FilterStatusArgs).Configuration
+            return ($colorFilterSetting -eq ([ColorFilter]::FilterStatusValue))
+        }
+    }
+
+    static [int] GetColor()
+    {
+        $FilterColorArgs = @{  Path = $global:ColorFilteringRegistryPath; Name = ([ColorFilter]::FilterColorProperty)}
+        if (-not(DoesRegistryKeyPropertyExist @FilterColorArgs))
+        {
+            return $false
+        }
+        else
+        {
+            $colorFilterSetting = (Get-ItemProperty @FilterColorArgs).FilterType
+            return $colorFilterSetting
+        }        
+    }
+
+    static [nullable[bool]] GetKeyboardShortcutStatus()
+    {
+        $KeyboardShortcutStatusArgs = @{ Path = $global:ColorFilteringRegistryPath; Name = ([ColorFilter]::KeyboardShortcutStatusProperty); }
+        if (-not(DoesRegistryKeyPropertyExist @KeyboardShortcutStatusArgs))
+        {
+            return $false
+        }
+        else
+        {
+            $colorFilterSetting = (Get-ItemProperty @KeyboardShortcutStatusArgs).HotkeyEnabled
+            return $colorFilterSetting
+        }        
+    }
+
+    [ColorFilter] Get()
+    {
+        $currentState = [ColorFilter]::new()
+        $currentState.FilterStatus = [ColorFilter]::GetStatus()
+        $currentState.FilterColor = [ColorFilter]::GetColor()
+        $currentState.KeyboardShortcutStatus = [ColorFilter]::GetKeyboardShortcutStatus()
+
+        return $currentState
+    }
+
+    [bool] Test()
+    {
+        $currentState = $this.Get()
+        if (($null -ne $this.FilterStatus) -and ($this.FilterStatus -ne $currentState.FilterStatus))
+        {
+            return $false
+        }
+        if ((0 -ne $this.FilterColor) -and ($this.FilterColor -ne $currentState.FilterColor))
+        {
+            return $false
+        }
+        if (($null -ne $this.KeyboardShortcutStatus) -and ($this.KeyboardShortcutStatus -ne $currentState.KeyboardShortcutStatus))
+        {
+            return $false
+        }
+
+        return $true
+    }
+
+    [void] Set()
+    {
+        if (-not $this.Test())
+        {
+            if ($null -ne $this.FilterStatus) 
+            {
+                $FilterStatusArgs = @{ Path = $global:NTAccessibilityRegistryPath; Name = ([ColorFilter]::FilterStatusProperty); }
+                $ColorFilterValue = if ($this.FilterStatus) { ([ColorFilter]::FilterStatusValue) } else { "" }
+                Set-ItemProperty @FilterStatusArgs -Value $ColorFilterValue
+            }
+
+            if (0 -ne $this.FilterColor) 
+            {
+                $FilterColorArgs = @{  Path = $global:ColorFilteringRegistryPath; Name = ([ColorFilter]::FilterColorProperty)}
+                $min = 1
+                $max = 99999999
+                if ($this.FilterColor  -notin $min..$max) 
+                { 
+                    throw "FilterColor must be between $min and $max. Value $($this.FilterColor) was provided." 
+                }
+                if (-not (DoesRegistryKeyPropertyExist @FilterColorArgs)) {
+                    New-ItemProperty @FilterColorArgs -Value $this.FilterColor -PropertyType DWord
+                }
+                Set-ItemProperty @FilterColorArgs -Value $this.FilterColor 
+            }
+
+            if ($null -ne $this.KeyboardShortcutStatus) 
+            {
+                $KeyboardShortcutStatusArgs = @{ Path = $global:ColorFilteringRegistryPath; Name = ([ColorFilter]::KeyboardShortcutStatusProperty); }
+                $ColorFilterValue = if ($this.KeyboardShortcutStatus) { ([ColorFilter]::KeyboardShortcutStatusProperty) } else { "" }
+                Set-ItemProperty @KeyboardShortcutStatusArgs -Value $ColorFilterValue
+            }
+        }
+    }
+}
+
 #region Functions
 function DoesRegistryKeyPropertyExist {
     param (

tests/Microsoft.Windows.Setting.Accessibility/Microsoft.Windows.Setting.Accessibility.Tests.ps1

@@ -27,9 +27,9 @@ BeforeAll {
 
 Describe 'List available DSC resources' {
     It 'Shows DSC Resources' {
-        $expectedDSCResources = "Text", "Magnifier", "MousePointer", "VisualEffect", "Audio", "TextCursor"
+        $expectedDSCResources = "Text", "Magnifier", "MousePointer", "VisualEffect", "Audio", "TextCursor", "ColorFilter"
         $availableDSCResources = (Get-DscResource -Module Microsoft.Windows.Setting.Accessibility).Name
-        $availableDSCResources.length | Should -Be 6
+        $availableDSCResources.length | Should -Be 7
         $availableDSCResources | Where-Object { $expectedDSCResources -notcontains $_ } | Should -BeNullOrEmpty -ErrorAction Stop
     }
 }
@@ -279,6 +279,62 @@ Describe 'TextCursor'{
     }
 }
 
+Describe 'ColorFilter'{
+    It 'FilterStatus.'{
+        $initialState = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Get -Property @{}
+        $initialState.FilterStatus # Should -Be $false
+
+        # Set 'FilterStatus' to true.
+        $parameters = @{ FilterStatus = $true }
+        $testResult = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Test -Property $parameters
+        $testResult.InDesiredState | Should -Be $false
+
+        # Verify the changes are correct.
+        Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Set -Property $parameters
+        $finalState = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Get -Property @{}
+        $finalState.FilterStatus | Should -Be $true
+
+        $testResult2 = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Test -Property $parameters
+        $testResult2.InDesiredState | Should -Be $true
+    }
+    It 'FilterColor.'{ 
+        Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Set -Property @{ FilterColor = 2 }
+
+        $initialState = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Get -Property @{}
+        $initialState.FilterColor | Should -Be 2
+
+        # Set 'FilterColor' to 3.
+        $parameters = @{ FilterColor = 3 } #Increment default by 1
+        $testResult = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Test -Property $parameters
+        $testResult.InDesiredState | Should -Be $false
+
+        # Verify the changes are correct.
+        Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Set -Property $parameters
+        $finalState = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Get -Property @{}
+        $finalState.FilterColor | Should -Be 3
+
+        $testResult2 = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Test -Property $parameters
+        $testResult2.InDesiredState | Should -Be $true
+    }
+    It 'KeyboardShortcutStatus.'{
+        $initialState = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Get -Property @{}
+        $initialState.KeyboardShortcutStatus # Should -Be $false
+
+        # Set 'KeyboardShortcutStatus' to true.
+        $parameters = @{ KeyboardShortcutStatus = $true }
+        $testResult = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Test -Property $parameters
+        $testResult.InDesiredState | Should -Be $false
+
+        # Verify the changes are correct.
+        Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Set -Property $parameters
+        $finalState = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Get -Property @{}
+        $finalState.KeyboardShortcutStatus | Should -Be $true
+
+        $testResult2 = Invoke-DscResource -Name ColorFilter -ModuleName Microsoft.Windows.Setting.Accessibility -Method Test -Property $parameters
+        $testResult2.InDesiredState | Should -Be $true
+    }
+}
+
 AfterAll {
     $env:TestRegistryPath = ""
 }