Stroke Class

Definition

Namespace:

DocumentFormat.OpenXml.Vml

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the Stroke Class.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is v:stroke.

public class Stroke : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Stroke = class
    inherit OpenXmlCompositeElement

Public Class Stroke
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Stroke

Remarks

[ISO/IEC 29500-1 1st Edition]

stroke (Line Stroke Settings)

This element describes how to draw the path if something beyond solid line with a solid color is desired. The attributes of the stroke element can be used to describe a powerful set of stroke properties. Extensions to the VML stroke definition are encoded as sub-elements of stroke.

[Example:

<v:polyline points="0pt,0pt,50pt,0pt,50pt,35pt,15pt,35pt,  
  15pt,15pt,75pt,15pt">  
  <v:stroke startarrow="classic" endarrow="classic"   
    startarrowwidth="wide" endarrowwidth="wide" dashstyle="dashdot"   
    weight="2pt" color="teal" linestyle="thinThin"/>  
</v:polyline>  

3eec98d5-ad62-48d4-9a2d-9b93db2e2f50

end example]

Parent Elements
arc (§14.1.2.1); background (Part 1, §17.2.1); curve (§14.1.2.3); group (§14.1.2.7); image (§14.1.2.10); line (§14.1.2.12); object (Part 1, §17.3.3.19); oval (§14.1.2.13); pict (§9.2.2.2); pict (§9.5.1); polyline (§14.1.2.15); rect (§14.1.2.16); roundrect (§14.1.2.17); shape (§14.1.2.19); shapedefaults (§14.2.2.28); shapetype (§14.1.2.20)

Child Elements	Subclause
bottom (Text Box Bottom Stroke)	§14.2.2.1
column (Text Box Interior Stroke)	§14.2.2.6
left (Text Box Left Stroke)	§14.2.2.16
right (Text Box Right Stroke)	§14.2.2.26
top (Text Box Top Stroke)	§14.2.2.32

[Note: The W3C XML Schema definition of this element’s content model (CT_Stroke) is located in §A.6.1. end note]

� ISO/IEC29500: 2008.

Constructors

Stroke()	Initializes a new instance of the Stroke class.
Stroke(IEnumerable<OpenXmlElement>)	Initializes a new instance of the Stroke class with the specified child elements.
Stroke(OpenXmlElement[])	Initializes a new instance of the Stroke class with the specified child elements.
Stroke(String)	Initializes a new instance of the Stroke class from outer XML.

Properties

AlternateImageReference	Alternate Image Reference Represents the following attribute in the schema: o:althref
BottomStroke	BottomStroke. Represents the following element tag in the schema: o:bottom.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Color	Stroke Color Represents the following attribute in the schema: color
Color2	Stroke Alternate Pattern Color Represents the following attribute in the schema: color2
ColumnStroke	ColumnStroke. Represents the following element tag in the schema: o:column.
DashStyle	Stroke Dash Pattern Represents the following attribute in the schema: dashstyle
EndArrow	Line End Arrowhead Represents the following attribute in the schema: endarrow
EndArrowLength	Line End Arrowhead Length Represents the following attribute in the schema: endarrowlength
EndArrowWidth	Line End Arrowhead Width Represents the following attribute in the schema: endarrowwidth
EndCap	Line End Cap Represents the following attribute in the schema: endcap
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FillType	Stroke Image Style Represents the following attribute in the schema: filltype
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
ForceDash	Force Dashed Outline Represents the following attribute in the schema: o:forcedash
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
Href	Original Image Reference Represents the following attribute in the schema: o:href
Id	Unique Identifier Represents the following attribute in the schema: id
ImageAlignShape	Stoke Image Alignment Represents the following attribute in the schema: imagealignshape
ImageAspect	Stroke Image Aspect Ratio Represents the following attribute in the schema: imageaspect
ImageSize	Stroke Image Size Represents the following attribute in the schema: imagesize
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
Insetpen	Inset Border From Path Represents the following attribute in the schema: insetpen
JoinStyle	Line End Join Style Represents the following attribute in the schema: joinstyle
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LeftStroke	LeftStroke. Represents the following element tag in the schema: o:left.
LineStyle	Stroke Line Style Represents the following attribute in the schema: linestyle
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
Miterlimit	Miter Joint Limit Represents the following attribute in the schema: miterlimit
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
On	Stroke Toggle Represents the following attribute in the schema: on
Opacity	Stroke Opacity Represents the following attribute in the schema: opacity
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RelationshipId	Relationship Represents the following attribute in the schema: r:id
RightStroke	RightStroke. Represents the following element tag in the schema: o:right.
Source	Stroke Image Location Represents the following attribute in the schema: src
StartArrow	Line Start Arrowhead Represents the following attribute in the schema: startarrow
StartArrowLength	Line Start Arrowhead Length Represents the following attribute in the schema: startarrowlength
StartArrowWidth	Line Start Arrowhead Width Represents the following attribute in the schema: startarrowwidth
Title	Stroke Title Represents the following attribute in the schema: o:title
TopStroke	TopStroke. Represents the following element tag in the schema: o:top.
Weight	Stroke Weight Represents the following attribute in the schema: weight
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)