Inline.SiblingInlines Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets an InlineCollection that contains the Inline elements that are siblings (peers) to this element.

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

Public ReadOnly Property SiblingInlines As InlineCollection

Property Value

Type: System.Windows.Documents.InlineCollection

An InlineCollection object that contains the Inline elements that are siblings to this element.

This property has no default value.

The collection returned by this property always contains the element through which the collection is requested. That is, an inline element is considered to be its own sibling for the purpose of building a collection of siblings for the element.

The following example shows how to use the SiblingInlines property.

' A host paragraph to hold the example Inline elements..
Dim par As New Paragraph()

' Some arbitrary Inline elements.
Dim run1 As New Run("Text run number 1.")
Dim run2 As New Run("Text run number 2.")
Dim bold As New Bold(New Run("Bold text."))
Dim ital As New Italic(New Run("Italic text."))
Dim span1 As New Span(New Run("Span number 1"))
Dim span2 As New Span(New Run("Span number 2"))

' Add the Inline elements to the Paragraph. Note the order
' of the inline elements in the paragraph; the order is 
' arbitrary, but the notion of an order is important with 
' respect to  what are 'previous' and 'next' elements.
par.Inlines.Add(run1)
par.Inlines.Add(run2)
par.Inlines.Add(bold)
par.Inlines.Add(ital)
par.Inlines.Add(span1)
par.Inlines.Add(span2)
' After this line executes, "siblingInlines" holds "run1", "run2",
' "bold", "ital", "span1", and "span2", which are all of the sibling
' Inline elements for "run1" (including "run1");
Dim siblingInlines As InlineCollection = run1.SiblingInlines

' Since "bold" is a sibling to "run1", this call will return the
' same collection of sibling elements as the previous call.
siblingInlines = bold.SiblingInlines

.NET Framework
Available since 3.0
Return to top
Show: