TextElementCollection Class

Namespace:
GemBox.Presentation
Assembly:
GemBox.Presentation.dll

Represents a collection of TextElements.

public sealed class TextElementCollection : Collection<TextElement>, IList, ICollection, IList<TextElement>, ICollection<TextElement>, IEnumerable<TextElement>, IEnumerable
Public NotInheritable Class TextElementCollection
    Inherits Collection(Of TextElement)
    Implements IList, ICollection, IList(Of TextElement), ICollection(Of TextElement), IEnumerable(Of TextElement), IEnumerable
Inheritance:
System.Object
TextElementCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<TextElement>
System.Collections.Generic.ICollection<TextElement>
System.Collections.Generic.IEnumerable<TextElement>
System.Collections.IEnumerable

Properties

Count

Gets the number of TextElements contained in the collection.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

The number of TextElements contained in the collection.

Item[Int32]

Gets or sets the TextElement at the specified index.

public TextElement this[int index] { get; set; }
Public Property Item(index As Integer) As TextElement
Parameters
index
System.Int32

The zero-based index of the TextElement to get or set.

Property Value
TextElement

The TextElement at the specified index.

Exceptions
System.ArgumentOutOfRangeException

index is less than zero or index is equal to or greater than Count.

System.ArgumentNullException

value is null.

System.ArgumentException

value is already contained in another TextElementCollection or it belongs to another SlideObject.

TextContent

Gets the text content of the current TextElementCollection.

public TextRange TextContent { get; }
Public ReadOnly Property TextContent As TextRange
Property Value
TextRange

The text content of the current TextElementCollection.

Remarks

For more information, see Find and Replace example.

Methods

Add(TextElement)

Adds a TextElement to the end of the collection.

public void Add(TextElement item)
Public Sub Add(item As TextElement)
Parameters
item
TextElement

The TextElement to be added to the end of the collection.

Exceptions
System.ArgumentNullException

item is null.

System.ArgumentException

item is already contained in another TextElementCollection or it belongs to another SlideObject.

AddClone<TTextElement>(TTextElement)

Adds a clone of the source TTextElement to the end of the collection. Clone will be formatted using the destination theme.

public TTextElement AddClone<TTextElement>(TTextElement source)
    where TTextElement : TextElement
Public Function AddClone(Of TTextElement As TextElement)(source As TTextElement) As TTextElement
Parameters
source
TTextElement

The source TTextElement that will be cloned.

Returns
TTextElement

A clone of the source TTextElement added to the collection.

Type Parameters
TTextElement

The type of the drawing.

Remarks

Cloning is a process when one or more objects from a presentation are duplicated. Objects can be duplicated to the same or another presentation and to the same or another location (for example, to another slide).

Cloning methods are available on collection types, such as SlideCollection, DrawingCollection, TextParagraphCollection or TextElementCollection. Exception is the PresentationDocument type that has a Clone() method used to make a deep clone of the entire presentation. Cloning methods available on the collection types have two forms: AddClone(Slide) and InsertClone(Int32, Slide) to append the duplicate to the collection or insert it into a specific location in the collection.

Objects contained in the presentation can contain references to other objects. For example, Slide contains a reference to its ParentTemplate, Connector can contain a reference to drawings that it connects (BeginConnection and EndConnection), Action can contain a Target to Slide or CustomSlideShow that should be shown when the action is triggered.

When cloning multiple objects, the desired behavior is to maintain these references in the duplicated objects so that, for example, when Connector is cloned, and later when drawings that it connects are cloned, the duplicated Connector also connects duplicates of the original drawings that are connected.

This reference mapping between an original object and its duplicate is maintained by the instance of the CloneContext type. CloneContext instance is created with Create(PresentationDocument, PresentationDocument) static method. Each object can be cloned exactly once using the same CloneContext instance. If you want to clone the same object multiple times, each time a new CloneContext instance must be used. CloneContext is the most useful when cloning multiple objects one after another or when you want to change a behavior of the cloning operation.

