Class IndexColumnSchemaCollection

List of index columns.

Inheritance

System.Object

System.Collections.ObjectModel.Collection<IndexColumnSchema>

System.Collections.ObjectModel.KeyedCollection<System.String, IndexColumnSchema>

IndexColumnSchemaCollection

Namespace: Kros.Data.Schema

Assembly: Kros.Utils.dll

Syntax

public class IndexColumnSchemaCollection : KeyedCollection<string, IndexColumnSchema>, IList<IndexColumnSchema>, ICollection<IndexColumnSchema>, IList, ICollection, IReadOnlyList<IndexColumnSchema>, IReadOnlyCollection<IndexColumnSchema>, IEnumerable<IndexColumnSchema>, IEnumerable

Remarks

To the columns added to this list is automatically set their Index. The column can belong only to one index.

Constructors

IndexColumnSchemaCollection(IndexSchema)

Creates a new list of columns for index index.

Declaration

public IndexColumnSchemaCollection(IndexSchema index)

Parameters

Type	Name	Description
IndexSchema	index	The index to which column list belongs.

Exceptions

Type	Condition
System.ArgumentNullException	Value of index is null.

Properties

Index

The index to which column list belongs.

Declaration

public IndexSchema Index { get; }

Property Value

Type	Description
IndexSchema

Methods

Add(String)

Creates the new index column with name columnName and adds it to the list.

Declaration

public IndexColumnSchema Add(string columnName)

Parameters

Type	Name	Description
System.String	columnName	Column name.

Returns

Type	Description
IndexColumnSchema	Created column.

Exceptions

Type	Condition
System.ArgumentNullException	Value of columnName is null.
System.ArgumentException	Value of columnName is empty string, or string containing only whitespace characters.

Add(String, SortOrder)

Creates the new index column with name columnName and sort order order and adds it to the list.

Declaration

public IndexColumnSchema Add(string columnName, SortOrder order)

Parameters

Type	Name	Description
System.String	columnName	Column name.
SortOrder	order	Column sort order.

Returns

Type	Description
IndexColumnSchema	Created column.

Exceptions

Type	Condition
System.ArgumentNullException	Value of columnName is null.
System.ArgumentException	Value of columnName is empty string, or string containing only whitespace characters.

GetKeyForItem(IndexColumnSchema)

Declaration

protected override string GetKeyForItem(IndexColumnSchema item)

Parameters

Type	Name	Description
IndexColumnSchema	item

Returns

Type	Description
System.String

Overrides

System.Collections.ObjectModel.KeyedCollection<System.String, Kros.Data.Schema.IndexColumnSchema>.GetKeyForItem(Kros.Data.Schema.IndexColumnSchema)

InsertItem(Int32, IndexColumnSchema)

Declaration

protected override void InsertItem(int index, IndexColumnSchema item)

Parameters

Type	Name	Description
System.Int32	index
IndexColumnSchema	item

Overrides

System.Collections.ObjectModel.KeyedCollection<System.String, Kros.Data.Schema.IndexColumnSchema>.InsertItem(System.Int32, Kros.Data.Schema.IndexColumnSchema)

RemoveItem(Int32)

Declaration

protected override void RemoveItem(int index)

Parameters

Type	Name	Description
System.Int32	index

Overrides

System.Collections.ObjectModel.KeyedCollection<System.String, Kros.Data.Schema.IndexColumnSchema>.RemoveItem(System.Int32)