ShapeCollection Interface

A collection of Shape objects.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[ComVisible(true)]
public interface ShapeCollection :
    ReadOnlyShapeCollection,
    ISimpleCollection<Shape>,
    IEnumerable<Shape>,
    IEnumerable,
    ICollection

VB.NET

<ComVisible(True)>
Public Interface ShapeCollection
    Inherits ReadOnlyShapeCollection,
             ISimpleCollection(Of Shape),
             IEnumerable(Of Shape),
             IEnumerable,
             ICollection

Related API Members

The following members return ShapeCollection objects:

• SubDocument.Shapes

Remarks

The SubDocument.Shapes property provides access to the ShapeCollection. The collection contains the following objects:

• Shapes (including inline)
• Text Boxes
• Pictures (including pictures created by the DocumentImageCollection.Append and DocumentImageCollection.Insert methods call)

Use the ShapeCollection.Item property to get access to a particular shape. The ReadOnlyShapeCollection.Get method retrieves shapes from a specific range.

Call the ShapeCollection.InsertPicture or ShapeCollection.InsertTextBox methods to create a new shape in code.

C#

Document document = server.Document;
document.AppendText("Line One\nLine Two\nLine Three");
Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15),
    System.Drawing.Image.FromFile("Documents\\beverages.png"));
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;

VB.NET

Dim document As Document = server.Document
document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("Documents\beverages.png"))
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center