SubDocument.Shapes Property

Provides access to a collection of Shapes (pictures, text boxes) in the current SubDocument.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

ShapeCollection Shapes { get; }

VB.NET

ReadOnly Property Shapes As ShapeCollection

Property Value

Type	Description
ShapeCollection	A ShapeCollection object that is the collection of shapes.

Example

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

Related GitHub Examples

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

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.

C#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L38

document.Unit = DevExpress.Office.DocumentUnit.Centimeter;
Shape myPicture = document.Shapes[1];
// Clear the qualitative positioning to allow positioning by specifying the numerical offset.

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Shapes.cs#L27

document.Unit = DevExpress.Office.DocumentUnit.Centimeter;
Shape myPicture = document.Shapes[1];
// Clear the qualitative positioning to allow positioning by specifying the numerical offset.

word-document-api-examples/CS/CodeExamples/ShapesActions.cs#L31

document.Unit = DevExpress.Office.DocumentUnit.Centimeter;
Shape myPicture = document.Shapes[1];
// Clear the qualitative positioning to allow positioning by specifying the numerical offset.

How-to-iterate-through-all-SubDocuments/CS/SubDocumentIterator/SubDocumentHelper.cs#L16

subDocumentProcessor(document);
ProcessShapes(document.Shapes, subDocumentProcessor);
ProcessComments(document.Comments, subDocumentProcessor);

text-boxes-simple-example-t481625/CS/TextBoxes/Form1.cs#L55

#region #changecolor
Shape myTextBox = document.Shapes[0];

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/ShapesActions.vb#L31

document.Unit = DevExpress.Office.DocumentUnit.Centimeter
Dim myPicture As Shape = document.Shapes(1)
' Clear the qualitative positioning to allow positioning by specifying the numerical offset.

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Shapes.vb#L22

document.Unit = DevExpress.Office.DocumentUnit.Centimeter
Dim myPicture As Shape = document.Shapes(1)
' Clear the qualitative positioning to allow positioning by specifying the numerical offset.

word-document-api-examples/VB/CodeExamples/ShapesActions.vb#L26

document.Unit = DevExpress.Office.DocumentUnit.Centimeter
Dim myPicture As Shape = document.Shapes(1)
' Clear the qualitative positioning to allow positioning by specifying the numerical offset.

How-to-iterate-through-all-SubDocuments/VB/SubDocumentIterator/SubDocumentHelper.vb#L14

subDocumentProcessor(document)
ProcessShapes(document.Shapes, subDocumentProcessor)
ProcessComments(document.Comments, subDocumentProcessor)

text-boxes-simple-example-t481625/VB/TextBoxes/Form1.vb#L50

'            #Region "#changecolor"
            Dim myTextBox As Shape = document.Shapes(0)