Skip to content

GettingStarted.md

Latest commit

 

History

History
59 lines (41 loc) · 2.35 KB

GettingStarted.md

File metadata and controls

59 lines (41 loc) · 2.35 KB
Raw
title Get started
description Install SVGImage, add a WPF control and work with native Drawing objects.

Get started

SVGImage is a Windows WPF control and renderer. The source targets .NET Framework 4.0–4.8, .NET Core 3.1 and .NET 6–8 for Windows.

Install a published package

dotnet add package DotNetProjects.SVGImage

See NuGet for versions. The support reference describes the current source; unreleased changes may not yet be packaged.

Put an SVG in your window

Add the SVG to your application, set its build action to Content and copy it to the output directory. Add the namespace and control:

<Window x:Class="MyApp.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:svg="https://github.com/dotnetprojects/SVGImage">
    <svg:SVGImage UriSource="Assets/illustration.svg"
                  Width="320" Height="240"
                  UseAnimations="True"
                  SizeType="ViewBoxToSizeNoStretch" />
</Window>

UseAnimations defaults to true. Set it to false for static rendering. Color overrides include OverrideColor, OverrideFillColor and OverrideStrokeColor. Set IsGrayscale="True" for grayscale display.

Work with a Drawing

For direct drawing access, opt in to animation before loading:

var renderer = new SVGImage.SVG.SVGRender { UseAnimations = true };
System.Windows.Media.DrawingGroup drawing = renderer.LoadDrawing("Assets/illustration.svg");

// Stop the existing drawing at an exact time for a snapshot.
renderer.SeekAnimations(TimeSpan.FromSeconds(1.5));

Reload/recreate the drawing to restart playback after seeking. See animation controls and the API reference.

Build the current source

Use Source/SVGImage.sln with Visual Studio 2022, or build on Windows:

dotnet build Source/SVGImage/DotNetProjects.SVGImage.csproj -p:GeneratePackageOnBuild=false

To use unreleased changes, reference the library project or a matching locally built DLL instead of an older package.

Explore the samples, support reference and changelog.