Behavior of the cloning operation can be changed by using Set<T>(T, T) method. With this method you can make an explicit mapping between objects and cloning process will respect that mapping. For example, if you are cloning a Slide instance to another PresentationDocument default behavior would be that its parent template LayoutSlide and MasterSlide would also be cloned to another PresentationDocument. This behavior can be changed by making an explicit mapping from the LayoutSlide that is the ParentTemplate of the Slide that will be cloned to some LayoutSlide in the another PresentationDocument that we wish to be a ParentTemplate of the duplicated Slide. Explicit mapping with Set<T>(T, T) method can currently be made between following type (and their derivatives) instances: SlideObject, Drawing, TableStyle and CustomSlideShow.

Exceptions
System.ArgumentNullException

source parameter is null.

AddClone<TTextElement>(TTextElement, CloneContext)

Adds a clone of the source TTextElement to the end of the collection.

public TTextElement AddClone<TTextElement>(TTextElement source, CloneContext context)
    where TTextElement : TextElement
Public Function AddClone(Of TTextElement As TextElement)(source As TTextElement, context As CloneContext) As TTextElement
Parameters
source
TTextElement

The source TTextElement that will be cloned.

context
CloneContext

The context used to maintain reference mapping in multiple cloning operations.

Returns
TTextElement

A clone of the source TTextElement added to the collection.

Type Parameters
TTextElement

The type of the drawing.

Remarks

Cloning is a process when one or more objects from a presentation are duplicated. Objects can be duplicated to the same or another presentation and to the same or another location (for example, to another slide).

Cloning methods are available on collection types, such as SlideCollection, DrawingCollection, TextParagraphCollection or TextElementCollection. Exception is the PresentationDocument type that has a Clone() method used to make a deep clone of the entire presentation. Cloning methods available on the collection types have two forms: AddClone(Slide) and InsertClone(Int32, Slide) to append the duplicate to the collection or insert it into a specific location in the collection.

Objects contained in the presentation can contain references to other objects. For example, Slide contains a reference to its ParentTemplate, Connector can contain a reference to drawings that it connects (BeginConnection and EndConnection), Action can contain a Target to Slide or CustomSlideShow that should be shown when the action is triggered.

When cloning multiple objects, the desired behavior is to maintain these references in the duplicated objects so that, for example, when Connector is cloned, and later when drawings that it connects are cloned, the duplicated Connector also connects duplicates of the original drawings that are connected.

This reference mapping between an original object and its duplicate is maintained by the instance of the CloneContext type. CloneContext instance is created with Create(PresentationDocument, PresentationDocument) static method. Each object can be cloned exactly once using the same CloneContext instance. If you want to clone the same object multiple times, each time a new CloneContext instance must be used. CloneContext is the most useful when cloning multiple objects one after another or when you want to change a behavior of the cloning operation.

Behavior of the cloning operation can be changed by using Set<T>(T, T) method. With this method you can make an explicit mapping between objects and cloning process will respect that mapping. For example, if you are cloning a Slide instance to another PresentationDocument default behavior would be that its parent template LayoutSlide and MasterSlide would also be cloned to another PresentationDocument. This behavior can be changed by making an explicit mapping from the LayoutSlide that is the ParentTemplate of the Slide that will be cloned to some LayoutSlide in the another PresentationDocument that we wish to be a ParentTemplate of the duplicated Slide. Explicit mapping with Set<T>(T, T) method can currently be made between following type (and their derivatives) instances: SlideObject, Drawing, TableStyle and CustomSlideShow.

Exceptions
System.ArgumentNullException

source or context parameter is null.

System.ArgumentException

source is not associated with the SourcePresentation or the current collection is not associated with the DestinationPresentation of the context.

Clear()

Removes all TextElements from the collection.

public void Clear()
Public Sub Clear

Contains(TextElement)

Determines whether a TextElement is in the collection.

public bool Contains(TextElement item)
Public Function Contains(item As TextElement) As Boolean
Parameters
item
TextElement

