InlineCollection Class (System.Windows.Documents)

Switch View

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

InlineCollection Class

Represents a collection of Inline elements. InlineCollection defines the allowable child content of the Paragraph, Span, and TextBlock elements.

Namespace: System.Windows.Documents
Assembly: PresentationFramework (in PresentationFramework.dll)

Syntax

Visual Basic (Declaration)

<ContentWrapperAttribute(GetType(Run))> _
<ContentWrapperAttribute(GetType(InlineUIContainer))> _
<WhitespaceSignificantCollectionAttribute> _
Public Class InlineCollection _
    Inherits TextElementCollection(Of Inline) _
    Implements IList, ICollection, IEnumerable

Visual Basic (Usage)

Dim instance As InlineCollection

[ContentWrapperAttribute(typeof(Run))]
[ContentWrapperAttribute(typeof(InlineUIContainer))]
[WhitespaceSignificantCollectionAttribute]
public class InlineCollection : TextElementCollection<Inline>, 
    IList, ICollection, IEnumerable

Visual C++

[ContentWrapperAttribute(typeof(Run))]
[ContentWrapperAttribute(typeof(InlineUIContainer))]
[WhitespaceSignificantCollectionAttribute]
public ref class InlineCollection : public TextElementCollection<Inline^>, 
    IList, ICollection, IEnumerable

JScript

public class InlineCollection extends TextElementCollection<Inline> implements IList, ICollection, IEnumerable

XAML

You cannot directly create an instance of this class in XAML.

Remarks

InlineCollection creation is only permitted inside an element that owns an InlineCollection, such as a TextBlock or a Paragraph. As such, an InlineCollection cannot be instantiated directly and has no default or overloaded constructor.

Examples

These examples demonstrate some of the more common operations that can be performed on inline flow content elements (and containers of such elements, such as TextBlock) through the Inlines property. This property is used to add and remove items from InlineCollection. Flow content elements that feature an Inlines property include:

These examples happen to use Span as the flow content element, but these techniques are applicable to all elements or controls that host an InlineCollection collection.

The following example creates a new Span object, and then uses the Add method to add two text runs as content children of the Span.

Span spanx = new Span();
spanx.Inlines.Add(new Run("A bit of text content..."));
spanx.Inlines.Add(new Run("A bit more text content..."));

The following example creates a new Run element and inserts it at the beginning of the Span.

Run runx = new Run("Text to insert...");
spanx.Inlines.InsertBefore(spanx.Inlines.FirstInline, runx);

The following example gets the number of top-level Inline elements contained in the Span.

int countTopLevelInlines = spanx.Inlines.Count;

The following example deletes the last Inline element in the Span.

spanx.Inlines.Remove(spanx.Inlines.LastInline);

The following example clears all of the contents (Inline elements) from the Span.

spanx.Inlines.Clear();

Inheritance Hierarchy

System..::.Object
System.Windows.Documents..::.TextElementCollection<(Of <(Inline>)>)
System.Windows.Documents..::.InlineCollection

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

InlineCollection Members

System.Windows.Documents Namespace

Inline

Other Resources

Flow Document Overview