.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

Shape Interface

Represents a drawing object.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

[ComVisible(true)]
public interface Shape
<ComVisible(True)>
Public Interface Shape
[ComVisible(true)]
public interface Shape
<ComVisible(True)>
Public Interface Shape
[ComVisible(true)]
public interface Shape
<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.

The code sample below inserts a picture to the specific document position and changes the picture's horizontal alignment.

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.

See Also