Skip to main content
A newer version of this page is available. .
.NET Framework 4.5.2+

Shape Interface

Represents a drawing object.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

[ComVisible(true)]
public interface Shape

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.

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

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;

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.

The following code snippets (auto-collected from DevExpress Examples) contain references to the Shape interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also