The TextElement to locate in the collection.

Returns
System.Boolean

true if item is found in the collection; otherwise, false.

Exceptions
System.ArgumentNullException

item is null.

GetEnumerator()

Returns an enumerator that iterates through the TextElementCollection.

public IEnumerator<TextElement> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of TextElement)
Returns
System.Collections.Generic.IEnumerator<TextElement>

An System.Collections.Generic.IEnumerator<T> for the collection.

IndexOf(TextElement)

Searches for the specified TextElement and returns the zero-based index of the first occurrence within the entire collection.

public int IndexOf(TextElement item)
Public Function IndexOf(item As TextElement) As Integer
Parameters
item
TextElement

The TextElement to locate in the collection.

Returns
System.Int32

The zero-based index of the first occurrence of item within the entire collection, if found; otherwise, -1.

Insert(Int32, TextElement)

Inserts a TextElement to the collection at the specified index.

public void Insert(int index, TextElement item)
Public Sub Insert(index As Integer, item As TextElement)
Parameters
index
System.Int32

The zero-based index at which TextElement should be inserted.

item
TextElement

The TextElement to insert into the collection.

Exceptions
System.ArgumentOutOfRangeException

index is less than zero or index is equal to or greater than Count.

System.ArgumentNullException

item is null.

System.ArgumentException

item is already contained in another TextElementCollection or it belongs to another SlideObject.

InsertClone<TTextElement>(Int32, TTextElement)

Inserts a clone of the source TTextElement to the collection at the specified index. Clone will be formatted using the destination theme.

public TTextElement InsertClone<TTextElement>(int index, TTextElement source)
    where TTextElement : TextElement
Public Function InsertClone(Of TTextElement As TextElement)(index As Integer, source As TTextElement) As TTextElement
Parameters
index
System.Int32

The zero-based index at which clone of the source TTextElement should be inserted.

source
TTextElement

The source TTextElement that will be cloned.

Returns
TTextElement

A clone of the source TTextElement inserted to the collection.

Type Parameters
TTextElement

The type of the drawing.

Remarks

Cloning is a process when one or more objects from a presentation are duplicated. Objects can be duplicated to the same or another presentation and to the same or another location (for example, to another slide).

Cloning methods are available on collection types, such as SlideCollection, DrawingCollection, TextParagraphCollection or TextElementCollection. Exception is the PresentationDocument type that has a Clone() method used to make a deep clone of the entire presentation. Cloning methods available on the collection types have two forms: AddClone(Slide) and InsertClone(Int32, Slide) to append the duplicate to the collection or insert it into a specific location in the collection.

Objects contained in the presentation can contain references to other objects. For example, Slide contains a reference to its ParentTemplate, Connector can contain a reference to drawings that it connects (BeginConnection and EndConnection), Action can contain a Target to Slide or CustomSlideShow that should be shown when the action is triggered.

When cloning multiple objects, the desired behavior is to maintain these references in the duplicated objects so that, for example, when Connector is cloned, and later when drawings that it connects are cloned, the duplicated Connector also connects duplicates of the original drawings that are connected.

This reference mapping between an original object and its duplicate is maintained by the instance of the CloneContext type. CloneContext instance is created with Create(PresentationDocument, PresentationDocument) static method. Each object can be cloned exactly once using the same CloneContext instance. If you want to clone the same object multiple times, each time a new CloneContext instance must be used. CloneContext is the most useful when cloning multiple objects one after another or when you want to change a behavior of the cloning operation.

Behavior of the cloning operation can be changed by using Set<T>(T, T) method. With this method you can make an explicit mapping between objects and cloning process will respect that mapping. For example, if you are cloning a Slide instance to another PresentationDocument default behavior would be that its parent template LayoutSlide and MasterSlide would also be cloned to another PresentationDocument. This behavior can be changed by making an explicit mapping from the LayoutSlide that is the ParentTemplate of the Slide that will be cloned to some LayoutSlide in the another PresentationDocument that we wish to be a ParentTemplate of the duplicated Slide. Explicit mapping with Set<T>(T, T) method can currently be made between following type (and their derivatives) instances: SlideObject, Drawing, TableStyle and CustomSlideShow.

