Skip to main content

ColumnCollection Class

Collection of column information related to a «see T:WixToolset.Dtf.WindowsInstaller.TableInfo» or «see T:WixToolset.Dtf.WindowsInstaller.View» .

Methods​

MethodDescription
Add(item)Not supported because the collection is read-only.
Clear()Not supported because the collection is read-only.
Contains(columnName)Checks if a column with a given name exists in the collection.
CopyTo(array, arrayIndex)Copies the columns from this collection into an array.
GetEnumerator()Gets an enumerator over the columns in the collection.
IndexOf(columnName)Gets the index of a column within the collection.

Properties​

PropertyDescription
CountGets the number of columns in the collection.
FormatStringGets a string suitable for printing all the values of a record containing these columns.
IsReadOnlyGets a boolean value indicating whether the collection is read-only. A ColumnCollection is read-only if it is associated with a «see T:WixToolset.Dtf.WindowsInstaller.View» or a read-only «see T:WixToolset.Dtf.WindowsInstaller.Database» .
ItemGets information about a specific column in the collection.
ItemGets information about a specific column in the collection.

WixToolset.Dtf.WindowsInstaller.dll version 6.0.0+8c7432e50072e009353ea5f2c956ccf453476f71

Add(item) Method​

Not supported because the collection is read-only.

Declaration​

public void Add(
ColumnInfo item
)

Parameters​

ParameterTypeDescription
itemColumnInfoinformation about the column being added

Exceptions​

ExceptionDescription
T:System.InvalidOperationExceptionthe collection is read-only

Clear() Method​

Not supported because the collection is read-only.

Declaration​

public void Clear()

Exceptions​

ExceptionDescription
T:System.InvalidOperationExceptionthe collection is read-only

Contains(columnName) Method​

Checks if a column with a given name exists in the collection.

Declaration​

public bool Contains(
string columnName
)

Parameters​

ParameterTypeDescription
columnNamestringcase-sensitive name of the column to look for

Return value​

bool true if the column exists in the collection, false otherwise

CopyTo(array, arrayIndex) Method​

Copies the columns from this collection into an array.

Declaration​

public void CopyTo(
ColumnInfo[] array,
int arrayIndex
)

Parameters​

ParameterTypeDescription
arrayColumnInfo[]destination array to be filed
arrayIndexintoffset into the destination array where copying begins

GetEnumerator() Method​

Gets an enumerator over the columns in the collection.

Declaration​

public IEnumerator<WixToolset.Dtf.WindowsInstaller.ColumnInfo> GetEnumerator()

Return value​

IEnumerator<WixToolset.Dtf.WindowsInstaller.ColumnInfo> An enumerator of ColumnInfo objects.

IndexOf(columnName) Method​

Gets the index of a column within the collection.

Declaration​

public int IndexOf(
string columnName
)

Parameters​

ParameterTypeDescription
columnNamestringcase-sensitive name of the column to look for

Return value​

int 0-based index of the column, or -1 if not found

Count Property​

Gets the number of columns in the collection.

Declaration​

public int Count { get; set; } 

FormatString Property​

Gets a string suitable for printing all the values of a record containing these columns.

Declaration​

public string FormatString { get; set; } 

IsReadOnly Property​

Gets a boolean value indicating whether the collection is read-only. A ColumnCollection is read-only if it is associated with a «see T:WixToolset.Dtf.WindowsInstaller.View» or a read-only «see T:WixToolset.Dtf.WindowsInstaller.Database» .

Declaration​

public bool IsReadOnly { get; set; } 

Item Property​

Gets information about a specific column in the collection.

Declaration​

public ColumnInfo Item[
int columnIndex
] { get; set; }

Parameters​

ParameterTypeDescription
columnIndexint1-based index into the column collection

Exceptions​

ExceptionDescription
T:System.ArgumentOutOfRangeExceptionis less
than 1 or greater than the number of columns in the collection

Item Property​

Gets information about a specific column in the collection.

Declaration​

public ColumnInfo Item[
string columnName
] { get; set; }

Parameters​

ParameterTypeDescription
columnNamestringcase-sensitive name of a column collection

Exceptions​

ExceptionDescription
T:System.ArgumentOutOfRangeExceptiondoes
not exist in the collection