ReadOnlyShapeCollection Interface

A collection of shapes (Shape objects) in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface ReadOnlyShapeCollection :
    ISimpleCollection<Shape>,
    IEnumerable<Shape>,
    IEnumerable,
    ICollection

VB.NET

<ComVisible(True)>
Public Interface ReadOnlyShapeCollection
    Inherits ISimpleCollection(Of Shape),
             IEnumerable(Of Shape),
             IEnumerable,
             ICollection

Related API Members

The following members return ReadOnlyShapeCollection objects:

• ReadOnlyShapeCollection.Get(DocumentRange)

Remarks

Provides a method ReadOnlyShapeCollection.Get that obtains all shapes located in the specified document range. You can access individual items of this collection, but you cannot add or delete items. Use index notation to obtain an individual Shape object from this collection.

To access the ReadOnlyShapeCollection object, use the RichEditControl.Document.Shapes.Get(DocumentRange range) method notation.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ReadOnlyShapeCollection interface.

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#

document-layout-api-practical-usage-t266080/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L14

ReadOnlyShapeCollection shapes = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1));
ReadOnlyDocumentImageCollection images = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1));

VB.NET

document-layout-api-practical-usage-t266080/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L17

Dim shapes As ReadOnlyShapeCollection = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1))
Dim images As ReadOnlyDocumentImageCollection = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1))