TableColumnCollection Class

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

Represents a collection of TableColumns.

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

Properties

Count

Gets the number of TableColumns contained in the collection.

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

The number of TableColumns contained in the collection.

Item[Int32]

Gets or sets the TableColumn at the specified index.

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

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

Property Value
TableColumn

The TableColumn 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 TableColumnCollection.

Methods

Add(TableColumn)

Adds a TableColumn to the end of the collection.

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

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

Exceptions
System.ArgumentNullException

item is null.

System.ArgumentException

item is already contained in another TableColumnCollection.

AddClone(TableColumn)

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

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

The source TableColumn that will be cloned.

Returns
TableColumn

A clone of the source TableColumn 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(TableColumn, CloneContext)

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

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

The source TableColumn that will be cloned.

context
CloneContext

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

Returns
TableColumn

A clone of the source TableColumn 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(Length)

Adds a new TableColumn with the specified width to the end of the collection.

public TableColumn AddNew(Length width)
Public Function AddNew(width As Length) As TableColumn
Parameters
width
Length

Width of a new TableColumn.

Returns
TableColumn

A new TableColumn with the specified width added to the collection.

Exceptions
System.ArgumentOutOfRangeException

width is not greater than zero.

Clear()

Removes all TableColumns from the collection.

public void Clear()
Public Sub Clear

Contains(TableColumn)

Determines whether a TableColumn is in the collection.

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

The TableColumn 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 TableColumnCollection.

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

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

IndexOf(TableColumn)

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

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

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

Inserts a TableColumn to the collection at the specified index.

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

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

item
TableColumn

The TableColumn 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 TableColumnCollection.

InsertClone(Int32, TableColumn)

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

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

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

source
TableColumn

The source TableColumn that will be cloned.

Returns
TableColumn

A clone of the source TableColumn 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, TableColumn, CloneContext)

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

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

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

source
TableColumn

The source TableColumn that will be cloned.

context
CloneContext

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

Returns
TableColumn

A clone of the source TableColumn 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, Length)

Inserts a new TableColumn with the specified width to the collection at the specified index.

public TableColumn InsertNew(int index, Length width)
Public Function InsertNew(index As Integer, width As Length) As TableColumn
Parameters
index
System.Int32

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

width
Length

Width of a new TableColumn.

Returns
TableColumn

A new TableColumn with the specified width inserted to the collection.

Exceptions
System.ArgumentOutOfRangeException

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

System.ArgumentOutOfRangeException

width is not greater than zero.

Remove(TableColumn)

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

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

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