Class SvgElement

The base class of which all SVG elements are derived from.

Inheritance

Object

SvgElement

SvgComponentTransferFunction

SvgDistantLight

SvgFilter

SvgFilterPrimitive

SvgMergeNode

SvgPointLight

SvgSpotLight

NonSvgElement

SvgAnchor

SvgClipPath

SvgDefinitionList

SvgDescription

SvgDocumentMetadata

SvgFont

SvgFontFace

SvgFontFaceSrc

SvgFontFaceUri

SvgFragment

SvgGradientStop

SvgKern

SvgMask

SvgPaintServer

SvgScript

SvgTitle

SvgUnknownElement

SvgVisualElement

Implements

ISvgTransformable

ICloneable

ISvgNode

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Svg

Assembly: Svg.dll

Syntax

public abstract class SvgElement : ISvgTransformable, ICloneable, ISvgNode

Constructors

SvgElement()

Initializes a new instance of the SvgElement class.

Declaration

public SvgElement()

Fields

AutoPublishEvents

Declaration

public bool AutoPublishEvents

Field Value

Type	Description
Boolean

Properties

Attributes

Gets a collection of element attributes.

Declaration

protected virtual SvgAttributeCollection Attributes { get; }

Property Value

Type	Description
SvgAttributeCollection

BaselineShift

Specifies dominant-baseline positioning of text.

Declaration

public virtual string BaselineShift { get; set; }

Property Value

Type	Description
System.String

Children

Gets a collection of all child SvgElement objects.

Declaration

public virtual SvgElementCollection Children { get; }

Property Value

Type	Description
SvgElementCollection

Color

Gets or sets the color SvgPaintServer of this element which drives the currentColor property.

Declaration

public virtual SvgPaintServer Color { get; set; }

Property Value

Type	Description
SvgPaintServer

ColorInterpolation

Gets or sets the color space for gradient interpolations, color animations and alpha compositing.

Declaration

public SvgColourInterpolation ColorInterpolation { get; set; }

Property Value

Type	Description
SvgColourInterpolation

ColorInterpolationFilters

Gets or sets the color space for imaging operations performed via filter effects. NOT currently mapped through to bitmap

Declaration

public SvgColourInterpolation ColorInterpolationFilters { get; set; }

Property Value

Type	Description
SvgColourInterpolation

Content

Declaration

public virtual string Content { get; set; }

Property Value

Type	Description
System.String

CustomAttributes

Gets a collection of custom attributes

Declaration

public SvgCustomAttributeCollection CustomAttributes { get; }

Property Value

Type	Description
SvgCustomAttributeCollection

Display

Gets or sets a value to determine whether the element will be rendered. Needed to support SVG attribute display="none"

Declaration

public virtual string Display { get; set; }

Property Value

Type	Description
System.String

ElementName

Gets the name of the element.

Declaration

protected string ElementName { get; }

Property Value

Type	Description
System.String

ElementNamespace

Gets the elements namespace as a string.

Declaration

protected string ElementNamespace { get; set; }

Property Value

Type	Description
System.String

Events

Gets an EventHandlerList of all events belonging to the element.

Declaration

protected virtual EventHandlerList Events { get; }

Property Value

Type	Description
EventHandlerList

Fill

Gets or sets the fill SvgPaintServer of this element.

Declaration

public virtual SvgPaintServer Fill { get; set; }

Property Value

Type	Description
SvgPaintServer

FillOpacity

Gets or sets the opacity of this element's Fill.

Declaration

public virtual float FillOpacity { get; set; }

Property Value

Type	Description
Single

FillRule

Declaration

public virtual SvgFillRule FillRule { get; set; }

Property Value

Type	Description
SvgFillRule

Font

Set all font information.

Declaration

public virtual string Font { get; set; }

Property Value

Type	Description
System.String

FontFamily

Indicates which font family is to be used to render the text.

Declaration

public virtual string FontFamily { get; set; }

Property Value

Type	Description
System.String

FontSize

Refers to the size of the font from baseline to baseline when multiple lines of text are set solid in a multiline layout environment.

Declaration

public virtual SvgUnit FontSize { get; set; }

Property Value

Type	Description
SvgUnit

FontStretch

Indicates the desired amount of condensing or expansion in the glyphs used to render the text.

Declaration

public virtual SvgFontStretch FontStretch { get; set; }

Property Value

Type	Description
SvgFontStretch

FontStyle

Refers to the style of the font.

Declaration

