TableCellCollection Class

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

Represents a collection of TableCells.

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

Properties

Count

Gets the number of TableCells contained in the collection.

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

The number of TableCells contained in the collection.

Item[Int32]

Gets or sets the TableCell at the specified index.

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

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

Property Value
TableCell

The TableCell 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 TableCellCollection.

TextContent

Gets the text content of the current TableCellCollection.

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

The text content of the current TableCellCollection.

Remarks

For more information, see Find and Replace example.

Methods

Add(TableCell)

Adds a TableCell to the end of the collection.

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

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

Exceptions
System.ArgumentNullException

item is null.

System.ArgumentException

item is already contained in another TableCellCollection.

AddClone(TableCell)

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

public TableCell AddClone(TableCell source)
Public Function AddClone(source As TableCell) As TableCell
Parameters
source
TableCell

The source TableCell that will be cloned.

Returns
TableCell

A clone of the source TableCell added to the collection.

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(TableCell, CloneContext)

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

public TableCell AddClone(TableCell source, CloneContext context)
Public Function AddClone(source As TableCell, context As CloneContext) As TableCell
Parameters
source
TableCell

The source TableCell that will be cloned.

context
CloneContext

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

Returns
TableCell

A clone of the source TableCell added to the collection.

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.

AddNew()

Adds a new TableCell to the end of the collection.

public TableCell AddNew()
Public Function AddNew As TableCell
Returns
TableCell

A new TableCell added to the collection.

Exceptions
System.InvalidOperationException

Table cell cannot be added because parent table row has been removed from the table.

Clear()

Removes all TableCells from the collection.

public void Clear()
Public Sub Clear

Contains(TableCell)

Determines whether a TableCell is in the collection.

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

The TableCell 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 TableCellCollection.

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

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

IndexOf(TableCell)

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

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

The TableCell 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, TableCell)

Inserts a TableCell to the collection at the specified index.

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

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

item
TableCell

The TableCell 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 TableCellCollection.

InsertClone(Int32, TableCell)

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

public TableCell InsertClone(int index, TableCell source)
Public Function InsertClone(index As Integer, source As TableCell) As TableCell
Parameters
index
System.Int32

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

source
TableCell

The source TableCell that will be cloned.

Returns
TableCell

A clone of the source TableCell inserted to the collection.

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(Int32, TableCell, CloneContext)

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

public TableCell InsertClone(int index, TableCell source, CloneContext context)
Public Function InsertClone(index As Integer, source As TableCell, context As CloneContext) As TableCell
Parameters
index
System.Int32

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

source
TableCell

The source TableCell that will be cloned.

context
CloneContext

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

Returns
TableCell

A clone of the source TableCell inserted to the collection.

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.

InsertNew(Int32)

Inserts a new TableCell to the collection at the specified index.

public TableCell InsertNew(int index)
Public Function InsertNew(index As Integer) As TableCell
Parameters
index
System.Int32

The zero-based index at which new TableCell should be inserted.

Returns
TableCell

A new TableCell inserted to the collection.

Exceptions
System.ArgumentOutOfRangeException

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

System.InvalidOperationException

Table cell cannot be added because parent table row has been removed from the table.

Remove(TableCell)

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

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

The TableCell 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 TableCell 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 TableCell 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