From 88873b009d3aa79eab6df6823067c8bec684adc5 Mon Sep 17 00:00:00 2001 From: Chris Kaczor Date: Fri, 7 Apr 2023 16:18:15 -0400 Subject: [PATCH] Initial commit --- .gitignore | 350 ++++++++++++++++++++++++++++++++++++++ LICENSE | 21 +++ README.md | 15 ++ RequiredValidationRule.cs | 25 +++ WindowExtensions.cs | 126 ++++++++++++++ Wpf.Validation.csproj | 22 +++ Wpf.Validation.sln | 25 +++ azure-pipelines.yml | 45 +++++ 8 files changed, 629 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 RequiredValidationRule.cs create mode 100644 WindowExtensions.cs create mode 100644 Wpf.Validation.csproj create mode 100644 Wpf.Validation.sln create mode 100644 azure-pipelines.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dfcfd56 --- /dev/null +++ b/.gitignore @@ -0,0 +1,350 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9bb69bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Chris Kaczor + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d6fe0f --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# ChrisKaczor.Wpf.Validation + +WPF validation rules and extension methods to help with validation. + +## Authors + +* **Chris Kaczor** - *Initial work* - https://github.com/ckaczor - https://chriskaczor.com + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. + +## Disclaimer + +This code is used by my various personal projects and may not be useful or work in all use cases. \ No newline at end of file diff --git a/RequiredValidationRule.cs b/RequiredValidationRule.cs new file mode 100644 index 0000000..0de045b --- /dev/null +++ b/RequiredValidationRule.cs @@ -0,0 +1,25 @@ +using System.Globalization; +using System.Windows.Controls; + +namespace ChrisKaczor.Wpf.Validation +{ + public class RequiredValidationRule : ValidationRule + { + public static string GetErrorMessage(object? fieldValue) + { + var errorMessage = string.Empty; + + if (fieldValue == null || string.IsNullOrWhiteSpace(fieldValue.ToString())) + errorMessage = "Required"; + + return errorMessage; + } + + public override ValidationResult Validate(object value, CultureInfo cultureInfo) + { + var error = GetErrorMessage(value); + + return !string.IsNullOrEmpty(error) ? new ValidationResult(false, error) : ValidationResult.ValidResult; + } + } +} diff --git a/WindowExtensions.cs b/WindowExtensions.cs new file mode 100644 index 0000000..539dee0 --- /dev/null +++ b/WindowExtensions.cs @@ -0,0 +1,126 @@ +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Windows; +using System.Windows.Controls; +using System.Windows.Data; +using System.Windows.Media; + +namespace ChrisKaczor.Wpf.Validation +{ + public class BindingExpressionInfo + { + public FrameworkElement FrameworkElement { get; } + public BindingExpression BindingExpression { get; } + + public BindingExpressionInfo(FrameworkElement frameworkElement, BindingExpression bindingExpression) + { + FrameworkElement = frameworkElement; + BindingExpression = bindingExpression; + } + } + + public static class WindowExtensions + { + public static List GetBindingExpressions(this DependencyObject parent) + { + return GetBindingExpressions(parent, null); + } + + public static List GetBindingExpressions(this DependencyObject parent, UpdateSourceTrigger[]? triggers) + { + // Create a list of framework elements and binding expressions + var bindingExpressions = new List(); + + // Get all explicit bindings into the list + GetBindingExpressions(parent, triggers, ref bindingExpressions); + + return bindingExpressions; + } + + private static void GetBindingExpressions(DependencyObject parent, UpdateSourceTrigger[]? triggers, ref List bindingExpressions) + { + // Get the number of children + var childCount = VisualTreeHelper.GetChildrenCount(parent); + + // Loop over each child + for (var childIndex = 0; childIndex < childCount; childIndex++) + { + // Get the child + var dependencyObject = VisualTreeHelper.GetChild(parent, childIndex); + + // Check if the object is a tab control + if (dependencyObject is TabControl tabControl) + { + // Loop over each tab + foreach (TabItem tabItem in tabControl.Items) + GetBindingExpressions((DependencyObject) tabItem.Content, triggers, ref bindingExpressions); + } + else + { + // Cast to framework element + if (dependencyObject is FrameworkElement frameworkElement) + { + // Get the list of properties + IEnumerable dependencyProperties = (from PropertyDescriptor propertyDescriptor in TypeDescriptor.GetProperties(frameworkElement) + select DependencyPropertyDescriptor.FromProperty(propertyDescriptor) + into dependencyPropertyDescriptor + where dependencyPropertyDescriptor != null + select dependencyPropertyDescriptor.DependencyProperty).ToList(); + + // Loop over each dependency property in the list + foreach (var dependencyProperty in dependencyProperties) + { + // Try to get the binding expression for the property + var bindingExpression = frameworkElement.GetBindingExpression(dependencyProperty); + + // If there is a binding expression and it is set to explicit then make it update the source + if (bindingExpression != null && (triggers == null || triggers.Contains(bindingExpression.ParentBinding.UpdateSourceTrigger))) + bindingExpressions.Add(new BindingExpressionInfo(frameworkElement, bindingExpression)); + } + } + + // If the dependency object has any children then check them + if (VisualTreeHelper.GetChildrenCount(dependencyObject) > 0) + GetBindingExpressions(dependencyObject, triggers, ref bindingExpressions); + } + } + } + + public static void UpdateAllSources(this DependencyObject window, IEnumerable bindingExpressions) + { + foreach (var expression in bindingExpressions) + expression.BindingExpression.UpdateSource(); + } + + public static void ClearAllValidationErrors(this DependencyObject window, IEnumerable bindingExpressions) + { + foreach (var expression in bindingExpressions) + System.Windows.Controls.Validation.ClearInvalid(expression.BindingExpression); + } + + public static bool IsValid(this DependencyObject window) + { + // Get a list of all framework elements and binding expressions + var bindingExpressions = window.GetBindingExpressions(); + + // Loop over each binding expression and clear any existing error + window.ClearAllValidationErrors(bindingExpressions); + + // Force all explicit bindings to update the source + window.UpdateAllSources(bindingExpressions); + + // See if there are any errors + if (!bindingExpressions.Any(b => b.BindingExpression.HasError)) + return true; + + // Get the first framework element with an error + var firstErrorElement = bindingExpressions.First(b => b.BindingExpression.HasError).FrameworkElement; + + // Set focus + firstErrorElement.Focus(); + + return false; + } + } +} diff --git a/Wpf.Validation.csproj b/Wpf.Validation.csproj new file mode 100644 index 0000000..6793f1c --- /dev/null +++ b/Wpf.Validation.csproj @@ -0,0 +1,22 @@ + + + net7.0-windows + enable + true + ChrisKaczor.Wpf.Validation + ChrisKaczor.Wpf.Validation + Chris Kaczor + ChrisKaczor.Wpf.Validation + https://github.com/ckaczor/ChrisKaczor.Wpf.Validation + README.md + WPF validation rules and extension methods to help with validation. + ChrisKaczor.Wpf.Validation + README.md + + + + True + \ + + + \ No newline at end of file diff --git a/Wpf.Validation.sln b/Wpf.Validation.sln new file mode 100644 index 0000000..97f2495 --- /dev/null +++ b/Wpf.Validation.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.33424.131 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Wpf.Validation", "Wpf.Validation.csproj", "{D348BA28-244D-4822-9B18-3FE8E6E0309B}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {D348BA28-244D-4822-9B18-3FE8E6E0309B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D348BA28-244D-4822-9B18-3FE8E6E0309B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D348BA28-244D-4822-9B18-3FE8E6E0309B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D348BA28-244D-4822-9B18-3FE8E6E0309B}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {DB33CB73-D162-4AB5-8559-FE7053E4EF31} + EndGlobalSection +EndGlobal diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 0000000..8f9dca1 --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,45 @@ +name: 1.0.$(Rev:r) + +pr: none + +trigger: + batch: 'true' + branches: + include: + - main + +pool: + vmImage: 'windows-latest' + +variables: + buildConfiguration: 'Release' + +steps: + +- task: DotNetCoreCLI@2 + displayName: 'dotnet build' + inputs: + command: 'build' + arguments: '--configuration $(buildConfiguration)' + projects: 'Wpf.Validation.csproj' + +- task: DotNetCoreCLI@2 + displayName: "dotnet pack" + inputs: + command: 'pack' + arguments: '--configuration $(buildConfiguration)' + packagesToPack: 'Wpf.Validation.csproj' + nobuild: true + versioningScheme: 'byBuildNumber' + +- task: NuGetCommand@2 + displayName: 'nuget push' + inputs: + command: 'push' + feedsToUse: 'select' + packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg' + nuGetFeedType: external + publishFeedCredentials: 'NuGet' + publishVstsFeed: 'Packages' + versioningScheme: 'byBuildNumber' + allowPackageConflicts: true \ No newline at end of file