ColumnCollection Class
Collection of column information related to a «see T:WixToolset.Dtf.WindowsInstaller.TableInfo» or «see T:WixToolset.Dtf.WindowsInstaller.View» .
Methods
Section titled “Methods”| Method | Description |
|---|---|
| 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
Section titled “Properties”| Property | Description |
|---|---|
| Count | Gets the number of columns in the collection. |
| FormatString | Gets a string suitable for printing all the values of a record containing these columns. |
| IsReadOnly | 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» . |
| Item | Gets information about a specific column in the collection. |
| Item | Gets information about a specific column in the collection. |
WixToolset.Dtf.WindowsInstaller.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8 |
Add(item) Method
Section titled “Add(item) Method”Not supported because the collection is read-only.
Declaration
Section titled “Declaration”public void Add( ColumnInfo item)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| item | ColumnInfo | information about the column being added |
Exceptions
Section titled “Exceptions”| Exception | Description |
|---|---|
| T:System.InvalidOperationException | the collection is read-only |
Clear() Method
Section titled “Clear() Method”Not supported because the collection is read-only.
Declaration
Section titled “Declaration”public void Clear()Exceptions
Section titled “Exceptions”| Exception | Description |
|---|---|
| T:System.InvalidOperationException | the collection is read-only |
Contains(columnName) Method
Section titled “Contains(columnName) Method”Checks if a column with a given name exists in the collection.
Declaration
Section titled “Declaration”public bool Contains( string columnName)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| columnName | string | case-sensitive name of the column to look for |
Return value
Section titled “Return value”bool true if the column exists in the collection, false otherwise
CopyTo(array, arrayIndex) Method
Section titled “CopyTo(array, arrayIndex) Method”Copies the columns from this collection into an array.
Declaration
Section titled “Declaration”public void CopyTo( ColumnInfo[] array, int arrayIndex)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| array | ColumnInfo[] | destination array to be filed |
| arrayIndex | int | offset into the destination array where copying begins |
GetEnumerator() Method
Section titled “GetEnumerator() Method”Gets an enumerator over the columns in the collection.
Declaration
Section titled “Declaration”public IEnumerator<WixToolset.Dtf.WindowsInstaller.ColumnInfo> GetEnumerator()Return value
Section titled “Return value”IEnumerator<WixToolset.Dtf.WindowsInstaller.ColumnInfo> An enumerator of ColumnInfo objects.
IndexOf(columnName) Method
Section titled “IndexOf(columnName) Method”Gets the index of a column within the collection.
Declaration
Section titled “Declaration”public int IndexOf( string columnName)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| columnName | string | case-sensitive name of the column to look for |
Return value
Section titled “Return value”int 0-based index of the column, or -1 if not found
Count Property
Section titled “Count Property”Gets the number of columns in the collection.
Declaration
Section titled “Declaration”public int Count { get; set; }FormatString Property
Section titled “FormatString Property”Gets a string suitable for printing all the values of a record containing these columns.
Declaration
Section titled “Declaration”public string FormatString { get; set; }IsReadOnly Property
Section titled “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
Section titled “Declaration”public bool IsReadOnly { get; set; }Item Property
Section titled “Item Property”Gets information about a specific column in the collection.
Declaration
Section titled “Declaration”public ColumnInfo Item[ int columnIndex] { get; set; }Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| columnIndex | int | 1-based index into the column collection |
Exceptions
Section titled “Exceptions”| Exception | Description |
|---|---|
| T:System.ArgumentOutOfRangeException | is less |
than 1 or greater than the number of columns in the collection |Item Property
Section titled “Item Property”Gets information about a specific column in the collection.
Declaration
Section titled “Declaration”public ColumnInfo Item[ string columnName] { get; set; }Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| columnName | string | case-sensitive name of a column collection |
Exceptions
Section titled “Exceptions”| Exception | Description |
|---|---|
| T:System.ArgumentOutOfRangeException | does |
not exist in the collection |