com.groupdocs.assembly

Class DocumentTableColumnCollection

java.lang.Object

com.groupdocs.assembly.DocumentTableColumnCollection

All Implemented Interfaces:

java.lang.Iterable

public class DocumentTableColumnCollection
extends java.lang.Object
implements java.lang.Iterable

Represents a read-only collection of DocumentTableColumn objects of a particular DocumentTable instance. The collection is filled automatically while loading the corresponding table from a document and can not be modified. However, properties of DocumentTableColumn objects contained within the collection can be modified.

Method Summary

Modifier and Type	Method and Description
boolean	contains(DocumentTableColumn column) Returns a value indicating whether this collection contains the specified column.
boolean	contains(java.lang.String name) Returns a value indicating whether this collection contains a column with the specified name.
DocumentTableColumn	get(int index) Gets a DocumentTableColumn instance from the collection at the specified index.
DocumentTableColumn	get(java.lang.String name) Gets a DocumentTableColumn instance with the specified name from the collection.
int	getCount() Gets the total number of DocumentTableColumn objects in the collection.
int	indexOf(DocumentTableColumn column) Returns the index of the specified column within this collection.
int	indexOf(java.lang.String name) Returns the index of a column with the specified name within this collection.
java.util.Iterator	iterator() Returns an enumerator to iterate DocumentTableColumn objects of this collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public java.util.Iterator iterator()

Returns an enumerator to iterate DocumentTableColumn objects of this collection.

Specified by:

iterator in interface java.lang.Iterable

Returns:

An enumerator to iterate DocumentTableColumn objects of this collection.

contains

public boolean contains(java.lang.String name)

Returns a value indicating whether this collection contains a column with the specified name.

Parameters:

name - The case-insensitive name of a column to look for.

Returns:

A value indicating whether this collection contains a column with the specified name.

contains

public boolean contains(DocumentTableColumn column)

Returns a value indicating whether this collection contains the specified column.

Parameters:

column - A column to look for.

Returns:

A value indicating whether this collection contains the specified column.

indexOf

public int indexOf(java.lang.String name)

Returns the index of a column with the specified name within this collection.

Parameters:

name - The case-insensitive name of a column to find.

Returns:

The zero-based index of a column with the specified name, or -1 if the column does not exist in this collection.

indexOf

public int indexOf(DocumentTableColumn column)

Returns the index of the specified column within this collection.

Parameters:

column - A column to find.

Returns:

The zero-based index of the specified column, or -1 if the column does not exist in this collection.

get

public DocumentTableColumn get(int index)

Gets a DocumentTableColumn instance from the collection at the specified index.

Parameters:

index - The zero-based index of the column to return.

Returns:

A DocumentTableColumn instance from the collection at the specified index.

get

public DocumentTableColumn get(java.lang.String name)

Gets a DocumentTableColumn instance with the specified name from the collection.

Parameters:

name - The case-insensitive name of the column to return.

Returns:

A DocumentTableColumn instance with the specified name from the collection or null if such an instance does not exist.

getCount

public int getCount()

Gets the total number of DocumentTableColumn objects in the collection.

Returns:

The total number of DocumentTableColumn objects in the collection.