Initial commit

This commit is contained in:
2023-04-07 13:35:10 -04:00
commit a3984cfefb
12 changed files with 800 additions and 0 deletions

350
.gitignore vendored Normal file
View File

@@ -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/

10
AssemblyInfo.cs Normal file
View File

@@ -0,0 +1,10 @@
using System.Windows;
[assembly: ThemeInfo(
ResourceDictionaryLocation.None, //where theme specific resource dictionaries are located
//(used if a resource is not found in the page,
// or application resource dictionaries)
ResourceDictionaryLocation.SourceAssembly //where the generic resource dictionary is located
//(used if a resource is not found in the page,
// app, or any theme specific resource dictionaries)
)]

58
HtmlTextBlock.cs Normal file
View File

@@ -0,0 +1,58 @@
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
namespace ChrisKaczor.Wpf.Controls
{
public class HtmlTextBlock : TextBlock
{
public static readonly DependencyProperty HtmlProperty = DependencyProperty.Register(nameof(Html), typeof(string), typeof(HtmlTextBlock), new UIPropertyMetadata("Html", OnHtmlChanged));
private static void OnHtmlChanged(DependencyObject s, DependencyPropertyChangedEventArgs e)
{
var htmlTextBlock = (HtmlTextBlock) s;
Parse(htmlTextBlock, e.NewValue as string);
}
private static void Parse(HtmlTextBlock control, string? value)
{
try
{
control.Inlines.Clear();
var parser = new TextParser();
var lines = parser.Parse(control, value);
foreach (var line in lines)
{
foreach (var fragment in line.FragmentList)
{
var run = new Run(fragment.Text)
{
FontStyle = fragment.Style,
FontWeight = fragment.Weight,
FontSize = fragment.Size,
Foreground = fragment.Color
};
control.Inlines.Add(run);
}
}
}
catch (Exception)
{
control.Inlines.Clear();
control.Text = value;
}
}
public string Html
{
get => (string) GetValue(HtmlProperty);
set => SetValue(HtmlProperty, value);
}
}
}

21
LICENSE Normal file
View File

@@ -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.

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
# ChrisKaczor.Wpf.Controls.HtmlTextBlock
A WPF control that extends the base TextBlock control with rudimentary support for some basic HTML formatting.
## 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.

64
TextFragment.cs Normal file
View File

@@ -0,0 +1,64 @@
using System.Globalization;
using System.Windows;
using System.Windows.Media;
namespace ChrisKaczor.Wpf.Controls
{
public class TextFragment
{
private readonly HtmlTextBlock _parent;
public Brush Color { get; set; }
public FontStyle Style { get; set; }
public FontWeight Weight { get; set; }
public double Size { get; set; }
public string Text { get; set; }
public bool Underline { get; set; }
private Typeface? _typeface;
private Typeface Typeface
{
get { return _typeface ??= new Typeface(_parent.FontFamily, Style, Weight, _parent.FontStretch); }
}
private FormattedText? _formattedText;
public FormattedText FormattedText
{
get
{
if (_formattedText != null)
return _formattedText;
var measureText = string.IsNullOrEmpty(Text) ? " " : Text;
_formattedText = new FormattedText(measureText, CultureInfo.CurrentUICulture, FlowDirection.LeftToRight, Typeface, Size, Color, null, TextFormattingMode.Display, 1);
var textDecorationCollection = new TextDecorationCollection();
if (Underline)
{
var underlineDecoration = new TextDecoration { PenThicknessUnit = TextDecorationUnit.FontRecommended };
textDecorationCollection.Add(underlineDecoration);
}
_formattedText.SetTextDecorations(textDecorationCollection);
return _formattedText;
}
}
public TextFragment(HtmlTextBlock parent)
{
_parent = parent;
Color = _parent.Foreground;
Style = _parent.FontStyle;
Weight = _parent.FontWeight;
Size = _parent.FontSize;
Text = string.Empty;
Underline = false;
}
}
}

32
TextFragmentStyle.cs Normal file
View File

@@ -0,0 +1,32 @@
using System.Windows;
using System.Windows.Media;
namespace ChrisKaczor.Wpf.Controls
{
public class TextFragmentStyle
{
public Brush? Color { get; set; }
public FontStyle? Style { get; init; }
public FontWeight? Weight { get; init; }
public double? Size { get; set; }
public bool? Underline { get; init; }
public void Apply(TextFragment fragment)
{
if (Color != null)
fragment.Color = Color;
if (Style.HasValue)
fragment.Style = Style.Value;
if (Weight.HasValue)
fragment.Weight = Weight.Value;
if (Size.HasValue)
fragment.Size = Size.Value;
if (Underline.HasValue)
fragment.Underline = Underline.Value;
}
}
}

14
TextLine.cs Normal file
View File

@@ -0,0 +1,14 @@
using System.Collections.ObjectModel;
namespace ChrisKaczor.Wpf.Controls
{
public class TextLine
{
public Collection<TextFragment> FragmentList { get; }
public TextLine()
{
FragmentList = new Collection<TextFragment>();
}
}
}