public virtual SvgFontStyle FontStyle { get; set; }

Property Value

Type	Description
SvgFontStyle

FontVariant

Refers to the varient of the font.

Declaration

public virtual SvgFontVariant FontVariant { get; set; }

Property Value

Type	Description
SvgFontVariant

FontWeight

Refers to the boldness of the font.

Declaration

public virtual SvgFontWeight FontWeight { get; set; }

Property Value

Type	Description
SvgFontWeight

HttpClient

Declaration

protected static HttpClient HttpClient { get; }

Property Value

Type	Description
HttpClient

ID

Gets or sets the ID of the element.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
SvgException	The ID is already used within the SvgDocument.

IsPathDirty

Gets or sets a value indicating whether this element's 'Path' is dirty.

Declaration

protected virtual bool IsPathDirty { get; set; }

Property Value

Type	Description
Boolean	true if the path is dirty; otherwise, false.

Namespaces

Gets the namespaces that element has.

Declaration

public Dictionary<string, string> Namespaces { get; }

Property Value

Type	Description
Dictionary<System.String, System.String>	Key is prefix and value is namespace.

Nodes

Declaration

public IList<ISvgNode> Nodes { get; }

Property Value

Type	Description
IList<ISvgNode>

Opacity

Gets or sets the opacity of the element. 1.0 is fully opaque; 0.0 is transparent.

Declaration

public virtual float Opacity { get; set; }

Property Value

Type	Description
Single

OwnerDocument

Gets the owner SvgDocument.

Declaration

public virtual SvgDocument OwnerDocument { get; }

Property Value

Type	Description
SvgDocument

Parent

Gets the parent SvgElement.

Declaration

public virtual SvgElement Parent { get; }

Property Value

Type	Description
SvgElement	An SvgElement if one exists; otherwise null.

Parents

Declaration

public IEnumerable<SvgElement> Parents { get; }

Property Value

Type	Description
IEnumerable<SvgElement>

ParentsAndSelf

Declaration

public IEnumerable<SvgElement> ParentsAndSelf { get; }

Property Value

Type	Description
IEnumerable<SvgElement>

ShapeRendering

Refers to the AnitAlias rendering of shapes.

Declaration

public virtual SvgShapeRendering ShapeRendering { get; set; }

Property Value

Type	Description
SvgShapeRendering

SpaceHandling

Gets or sets the space handling.

Declaration

[SvgAttribute("space", "http://www.w3.org/XML/1998/namespace")]
public virtual XmlSpaceHandling SpaceHandling { get; set; }

Property Value

Type	Description
XmlSpaceHandling	The space handling.

Stroke

Gets or sets the SvgPaintServer to be used when rendering a stroke around this element.

Declaration

public virtual SvgPaintServer Stroke { get; set; }

Property Value

Type	Description
SvgPaintServer

StrokeDashArray

Declaration

[TypeConverter(typeof(SvgStrokeDashArrayConverter))]
public virtual SvgUnitCollection StrokeDashArray { get; set; }

Property Value

Type	Description
SvgUnitCollection

StrokeDashOffset

Declaration

public virtual SvgUnit StrokeDashOffset { get; set; }

Property Value

Type	Description
SvgUnit

StrokeLineCap

Declaration

public virtual SvgStrokeLineCap StrokeLineCap { get; set; }

Property Value

Type	Description
SvgStrokeLineCap

StrokeLineJoin

Declaration

public virtual SvgStrokeLineJoin StrokeLineJoin { get; set; }

Property Value

Type	Description
SvgStrokeLineJoin

StrokeMiterLimit

Declaration

public virtual float StrokeMiterLimit { get; set; }

Property Value

Type	Description
Single

StrokeOpacity

Gets or sets the opacity of the stroke, if the Stroke property has been specified. 1.0 is fully opaque; 0.0 is transparent.

Declaration

public virtual float StrokeOpacity { get; set; }

Property Value

Type	Description
Single

StrokeWidth

