Shape Class

Definition

Namespace:

DocumentFormat.OpenXml.Vml

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Shape Definition.

This class is available in Office 2007 and above.

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

public class Shape : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Shape = class
    inherit OpenXmlCompositeElement

Public Class Shape
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Shape

Remarks

[ISO/IEC 29500-1 1st Edition]

shape (Shape Definition)

This element is used to describe a shape, the core object in VML. This element can appear by itself or within a group element (§14.1.2.7). If a shapetype element (§14.1.2.20) is referenced using the type attribute, any attributes specified in the shape override those found in the shapetype.

[Example:

<v:shape style="position:absolute;top:50;left:20;width:50;height:50"   
  path="m  0,1000 1000,1000 1000,0 x e">  
  <v:shadow on="true" type="perspective"   
    matrix="1.25,-2,,1.5,,.000001" offset="38pt,-6pt"/>  
</v:shape>  
<v:shape style="position:absolute;top:50;left:20;width:50;height:50"   
  fillcolor="yellow" path="m  0,1000 1000,1000 1000,0 x e">  
  <v:extrusion on="true" lightposition="0,-2000,10000"/>  
</v:shape>  

94f201a9-9638-4b7b-bf6d-8c383cff3d8f

end example]

Parent Elements
background (Part 1, §17.2.1); group (§14.1.2.7); object (Part 1, §17.3.3.19); pict (§9.2.2.2); pict (§9.5.1)

Child Elements	Subclause
anchorlock (Anchor Location Is Locked)	§14.3.2.1
borderbottom (Bottom Border)	§14.3.2.2
borderleft (Left Border)	§14.3.2.3
borderright (Right Border)	§14.3.2.4
bordertop (Top Border)	§14.3.2.5
callout (Callout)	§14.2.2.2
ClientData (Attached Object Data)	§14.4.2.12
clippath (Shape Clipping Path)	§14.2.2.3
equationxml (Storage for Alternate Math Content)	§14.2.2.10
extrusion (3D Extrusion)	§14.2.2.11
fill (Shape Fill Properties)	§14.1.2.5
formulas (Set of Formulas)	§14.1.2.6
handles (Set of Handles)	§14.1.2.9
imagedata (Image Data)	§14.1.2.11
ink (Ink)	§14.2.2.15
iscomment (Ink Annotation Flag)	§14.5.2.1
lock (Shape Protections)	§14.2.2.18
path (Shape Path)	§14.1.2.14
shadow (Shadow Effect)	§14.1.2.18
signatureline (Digital Signature Line)	§14.2.2.30
skew (Skew Transform)	§14.2.2.31
stroke (Line Stroke Settings)	§14.1.2.21
textbox (Text Box)	§14.1.2.22
textdata (VML Diagram Text)	§14.5.2.2
textpath (Text Layout Path)	§14.1.2.23
wrap (Text Wrapping)	§14.3.2.6

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

