Partager via


WrapPolygon Class

Tight Wrapping Extents Polygon.When the object is serialized out as xml, its qualified name is wp:wrapPolygon.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.Wordprocessing.WrapPolygon

Namespace:  DocumentFormat.OpenXml.Drawing.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(LineTo))> _
<ChildElementInfoAttribute(GetType(StartPoint))> _
Public Class WrapPolygon _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As WrapPolygon
[ChildElementInfoAttribute(typeof(LineTo))]
[ChildElementInfoAttribute(typeof(StartPoint))]
public class WrapPolygon : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • StartPoint <wp:start>

  • LineTo <wp:lineTo>

[ISO/IEC 29500-1 1st Edition]

20.4.2.16 wrapPolygon (Wrapping Polygon)

This element specifies the wrapping polygon which shall be used to determine the extents to which text can wrap around the specified object in the document. This polygon shall be defined by the following:

  • The start element defines the coordinates of the origin of the wrap polygon

  • Two or more lineTo elements define the point of the wrap polygon

If the set of child elements does not result in a closed polygon (the last lineTo element does not return to the position specified by the start element), then a single additional line shall be inferred as needed to close the wrapping polygon.

[Example: Consider the following basic wrapping polygon for a DrawingML object:

<wp:wrapPolygon>
<wp:start x="0" y="0" />
<wp:lineTo x="0" y="100" />
<wp:lineTo x="100" y="100" />
<wp:lineTo x="100" y="0" />
<wp:lineTo x="0" y="0" />
</wp:wrapPolygon>

The wrapPolygon element defines the object's text wrapping polygon (in this case, the four points of a square). end example]

Parent Elements

wrapThrough (§20.4.2.18); wrapTight (§20.4.2.19)

Child Elements

Subclause

lineTo (Wrapping Polygon Line End Position)

§20.4.2.9

start (Wrapping Polygon Start)

§20.4.2.14

Attributes

Description

edited (Wrapping Points Modified)

Specifies that the wrap points for the wrapping polygon have been edited, and the resulting extents shall be recalculated to compensate when the document is next opened.

[Example: Consider the following basic wrapping polygon for a DrawingML object:

<wp:wrapPolygon edited="true">
<wp:start x="0" y="0" />
<wp:lineTo x="0" y="100" />
<wp:lineTo x="50" y="50" />
<wp:lineTo x="0" y="0" />
</wp:wrapPolygon>

The edited attribute specifies that these wrap points have been changed since the document was last rendered. end example]

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

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

© ISO/IEC29500: 2008.

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

WrapPolygon Members

DocumentFormat.OpenXml.Drawing.Wordprocessing Namespace