Class EntitySchemaColumnCollection
Provides methods of working with the collection of schema columns.
Inheritance
Implements
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("{4FFDE9C3-86BB-45ab-94B1-16C82B761DBC}")]
public class EntitySchemaColumnCollection : UniqueNameMetaItemCollection<EntitySchemaColumn>, IList<EntitySchemaColumn>, ICollection<EntitySchemaColumn>, IList, ICollection, IReadOnlyList<EntitySchemaColumn>, IReadOnlyCollection<EntitySchemaColumn>, IEnumerable<EntitySchemaColumn>, IEnumerable, IMetaDataSerializable, ITempalteSerializable, ICloneable
Constructors
EntitySchemaColumnCollection(EntitySchema)
Initializes a new instance of the EntitySchemaColumnCollection class in the specified schema.
Declaration
public EntitySchemaColumnCollection(EntitySchema entitySchema)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | entitySchema | Schema where the new collection of columns is being created. |
EntitySchemaColumnCollection(EntitySchemaColumnCollection)
Initializes a new instance of the EntitySchemaColumnCollection class that is a clone of the specified collection of columns.
Declaration
public EntitySchemaColumnCollection(EntitySchemaColumnCollection source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaColumnCollection | source | The collection of columns whose clone is being created. |
Properties
EntitySchema
The schema of the current collection of columns.
Declaration
[Obsolete("7.12.0 | Property is not in use and will be removed in upcoming releases")]
public EntitySchema EntitySchema { get; }
Property Value
Type | Description |
---|---|
EntitySchema |
Methods
Clone()
Returns the collection of columns which is a clone of the given collection.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
System.Object | The EntitySchemaColumnCollection instance that is a clone of the current collection of columns. |
FindByCaption(String)
Searches for the column with the specified caption n the collection.
Declaration
public EntitySchemaColumn FindByCaption(string caption)
Parameters
Type | Name | Description |
---|---|---|
System.String | caption | The caption of the column to get. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | The EntitySchemaColumn instance with the |
FindByColumnValueName(String)
Searches for the column with the specified ColumnValueName
property in the collection.
Declaration
public EntitySchemaColumn FindByColumnValueName(string columnValueName)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnValueName | The value of the |
Returns
Type | Description |
---|---|
EntitySchemaColumn | The EntitySchemaColumn instance with the |
GetByColumnValueName(String)
From the collection returns a column by the specified ColumnValueName
column property. If the column is not found, the exception is thrown.
Declaration
public EntitySchemaColumn GetByColumnValueName(string columnValueName)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnValueName | The value of the |
Returns
Type | Description |
---|---|
EntitySchemaColumn | The EntitySchemaColumn instance with the |
Exceptions
Type | Condition |
---|---|
ItemNotFoundException | If the column with the |
InsertItem(Int32, EntitySchemaColumn)
In the current collection of columns, adds the specified column into the specified position.
Declaration
protected override void InsertItem(int index, EntitySchemaColumn item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position into which the |
EntitySchemaColumn | item | Column that is added into the |
Overrides
RemoveItem(Int32)
Removes the column in the specified position from the current collection of columns.
Declaration
protected override void RemoveItem(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position which the column is removed from. |