ShapeCollection.Flatten() Method

Converts a shape collection into a flattened collection that contains all drawing objects in the document, including items of shape groups and canvases.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

IEnumerable<DrawingObject> Flatten()

VB.NET

Function Flatten As IEnumerable(Of DrawingObject)

Returns

Type	Description
IEnumerable<DrawingObject>	A flattened collection of drawing objects in the document.

Remarks

The ShapeCollection stores each shape group or drawing canvas as a single object and does not include their items. You need to use the following properties to obtain their elements:

• Shape.GroupItems - returns the collection of group items;

• Shape.CanvasItems - returns the collection of canvas items.

The Flatten method recursively iterates through the shape collection (its groups and canvases) and collects all drawing objects stored in the document. You can filter the collection by Type to retrieve specific shapes.

The example below shows how to split all shape groups in the document (including nested groups):

C#

using System.Linq;
// ...

Document document = wordProcessor.Document;
List<DrawingObject> groups = document.Shapes.Flatten()
    .Where(x => x.Type == ShapeType.Group)
    .ToList();
for (int i = groups.Count - 1; i >= 0; i--)
{
    groups[i].GroupItems.Ungroup();
}

VB.NET

Imports System.Linq
' ...

Private document As Document = wordProcessor.Document
Private groups As List(Of DrawingObject) = document.Shapes.Flatten() _
        .Where(Function(x) x.Type = ShapeType.Group) _
        .ToList()
For i As Integer = groups.Count - 1 To 0 Step -1
    groups(i).GroupItems.Ungroup()
Next i