Gets or sets the width of the stroke (if the Stroke property has a valid value specified.

Declaration

public virtual SvgUnit StrokeWidth { get; set; }

Property Value

Type	Description
SvgUnit

TextAnchor

Gets or sets the text anchor.

Declaration

public virtual SvgTextAnchor TextAnchor { get; set; }

Property Value

Type	Description
SvgTextAnchor

TextDecoration

Refers to the boldness of the font.

Declaration

public virtual SvgTextDecoration TextDecoration { get; set; }

Property Value

Type	Description
SvgTextDecoration

TextTransformation

Refers to the text transformation.

Declaration

public virtual SvgTextTransformation TextTransformation { get; set; }

Property Value

Type	Description
SvgTextTransformation

Transforms

Gets or sets the element transforms.

Declaration

public SvgTransformCollection Transforms { get; set; }

Property Value

Type	Description
SvgTransformCollection	The transforms.

Visibility

Gets or sets a value to determine whether the element will be rendered.

Declaration

public virtual string Visibility { get; set; }

Property Value

Type	Description
System.String

Writing

Declaration

protected bool Writing { get; set; }

Property Value

Type	Description
Boolean

Methods

AddElement(SvgElement, Int32)

Called by the underlying SvgElement when an element has been added to the Children collection.

Declaration

protected virtual void AddElement(SvgElement child, int index)

Parameters

Type	Name	Description
SvgElement	child	The SvgElement that has been added.
Int32	index	An Int32 representing the index where the element was added to the collection.

AddPaths(SvgElement, GraphicsPath)

Recursive method to add up the paths of all children

Declaration

protected void AddPaths(SvgElement elem, GraphicsPath path)

Parameters

Type	Name	Description
SvgElement	elem
GraphicsPath	path

AddStyle(String, String, Int32)

Add style.

Declaration

public void AddStyle(string name, string value, int specificity)

Parameters

Type	Name	Description
System.String	name	The style name.
System.String	value	The style value.
Int32	specificity	The specificity value.

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public virtual object Clone()

Returns

Type	Description
Object	A new object that is a copy of this instance.

ContainsAttribute(String)

Declaration

public bool ContainsAttribute(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
Boolean

CreateMouseEventAction(Action<Object, MouseArg>)

Declaration

protected Action<float, float, int, int, bool, bool, bool, string> CreateMouseEventAction(Action<object, MouseArg> eventRaiser)

Parameters

Type	Name	Description
Action<Object, MouseArg>	eventRaiser

Returns

Type	Description
System.Action<Single, Single, Int32, Int32, Boolean, Boolean, Boolean, System.String>

DeepCopy()

Declaration

public abstract SvgElement DeepCopy()

Returns

Type	Description
SvgElement

DeepCopy<T>()

Declaration

public virtual SvgElement DeepCopy<T>()
    where T : SvgElement, new()

Returns

Type	Description
SvgElement

Type Parameters

Name	Description
T

Descendants()

Declaration

public IEnumerable<SvgElement> Descendants()

Returns

Type	Description
IEnumerable<SvgElement>

FixOpacityValue(Single)

Declaration

protected static float FixOpacityValue(float value)

Parameters

Type	Name	Description
Single	value

Returns

Type	Description
Single

FlushStyles(Boolean)

Flush styles.

Declaration

public void FlushStyles(bool children = false)

Parameters

Type	Name	Description
Boolean	children	If true, flush styles to the children.

GetAttribute<TAttributeType>(String, Boolean, TAttributeType)

Declaration

protected TAttributeType GetAttribute<TAttributeType>(string attributeName, bool inherited, TAttributeType defaultValue = null)

Parameters

Type	Name	Description
System.String	attributeName
Boolean	inherited
TAttributeType	defaultValue

Returns

Type	Description
TAttributeType

Type Parameters

Name	Description
TAttributeType

GetPaths(SvgElement, ISvgRenderer)

Recursive method to add up the paths of all children

Declaration

protected GraphicsPath GetPaths(SvgElement elem, ISvgRenderer renderer)

Parameters

Type	Name	Description
SvgElement	elem
ISvgRenderer	renderer

Returns

Type	Description
GraphicsPath

HasChildren()

Gets a value to determine whether the element has children.

Declaration

public virtual bool HasChildren()

Returns

Type	Description
Boolean

InitialiseFromXML(XmlReader, SvgDocument)

Declaration

public virtual void InitialiseFromXML(XmlReader reader, SvgDocument document)

Parameters

Type	Name	Description
System.Xml.XmlReader	reader
SvgDocument	document

InvalidateChildPaths()

Force recreation of the paths for the element and it's children.

Declaration

public void InvalidateChildPaths()

OnAttributeChanged(AttributeEventArgs)

Declaration

protected void OnAttributeChanged(AttributeEventArgs args)

Parameters

Type	Name	Description
AttributeEventArgs	args

OnContentChanged(ContentEventArgs)

Declaration

protected void OnContentChanged(ContentEventArgs args)

Parameters

Type	Name	Description
ContentEventArgs	args

OnMouseScroll(Int32, Boolean, Boolean, Boolean, String)

Declaration

protected void OnMouseScroll(int scroll, bool ctrlKey, bool shiftKey, bool altKey, string sessionID)

Parameters

Type	Name	Description
Int32	scroll
Boolean	ctrlKey
Boolean	shiftKey
Boolean	altKey
System.String	sessionID

PopTransforms(ISvgRenderer)

Removes any previously applied transforms from the specified ISvgRenderer.

Declaration

protected virtual void PopTransforms(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer that should have transforms removed.

PushTransforms(ISvgRenderer)

Applies the required transforms to ISvgRenderer.

Declaration

protected virtual bool PushTransforms(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer to be transformed.

Returns

Type	Description
Boolean

RaiseMouseClick(Object, MouseArg)

Declaration

protected void RaiseMouseClick(object sender, MouseArg e)

Parameters

Type	Name	Description
Object	sender
MouseArg	e

RaiseMouseDown(Object, MouseArg)

Declaration

protected void RaiseMouseDown(object sender, MouseArg e)

Parameters

Type	Name	Description
Object	sender
MouseArg	e

RaiseMouseMove(Object, MouseArg)

Declaration

protected void RaiseMouseMove(object sender, MouseArg e)

Parameters

Type	Name	Description
Object	sender
MouseArg	e

RaiseMouseOut(Object, MouseArg)

Declaration

protected void RaiseMouseOut(object sender, MouseArg args)

Parameters

Type	Name	Description
Object	sender
MouseArg	args

RaiseMouseOver(Object, MouseArg)

Declaration

protected void RaiseMouseOver(object sender, MouseArg args)

Parameters

Type	Name	Description
Object	sender
MouseArg	args

RaiseMouseScroll(Object, MouseScrollArg)

Declaration

protected void RaiseMouseScroll(object sender, MouseScrollArg e)

Parameters

Type	Name	Description
Object	sender
MouseScrollArg	e

RaiseMouseUp(Object, MouseArg)

Declaration

protected void RaiseMouseUp(object sender, MouseArg e)

Parameters

Type	Name	Description
Object	sender
MouseArg	e

RegisterEvents(ISvgEventCaller)

Use this method to provide your implementation ISvgEventCaller which can register Actions and call them if one of the events occurs. Make sure, that your SvgElement has a unique ID. The SvgTextElement overwrites this and regsiters the Change event tor its text content.

Declaration

public virtual void RegisterEvents(ISvgEventCaller caller)

Parameters

Type	Name	Description
ISvgEventCaller	caller

RemoveElement(SvgElement)

Called by the underlying SvgElement when an element has been removed from the Children collection.

Declaration

protected virtual void RemoveElement(SvgElement child)

Parameters

Type	Name	Description
SvgElement	child	The SvgElement that has been removed.

Render(ISvgRenderer)

Renders the SvgElement and contents to the specified ISvgRenderer object.

Declaration

protected virtual void Render(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer object to render to.

RenderChildren(ISvgRenderer)

Renders the children of this SvgElement.

Declaration

protected virtual void RenderChildren(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer to render the child SvgElements to.

RenderElement(ISvgRenderer)

Renders this element to the ISvgRenderer.

Declaration

public void RenderElement(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer that the element should use to render itself.

SetAndForceUniqueID(String, Boolean, Action<SvgElement, String, String>)

Declaration

public void SetAndForceUniqueID(string value, bool autoForceUniqueID = true, Action<SvgElement, string, string> logElementOldIDNewID = null)

Parameters

Type	Name	Description
System.String	value
Boolean	autoForceUniqueID
System.Action<SvgElement, System.String, System.String>	logElementOldIDNewID

ShouldWriteElement()

Derrived classes may decide that the element should not be written. For example, the text element shouldn't be written if it's empty.

Declaration

public virtual bool ShouldWriteElement()

Returns

Type	Description
Boolean

TransformedBounds(RectangleF)

Transforms the given rectangle with the set transformation, if any. Can be applied to bounds calculated without considering the element transformation.

Declaration

protected RectangleF TransformedBounds(RectangleF bounds)

Parameters

Type	Name	Description
RectangleF	bounds	The rectangle to be transformed.

Returns

Type	Description
RectangleF	The transformed rectangle, or the original rectangle if no transformation exists.

TryGetAttribute(String, out String)

Declaration

public bool TryGetAttribute(string name, out string value)

Parameters

Type	Name	Description
System.String	name
System.String	value

Returns

Type	Description
Boolean

UnregisterEvents(ISvgEventCaller)

Use this method to provide your implementation ISvgEventCaller to unregister Actions

Declaration

public virtual void UnregisterEvents(ISvgEventCaller caller)

Parameters

Type	Name	Description
ISvgEventCaller	caller

ValidateFontFamily(String, SvgDocument, SvgFontManager)

Declaration

public static object ValidateFontFamily(string fontFamilyList, SvgDocument doc, SvgFontManager fontManager)

Parameters

Type	Name	Description
System.String	fontFamilyList
SvgDocument	doc
SvgFontManager	fontManager

Returns

Type	Description
Object

Write(XmlWriter)

Write this SvgElement out using a given XmlWriter.

Declaration

public virtual void Write(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The XmlWriter to use.

Remarks

Recommendation is to create an XmlWriter by calling a factory method,
e.g. Create(Stream), as per Microsoft documentation.

However, unlike an XmlTextWriter created via 'new XmlTextWriter()',
a factory-constructed XmlWriter will not flush output until it is closed
(normally via a using statement), or unless the client explicitly calls Flush().

WriteAttributes(XmlWriter)

Declaration

protected virtual void WriteAttributes(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer

WriteChildren(XmlWriter)

Declaration

protected virtual void WriteChildren(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer

WriteEndElement(XmlWriter)

Declaration

protected virtual void WriteEndElement(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer

WriteStartElement(XmlWriter)

Declaration

protected virtual void WriteStartElement(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer

Events

AttributeChanged

Fired when an Atrribute of this Element has changed

Declaration

public event EventHandler<AttributeEventArgs> AttributeChanged

Event Type

Type	Description
System.EventHandler<AttributeEventArgs>

ChildAdded

Fired when an Element was added to the children of this Element

Declaration

public event EventHandler<ChildAddedEventArgs> ChildAdded

Event Type

Type	Description
System.EventHandler<ChildAddedEventArgs>

Click

Declaration

public event EventHandler<MouseArg> Click

Event Type

Type	Description
System.EventHandler<MouseArg>

ContentChanged

Fired when an Atrribute of this Element has changed

Declaration

public event EventHandler<ContentEventArgs> ContentChanged

Event Type

Type	Description
System.EventHandler<ContentEventArgs>

Load

Occurs when the element is loaded.

Declaration

public event EventHandler Load

Event Type

Type	Description
EventHandler

MouseDown

Declaration

public event EventHandler<MouseArg> MouseDown

Event Type

Type	Description
System.EventHandler<MouseArg>

MouseMove

Declaration

public event EventHandler<MouseArg> MouseMove

Event Type

Type	Description
System.EventHandler<MouseArg>

MouseOut

Declaration

public event EventHandler<MouseArg> MouseOut

Event Type

Type	Description
System.EventHandler<MouseArg>

MouseOver

Declaration

public event EventHandler<MouseArg> MouseOver

Event Type

Type	Description
System.EventHandler<MouseArg>

MouseScroll

Declaration

public event EventHandler<MouseScrollArg> MouseScroll

Event Type

Type	Description
System.EventHandler<MouseScrollArg>

MouseUp

Declaration

public event EventHandler<MouseArg> MouseUp

Event Type

Type	Description
System.EventHandler<MouseArg>

Explicit Interface Implementations

ISvgNode.DeepCopy()

Declaration

ISvgNode ISvgNode.DeepCopy()

Returns

Type	Description
ISvgNode

ISvgTransformable.PopTransforms(ISvgRenderer)

Removes any previously applied transforms from the specified ISvgRenderer.

Declaration

void ISvgTransformable.PopTransforms(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer that should have transforms removed.

ISvgTransformable.PushTransforms(ISvgRenderer)

Applies the required transforms to ISvgRenderer.

Declaration

void ISvgTransformable.PushTransforms(ISvgRenderer renderer)

Parameters

Type	Name	Description
ISvgRenderer	renderer	The ISvgRenderer to be transformed.

Implements

ISvgTransformable

System.ICloneable

ISvgNode

Extension Methods

SvgExtentions.GetXML(SvgElement)

SvgExtentions.HasNonEmptyCustomAttribute(SvgElement, String)

SvgExtentions.ApplyRecursive(SvgElement, Action<SvgElement>)

SvgExtentions.ApplyRecursiveDepthFirst(SvgElement, Action<SvgElement>)