DataColumnInfoCollection Class
- Namespace
TXTextControl.DocumentServer. DataSources
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXDocumentServer.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXDocumentServer.from the setup.dll
Description
An instance of the DataColumnInfoCollection class contains all data columns of a data table in a data source represented through objects of the type DataColumnInfo. The DataColumnInfoCollection class implements the interface ICollection<DocumentServer.DataSources.DataColumnInfo> and therefore also IEnumerable<DocumentServer.DataSources.DataColumnInfo>. This collection class is meant to be read only. For this reason all ICollection members which would cause changes to the collection content (e. g. Add(), Clear() or Remove()) throw a NotSupportedException.
Syntax
public sealed class DataColumnInfoCollection : ICollection<DataColumnInfo>, IEnumerable<DataColumnInfo>, IEnumerablePublic NotInheritable Class DataColumnInfoCollection
Implements ICollection(Of DataColumnInfo), IEnumerable(Of DataColumnInfo), IEnumerableExamples
The following example includes the item value from a Data Column Info Collection object in application diagnostics. The created object is then available to the surrounding document workflow.
Console.WriteLine($"Item: {dataColumnInfoCollection[1]}");
Console.WriteLine("Data Column Info Collection is ready for use.");Console.WriteLine($"Item: {dataColumnInfoCollection.Item(1)}")
Console.WriteLine("Data Column Info Collection is ready for use.")Members
Properties
| Property | Description |
|---|---|
| Count | Gets the number of elements contained in the collection. |
| IsReadOnly | Gets a value indicating whether the collection is read only. Always returns true. |
| Item | Gets the DataColumnInfo instance with the specified 0-based index from the collection. In C# this property is the indexer for the DataColumnInfoCollection class. |
Methods
| Method | Description |
|---|---|
| Add | Not described in the reference. public void Add(DataColumnInfo item); |
| Clear | Not described in the reference. public void Clear(); |
| Contains | Not described in the reference. public bool Contains(DataColumnInfo item); |
| CopyTo | Copies the elements of the collection to an array, starting at a particular index. |
| GetEnumerator | Returns an enumerator that can be used to iterate through the collection. |
| Remove | Not described in the reference. public bool Remove(DataColumnInfo item); |