The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

ReadOnlyShapeCollection.Get(DocumentRange) Method

Gets all shapes located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

ReadOnlyShapeCollection Get(DocumentRange range)
Function Get(range As DocumentRange) As ReadOnlyShapeCollection
ReadOnlyShapeCollection Get(DocumentRange range)
Function Get(range As DocumentRange) As ReadOnlyShapeCollection

Parameters

Name Type Description
range DocumentRange

A DocumentRange specifying the range in which to search for shapes.

Parameters

Name Type Description
range DocumentRange

A DocumentRange specifying the range in which to search for shapes.

Returns

Type Description
ReadOnlyShapeCollection

A ReadOnlyShapeCollection object specifying the read-only collection of shapes.

Returns

Type Description
ReadOnlyShapeCollection

A ReadOnlyShapeCollection object specifying the read-only collection of shapes.

Remarks

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.

See Also