Exceptions
System.ArgumentNullException

source parameter is null.

InsertClone<TTextElement>(Int32, TTextElement, CloneContext)

Inserts a clone of the source TTextElement to the collection at the specified index.

public TTextElement InsertClone<TTextElement>(int index, TTextElement source, CloneContext context)
    where TTextElement : TextElement
Public Function InsertClone(Of TTextElement As TextElement)(index As Integer, source As TTextElement, context As CloneContext) As TTextElement
Parameters
index
System.Int32

The zero-based index at which clone of the source TTextElement should be inserted.

source
TTextElement

The source TTextElement that will be cloned.

context
CloneContext

The context used to maintain reference mapping in multiple cloning operations.

Returns
TTextElement

A clone of the source TTextElement inserted to the collection.

Type Parameters
TTextElement

The type of the drawing.

Remarks

Cloning is a process when one or more objects from a presentation are duplicated. Objects can be duplicated to the same or another presentation and to the same or another location (for example, to another slide).

Cloning methods are available on collection types, such as SlideCollection, DrawingCollection, TextParagraphCollection or TextElementCollection. Exception is the PresentationDocument type that has a Clone() method used to make a deep clone of the entire presentation. Cloning methods available on the collection types have two forms: AddClone(Slide) and InsertClone(Int32, Slide) to append the duplicate to the collection or insert it into a specific location in the collection.

Objects contained in the presentation can contain references to other objects. For example, Slide contains a reference to its ParentTemplate, Connector can contain a reference to drawings that it connects (BeginConnection and EndConnection), Action can contain a Target to Slide or CustomSlideShow that should be shown when the action is triggered.

When cloning multiple objects, the desired behavior is to maintain these references in the duplicated objects so that, for example, when Connector is cloned, and later when drawings that it connects are cloned, the duplicated Connector also connects duplicates of the original drawings that are connected.

This reference mapping between an original object and its duplicate is maintained by the instance of the CloneContext type. CloneContext instance is created with Create(PresentationDocument, PresentationDocument) static method. Each object can be cloned exactly once using the same CloneContext instance. If you want to clone the same object multiple times, each time a new CloneContext instance must be used. CloneContext is the most useful when cloning multiple objects one after another or when you want to change a behavior of the cloning operation.

Behavior of the cloning operation can be changed by using Set<T>(T, T) method. With this method you can make an explicit mapping between objects and cloning process will respect that mapping. For example, if you are cloning a Slide instance to another PresentationDocument default behavior would be that its parent template LayoutSlide and MasterSlide would also be cloned to another PresentationDocument. This behavior can be changed by making an explicit mapping from the LayoutSlide that is the ParentTemplate of the Slide that will be cloned to some LayoutSlide in the another PresentationDocument that we wish to be a ParentTemplate of the duplicated Slide. Explicit mapping with Set<T>(T, T) method can currently be made between following type (and their derivatives) instances: SlideObject, Drawing, TableStyle and CustomSlideShow.

Exceptions
System.ArgumentNullException

source or context parameter is null.

System.ArgumentException

source is not associated with the SourcePresentation or the current collection is not associated with the DestinationPresentation of the context.

Remove(TextElement)

Removes the first occurrence of a specific TextElement from the collection.

public bool Remove(TextElement item)
Public Function Remove(item As TextElement) As Boolean
Parameters
item
TextElement

The TextElement to remove from the collection.

Returns
System.Boolean

true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the original collection.

RemoveAt(Int32)

Removes the TextElement at the specified index of the collection.

public void RemoveAt(int index)
Public Sub RemoveAt(index As Integer)
Parameters
index
System.Int32

The zero-based index of the TextElement to remove.

Exceptions
System.ArgumentOutOfRangeException

index is less than zero or index is equal to or greater than Count.

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Examples

See Also