WordprocessingShape Class

  • Article

Defines the WordprocessingShape Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is wps:wsp.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Office2010.Word.DrawingShape.WordprocessingShape

Namespace:  DocumentFormat.OpenXml.Office2010.Word.DrawingShape
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(NonVisualConnectorProperties), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(NonVisualDrawingShapeProperties), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(NonVisualDrawingProperties), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ShapeProperties), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ShapeStyle), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(OfficeArtExtensionList), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(TextBoxInfo2), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(LinkedTextBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(TextBodyProperties), FileFormatVersions.Office2010)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class WordprocessingShape _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As WordprocessingShape

[ChildElementInfoAttribute(typeof(NonVisualConnectorProperties), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(NonVisualDrawingShapeProperties), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(NonVisualDrawingProperties), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ShapeProperties), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ShapeStyle), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(OfficeArtExtensionList), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(TextBoxInfo2), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(LinkedTextBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(TextBodyProperties), FileFormatVersions.Office2010)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class WordprocessingShape : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • NonVisualDrawingProperties <wps:cNvPr>

  • NonVisualDrawingShapeProperties <wps:cNvSpPr>

  • NonVisualConnectorProperties <wps:cNvCnPr>

  • ShapeProperties <wps:spPr>

  • ShapeStyle <wps:style>

  • OfficeArtExtensionList <wps:extLst>

  • TextBoxInfo2 <wps:txbx>

  • LinkedTextBox <wps:linkedTxbx>

  • TextBodyProperties <wps:bodyPr>

2.3.12 wsp

Target namespace: https://schemas.microsoft.com/office/word/2008/6/28/wordprocessingShape

Referenced by: CT_WordProcessingGroup, CT_WordProcessingCanvasGroup, CT_WordProcessingCanvas

A CT_WordShape element that specifies a shape in WordprocessingML. See section 2.2.7 for how this element integrates with [ISO/IEC-29500-1].

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="wsp" type="CT_WordShape"/>

See section 5.2 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.5.40 CT_WordShape

Target namespace: https://schemas.microsoft.com/office/word/2008/6/28/wordprocessingShape

Referenced by: wsp, CT_WordProcessingGroup, CT_WordProcessingCanvasGroup, CT_WordProcessingCanvas

This type defines a shape in a WordprocessingML document.

Child Elements:

cNvPr : A CT_NonVisualDrawingProps ([ISO/IEC-29500-1] section A.4.1) element that specifies non-visual properties. This element MUST NOT be present when the CT_WordShape is contained directly by a [ISO/IEC-29500-1] §20.1.2.2.17 graphicData (Graphic Object Data) element. This element MUST be present when the CT_WordShape is not contained directly by a [ISO/IEC-29500-1] §20.1.2.2.17 graphicData (Graphic Object Data) element.<9>

cNvSpPr : A CT_NonVisualDrawingShapeProps ([ISO/IEC-29500-1] section A.4.1) element that specifies non-visual shape properties.

cNvCnPr : A CT_NonVisualConnectorProperties ([ISO/IEC-29500-1] section A.4.1) element that specifies non-visual connector properties.

spPr : A CT_ShapeProperties ([ISO/IEC-29500-1] section A.4.1) element that specifies the visual shape properties that can be applied to a shape.

style : A CT_ShapeStyle ([ISO/IEC-29500-1] section A.4.1) element that specifies the style information for a shape.

extLst : A CT_OfficeArtExtensionList ([ISO/IEC-29500-1] section A.4.1) element to hold future extensions to the parent element of this extLst element.

textbox : A CT_TextboxInfo element that specifies the textual content of the shape. If this element is present, the current CT_WordShape MUST be the first shape to display the contents of the text box story specified by this CT_TextboxInfo.

altTxbx : A CT_AlternateTextboxInformation element that specifies the textual content of the shape. If this element is present, the current CT_WordShape MUST NOT be the first shape to display the contents of the text box story specified by this CT_AlternateTextboxInformation.

bodyPr : A CT_TextBodyProperties ([ISO/IEC-29500-1] section A.4.1) element that specifies the body properties for the text body within a shape.

Attributes:

normalEastAsianFlow : A boolean attribute that specifies whether or not the text flow of the textual contents of the shape ignores the text flow value specified by the bodyPr element’s vert attribute. If this flag is set to true, the value of the vert attribute of the bodyPr element on this CT_WordShape MUST be ignored and text should flow in the same manner prescribed by the value “tbV” for an [ISO/IEC-29500-1] §17.18.93 ST_TextDirection (Text Flow Direction) type.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_WordShape">

<xsd:sequence minOccurs="1" maxOccurs="1">

<xsd:element name="cNvPr" type="a:CT_NonVisualDrawingProps" minOccurs="0" maxOccurs="1"/>

<xsd:choice minOccurs="1" maxOccurs="1">

<xsd:element name="cNvSpPr" type="a:CT_NonVisualDrawingShapeProps" minOccurs="1" maxOccurs="1"/>

<xsd:element name="cNvCnPr" type="a:CT_NonVisualConnectorProperties" minOccurs="1" maxOccurs="1"/>

</xsd:choice>

<xsd:element name="spPr" type="a:CT_ShapeProperties" minOccurs="1" maxOccurs="1"/>

<xsd:element name="style" type="a:CT_ShapeStyle" minOccurs="0" maxOccurs="1"/>

<xsd:element name="extLst" type="a:CT_OfficeArtExtensionList" minOccurs="0" maxOccurs="1"/>

<xsd:choice minOccurs="0" maxOccurs="1">

<xsd:element name="textbox" type="CT_TextboxInfo" minOccurs="1" maxOccurs="1"/>

<xsd:element name="altTxbx" type="CT_AlternateTextboxInformation" minOccurs="1" maxOccurs="1"/>

</xsd:choice>

<xsd:element name="bodyPr" type="a:CT_TextBodyProperties" minOccurs="1" maxOccurs="1"/>

</xsd:sequence>

<xsd:attribute name="normalEastAsianFlow" type="xsd:boolean" use="optional" default="false"/>

</xsd:complexType>

See section 5.2 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

WordprocessingShape Members

DocumentFormat.OpenXml.Office2010.Word.DrawingShape Namespace