officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-readonlyshapecollection-dot-get-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrange-x29.md
Gets all shapes located in the specified document range.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
ReadOnlyShapeCollection Get(
DocumentRange range
)
Function Get(
range As DocumentRange
) As ReadOnlyShapeCollection
| Name | Type | Description |
|---|---|---|
| range | DocumentRange |
A DocumentRange specifying the range in which to search for shapes.
|
| Type | Description |
|---|---|
| ReadOnlyShapeCollection |
A ReadOnlyShapeCollection object specifying the read-only collection of shapes.
|
The Get method returns a collection of Shape objects (inline and floating pictures, text boxes) contained in the specified range.
The method can be accessed using the RichEditControl.Document.Shapes.Get notation.
Tip
To obtain images, contained in the document range, use the ReadOnlyDocumentImageCollection.Get method.
Note
If you operate with a selection range, the Get method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Get(DocumentRange) method.
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.
ReadOnlyShapeCollection shapes = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1));
ReadOnlyDocumentImageCollection images = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1));
Dim shapes As ReadOnlyShapeCollection = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1))
Dim images As ReadOnlyDocumentImageCollection = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1))
See Also
ReadOnlyShapeCollection Interface