144
TextParser.cs Normal file
View File

@@ -0,0 +1,144 @@
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Globalization;
using System.Windows;
using System.Windows.Media;
using System.Xml;
namespace ChrisKaczor.Wpf.Controls
{
public class TextParser
{
private HtmlTextBlock _parentControl = null!;
public Collection<TextLine> Parse(HtmlTextBlock parentControl, string? text)
{
_parentControl = parentControl;
text = text?.Replace("&", "&amp;");
// Add a root tag so the parser is happy
text = string.Format(CultureInfo.InvariantCulture, "<body>{0}</body>", text);
// Normalize line endings
text = text.Replace("\r\n", "\n");
// Create an XML document and load it with the text
var xmlDocument = new XmlDocument
{
PreserveWhitespace = true
};
xmlDocument.LoadXml(text);
// Create a list of text lines
var lines = new Collection<TextLine>();
// Walk over the nodes and build up the fragment list
WalkNodes(xmlDocument.ChildNodes, lines);
return lines;
}
private readonly Stack<TextFragmentStyle> _attributeStack = new();
private void WalkNodes(XmlNodeList xmlNodeList, Collection<TextLine> textLines)
{
if (textLines.Count == 0)
textLines.Add(new TextLine());
foreach (XmlNode xmlNode in xmlNodeList)
{
TextFragmentStyle style;
switch (xmlNode.Name.ToUpperInvariant())
{
case "#WHITESPACE":
case "#TEXT":
// Split the fragment and the line endings
var lines = xmlNode.Value!.Split('\n');
var firstLine = true;
foreach (var line in lines)
{
var textLine = (firstLine ? textLines[^1] : new TextLine());
// Create a new fragment and fill the style information
var textFragment = new TextFragment(_parentControl)
{
Text = line
};
foreach (var s in _attributeStack)
{
s.Apply(textFragment);
}
// Add the fragment to the list
textLine.FragmentList.Add(textFragment);
if (!firstLine)
textLines.Add(textLine);
firstLine = false;
}
break;
case "EM":
case "B":
style = new TextFragmentStyle { Weight = FontWeights.Bold };
_attributeStack.Push(style);
break;
case "U":
style = new TextFragmentStyle { Underline = true };
_attributeStack.Push(style);
break;
case "CITE":
style = new TextFragmentStyle { Style = FontStyles.Italic };
_attributeStack.Push(style);
break;
case "FONT":
style = new TextFragmentStyle();
if (xmlNode.Attributes == null)
break;
foreach (XmlAttribute attribute in xmlNode.Attributes)
{
switch (attribute.Name.ToUpperInvariant())
{
case "SIZE":
style.Size = Convert.ToDouble(attribute.Value, CultureInfo.InvariantCulture);
break;
case "COLOR":
style.Color = (Brush?) new BrushConverter().ConvertFromString(attribute.Value);
break;
}
}
_attributeStack.Push(style);
break;
}
if (xmlNode.ChildNodes.Count > 0)
WalkNodes(xmlNode.ChildNodes, textLines);
if (_attributeStack.Count > 0)
_attributeStack.Pop();
}
}
}
}

View File

@@ -0,0 +1,22 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net7.0-windows</TargetFramework>
<Nullable>enable</Nullable>
<UseWPF>true</UseWPF>
<RootNamespace>ChrisKaczor.Wpf.Controls</RootNamespace>
<Title>ChrisKaczor.Wpf.Controls.HtmlTextBlock</Title>
<Authors>Chris Kaczor</Authors>
<Product>ChrisKaczor.Wpf.Controls.HtmlTextBlock</Product>
<RepositoryUrl>https://github.com/ckaczor/ChrisKaczor.Wpf.Controls.HtmlTextBlock</RepositoryUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<Description>A WPF control that extends the base TextBlock control with rudimentary support for some basic HTML formatting.</Description>
<PackageId>ChrisKaczor.Wpf.Controls.HtmlTextBlock</PackageId>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>
<ItemGroup>
<None Update="README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>
</Project>

View File

@@ -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.Controls.HtmlTextBlock", "Wpf.Controls.HtmlTextBlock.csproj", "{F0451ABB-7CC2-4B11-84BA-3C4C5BCCA7A8}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{F0451ABB-7CC2-4B11-84BA-3C4C5BCCA7A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{F0451ABB-7CC2-4B11-84BA-3C4C5BCCA7A8}.Debug|Any CPU.Build.0 = Debug|Any CPU
{F0451ABB-7CC2-4B11-84BA-3C4C5BCCA7A8}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F0451ABB-7CC2-4B11-84BA-3C4C5BCCA7A8}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {62FA8048-AB2E-4D82-A0B0-2AB28233C404}
EndGlobalSection
EndGlobal

45
azure-pipelines.yml Normal file
View File

@@ -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.Controls.HtmlTextBlock.csproj'
- task: DotNetCoreCLI@2
displayName: "dotnet pack"
inputs:
command: 'pack'
arguments: '--configuration $(buildConfiguration)'
packagesToPack: 'Wpf.Controls.HtmlTextBlock.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