Adjustment	Adjustment Parameters Represents the following attribute in the schema: adj
AllowInCell	Allow in Table Cell Represents the following attribute in the schema: o:allowincell
AllowOverlap	Allow Shape Overlap Represents the following attribute in the schema: o:allowoverlap
Alternate	Alternate Text Represents the following attribute in the schema: alt
BlackWhiteMode	Black-and-White Mode Represents the following attribute in the schema: o:bwmode
BorderBottomColor	Bottom Border Color Represents the following attribute in the schema: o:borderbottomcolor
BorderLeftColor	Border Left Color Represents the following attribute in the schema: o:borderleftcolor
BorderRightColor	Border Right Color Represents the following attribute in the schema: o:borderrightcolor
BorderTopColor	Border Top Color Represents the following attribute in the schema: o:bordertopcolor
Bullet	Graphical Bullet Represents the following attribute in the schema: o:bullet
Button	Button Behavior Toggle Represents the following attribute in the schema: o:button
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Class	CSS Reference Represents the following attribute in the schema: class
Clip	Clipping Toggle Represents the following attribute in the schema: o:clip
ClipToWrap	Clip to Wrapping Polygon Represents the following attribute in the schema: o:cliptowrap
ConnectorType	Shape Connector Type Represents the following attribute in the schema: o:connectortype
CoordinateOrigin	Coordinate Space Origin Represents the following attribute in the schema: coordorigin
CoordinateSize	Coordinate Space Size Represents the following attribute in the schema: coordsize
DiagramLayout	Diagram Node Layout Identifier Represents the following attribute in the schema: o:dgmlayout
DiagramLayoutMostRecentUsed	Diagram Node Recent Layout Identifier Represents the following attribute in the schema: o:dgmlayoutmru
DiagramNodeKind	Diagram Node Identifier Represents the following attribute in the schema: o:dgmnodekind
DoubleClickNotify	Double-click Notification Toggle Represents the following attribute in the schema: o:doubleclicknotify
EdgePath	Edge Path Represents the following attribute in the schema: path
EncodedPackage	Encoded Package Represents the following attribute in the schema: o:gfxdata
EquationXml	Storage for Alternate Math Content Represents the following attribute in the schema: equationxml
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)
FillColor	Fill Color Represents the following attribute in the schema: fillcolor
Filled	Shape Fill Toggle Represents the following attribute in the schema: filled
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)
Horizontal	Horizontal Rule Toggle Represents the following attribute in the schema: o:hr
HorizontalAlignment	Horizontal Rule Alignment Represents the following attribute in the schema: o:hralign
HorizontalNoShade	Horizontal Rule 3D Shading Toggle Represents the following attribute in the schema: o:hrnoshade
HorizontalPercentage	Horizontal Rule Length Percentage Represents the following attribute in the schema: o:hrpct
HorizontalStandard	Horizontal Rule Standard Display Toggle Represents the following attribute in the schema: o:hrstd
Href	Hyperlink Target Represents the following attribute in the schema: href
Id	Unique Identifier Represents the following attribute in the schema: id
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)
InsetMode	Text Inset Mode Represents the following attribute in the schema: o:insetmode
InsetPen	Inset Border From Path Represents the following attribute in the schema: insetpen
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)
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)
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)
NormalBlackWhiteMode	Normal Black-and-White Mode Represents the following attribute in the schema: o:bwnormal
Ole	Embedded Object Toggle Represents the following attribute in the schema: o:ole
OleIcon	Embedded Object Icon Toggle Represents the following attribute in the schema: o:oleicon
Oned	Shape Handle Toggle Represents the following attribute in the schema: o:oned
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OptionalNumber	Optional Number Represents the following attribute in the schema: o:spt
OptionalString	Optional String Represents the following attribute in the schema: o:spid
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)
PreferRelative	Relative Resize Toggle Represents the following attribute in the schema: o:preferrelative
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Print	Print Toggle Represents the following attribute in the schema: print
PureBlackWhiteMode	Pure Black-and-White Mode Represents the following attribute in the schema: o:bwpure
RegroupId	Regroup ID Represents the following attribute in the schema: o:regroupid
StrokeColor	Shape Stroke Color Represents the following attribute in the schema: strokecolor
Stroked	Shape Stroke Toggle Represents the following attribute in the schema: stroked
StrokeWeight	Shape Stroke Weight Represents the following attribute in the schema: strokeweight
Style	Shape Styling Properties Represents the following attribute in the schema: style
Target	Hyperlink Display Target Represents the following attribute in the schema: target
Title	Shape Title Represents the following attribute in the schema: title
Type	Shape Type Reference Represents the following attribute in the schema: type
UserDrawn	Exists In Master Slide Represents the following attribute in the schema: o:userdrawn
UserHidden	Hide Script Anchors Represents the following attribute in the schema: o:userhidden
WrapCoordinates	Shape Bounding Polygon Represents the following attribute in the schema: wrapcoords
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)