Project Description
The Scalable Vector Graphics (SVG) is an XML-based standard file format for creating graphics on the web, and is supported by most modern browsers. This project provides a C# library for parsing, converting and viewing the SVG files in WPF applications.
The Scalable Vector Graphics (SVG) is now natively supported in most internet browsers, including the IE 9. With the HTML5, the use of the SVG as graphics format on the web is increasing.
For .NET application developers, there is currently no library complete enough to handle SVG files. Even the commercial tools are either not available or not complete enough to handle most uses of the SVG in Windows Presentation Foundation (WPF) applications. The project does not aim to provide a complete implementation of the SVG file format, but will support the features required in an average graphics application.
The SVG specification is available in HTML format or the PDF format.
Features and Uses
In general, the following features are implemented:
- Parsing of the SVG files to create the SVG DOM
- SVG to XAML conversion
- A small runtime library to handle font URI, embedded images and others when using the XAML files directly from disk.
- An optimized XAML output.
- A simple and basic SVG viewer (an advanced viewer is planned).
- Interaction with the conversion process (by a visitor pattern) to allow for custom hyper-link implementations, font substitutions etc.
NOTE: Only Geometry/Drawing level elements are exported, which will not work with Silverlight. See the Documentation section for more information on the features.
Installation
The SharpVectors library targets the following frameworks
- .NET Framework, Version 4.0
- .NET Framework, Version 4.5
- .NET Framework, Version 4.6
- .NET Framework, Version 4.7
- .NET Framework, Version 4.8
- .NET Standard, Version 2.1
- .NET Core, Version 3.1
- .NET 5.0
- .NET 6.0
The library can be used in WPF and Windows Forms applications.
For the Library
The library can be downloaded from the following sources
- NuGet (WPF Only Package), Version 1.8.1 - SharpVectors.Wpf.
- NuGet (Full Package - WPF/GDI++), Version 1.8.1 - SharpVectors.
- NuGet (Full Package - WPF/GDI++), Version 1.8.1 - SharpVectors.Reloaded.
- GitHub Releases Page, Version 1.8.1.
- The SharpVectors.Reloaded package is the same as the SharpVectors, which is the recommended package if you need the full package.
- The SharpVectors.Reloaded name was used for the Nuget package at the time the SharpVectors package name was not available.
- The SharpVectors.Reloaded package name will be retired in Version 2.0.
- The SharpVectors.Wpf is the recommended package, for
WPFonly application.- As outlined in the roadmap, other packages such as the SharpVectors.Gdi for the
GDI+, will be available as the renderers mature.
Documentation
An introduction and a tutorial with sample are available. See the Documentation section for more information.
Sample Applications
The library includes a number of sample application for both WPF and GDI+. Here are some of them:
WPF Test Application
This is an application for browsing directory (recursively) of SVG files.
WPF W3C Test Suite
This is an application for viewing the W3C Test Suite compliant results. It has two panes: top and bottom. The top pane is the generated WPF output, the bottom pane is the W3C expected output image. By the test results, this is the most complete SVG reader for WPF!
GDI+ W3C Test Suite
This is an application for viewing the W3C Test Suite compliant results. It has two panes: top and bottom. The top pane is the generated GDI+ output, the bottom pane is the W3C expected output image.
Tutorial Samples
A number of tutorial samples are available in the TutorialSamples folder.
Credits
SharpVectors uses source codes from articles and other open source projects. We wish to acknowledge and thank the authors of these great articles and projects
- SharpVectorGraphics (aka SVG#) by SVG# Team of Developers (SourceForge)
- WPF Zooming and Panning Control by Ashley Davis (CodeProject)
- Render Text On A Path With WPF by Charles Petzold (MSDN Magazine - December 2008)
- MinIoC by Microsoft (Single-file minimal C# IoC container)
- .NET ZLib Implementation by Alberto M (CodeProject)
- Brotli compression format by Google (C# Decoder)
Related Projects
The following are related SVG viewer projects for the .NET platforms
Related Repositories
The following are related SharpVectors repositories
- SvgTestSuites : The W3C Test Suite files used by the SharpVectors for testing.
- SvgXaml : SharpVectors based SVG to XAML converter application.
- SvgViewer : SharpVectors based SVG viewer application.