ControlExtensions.Flatten Method

ControlExtensionsFlatten Method

This is used to flatten a flow document element hierarchy for searching

Namespace: SandcastleBuilder.WPF
Assembly: SandcastleBuilder.WPF (in SandcastleBuilder.WPF.dll) Version: 2014.11.22.0

Syntax

public static IEnumerable<TextElement> Flatten(
	this TextElement element
)

<ExtensionAttribute>
Public Shared Function Flatten ( 
	element As TextElement
) As IEnumerable(Of TextElement)

public:
[ExtensionAttribute]
static IEnumerable<TextElement^>^ Flatten(
	TextElement^ element
)

[<ExtensionAttribute>]
static member Flatten : 
        element : TextElement -> IEnumerable<TextElement>

element: Type: System.Windows.DocumentsTextElement
The starting element to flatten

Type: IEnumerableTextElement
A flattened enumerable list containing the element and all child elements and their children recursively.

In Visual Basic and C#, you can call this method as an instance method on any object of type TextElement. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).