Skip to main content
A newer version of this page is available.
All docs
V18.2

SubDocument.GetShapes(DocumentRange) Method

OBSOLETE

This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Native.ReadOnlyDocumentShapeCollection.Get(DocumentRange range)' method instead.

Gets a collection of Shape objects contained in the specified document range. Use a method accessible with the RichEditControl.Document.Shapes.Get(DocumentRange range) notation instead.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

[Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Native.ReadOnlyDocumentShapeCollection.Get(DocumentRange range)' method instead.")]
ShapeCollection GetShapes(
    DocumentRange range
)

Parameters

Name Type Description
range DocumentRange

A DocumentRange object that is the range of the document.

Returns

Type Description
ShapeCollection

A ShapeCollection containing shapes of the specified range.

Remarks

Important

This method is obsolete. Use the ReadOnlyShapeCollection.Get method instead.

If you operate with a selection range, the GetShapes 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