Class InlineCollection
Represents a collection of Inline elements.
Namespace: Syncfusion.Windows.Controls.RichTextBoxAdv
Assembly: Syncfusion.SfRichTextBoxAdv.WPF.dll
Syntax
public class InlineCollection : NodeCollectionConstructors
InlineCollection(Node)
Initializes a new instance of the InlineCollection class for the specified Node.
Declaration
public InlineCollection(Node owner)Parameters
| Type | Name | Description |
|---|---|---|
| Node | owner | The owner of the InlineCollection. The value can be null or an instance of ParagraphAdv. |
InlineCollection(Node, IEnumerable<Inline>)
Initializes a new instance of the InlineCollection class that contains inlines
copied from the specified collection for the specified Node.
Declaration
public InlineCollection(Node owner, IEnumerable<Inline> collection)Parameters
| Type | Name | Description |
|---|---|---|
| Node | owner | The owner of the InlineCollection. The value can be null or an instance of ParagraphAdv. |
| System.Collections.Generic.IEnumerable<Inline> | collection | The collection from which the inlines are copied. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | The collection parameter cannot be null. |
Properties
Item[Int32]
Gets the Inline at the specified index in the InlineCollection.
Declaration
public Inline this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the Inline instance to get. |
Property Value
| Type | Description |
|---|---|
| Inline | The Inline instance at the specified |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Index was out of range. Must be non-negative and less than the size of the collection. |
Methods
Add(Node)
Adds the specified Inline to the end of the InlineCollection.
Declaration
public void Add(Node inline)Parameters
| Type | Name | Description |
|---|---|---|
| Node | inline | The Inline instance to be added to the end of the InlineCollection. |
First()
Returns the first Inline instance from the InlineCollection.
Declaration
public Inline First()Returns
| Type | Description |
|---|---|
| Inline | The first Inline instance in the InlineCollection. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The source sequence is empty. |
First(Func<Node, Boolean>)
Returns the first Inline instance from the InlineCollection that satisfies a specified condition.
Declaration
public Inline First(Func<Node, bool> predicate)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Node, System.Boolean> | predicate | A function to test each element for a condition. |
Returns
| Type | Description |
|---|---|
| Inline | The first Inline instance in the InlineCollection that passes the test in
the specified |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | predicate is null. |
| System.InvalidOperationException | No element satisfies the condition in predicate.-or-The source sequence is empty. |
Insert(Int32, Node)
Inserts the specified Inline into the InlineCollection at the specified index.
Declaration
public void Insert(int index, Node inline)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index at which the Inline should be inserted. |
| Node | inline | The Inline instance to insert. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Index was out of range. Must be non-negative and less than the size of the collection. |
Last()
Returns the last Inline instance from the InlineCollection.
Declaration
public Inline Last()Returns
| Type | Description |
|---|---|
| Inline | The last Inline instance in the InlineCollection. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The source sequence is empty. |
Last(Func<Node, Boolean>)
Returns the last Inline instance from the InlineCollection that satisfies a specified condition.
Declaration
public Inline Last(Func<Node, bool> predicate)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Node, System.Boolean> | predicate | A function to test each element for a condition. |
Returns
| Type | Description |
|---|---|
| Inline | The last Inline instance in the InlineCollection that passes the test in
the specified |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | predicate is null. |
| System.InvalidOperationException | No element satisfies the condition in predicate.-or-The source sequence is empty. |
Remove(Node)
Removes the first occurrence of the specified Inline from the InlineCollection.
Declaration
public bool Remove(Node inline)Parameters
| Type | Name | Description |
|---|---|---|
| Node | inline | The Inline instance to remove from the InlineCollection. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True, if the specified Inline is successfully removed. Otherwise, false. This method also returns false if specified Inline was not found in the original InlineCollection. |
RemoveAt(Int32)
Removes the Inline instance at the specified index of the InlineCollection.
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the Inline to remove. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Index is less than zero.-or-Index is equal to or greater than item count. |