Shape Interface

Represents a drawing object.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface Shape

VB.NET

<ComVisible(True)>
Public Interface Shape

Related API Members

The following members return Shape objects:

• LayoutFloatingObject.GetDocumentShape()
• ShapeCollection.InsertPicture(DocumentPosition, DocumentImageSource)
• ShapeCollection.InsertPicture(DocumentPosition, Image)
• ShapeCollection.InsertTextBox(DocumentPosition)
• ShapeCollection.Item[String]

Remarks

The Shape class represents the following objects:

• Shapes (including inline)
• Text Boxes
• Pictures

The ShapeCollection contains Shape objects. Access the collection using the SubDocument.Shapes property.

Note

The DocumentImageCollection.Append and DocumentImageCollection.Insert methods add new items to the ShapeCollection.

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

Use the TextBox or Shape.Picture property to distinguish a picture from a text box.

The Shape.Range property specifies the shape’s anchoring range. You can position the shape anywhere on the page that contains the anchor.

Set the Shape.TextWrapping property to TextWrappingType.InLineWithText to convert a floating object to inline.

Call the Shape.AddHyperlink() method to provide a shape with a hyperlink.