Class Column

Namespace

Dynamicweb.DataIntegration.Integration

Assembly

Dynamicweb.DataIntegration.dll

Represents table column

public class Column

Inheritance

object

Column

Derived

SqlColumn

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MappingExtensions.IsKeyColumn(Column, IEnumerable<ColumnMapping>)

Constructors

Column()

Default constructor

public Column()

Column(string, Type?, Table?)

Initializes a new instance of the Column class.

public Column(string name, Type? type, Table? table)

Parameters

name string

The name.

type Type

The type.

table Table

The table.

Column(string, Type?, Table?, bool, bool)

Initializes a new instance of the Column class.

public Column(string name, Type? type, Table? table, bool isPrimaryKey, bool isNew)

Parameters

name string

The name.

type Type

The type.

table Table

The table.

isPrimaryKey bool

if set to true, the column is primary key.

isNew bool

if set to true, indicates that the column is to be added to the schema when the activity is run..

Column(string, Type?, Table?, bool, bool, bool)

Initializes a new instance of the Column class.

public Column(string name, Type? type, Table? table, bool isPrimaryKey, bool isNew, bool readOnly)

Parameters

name string

The name.

type Type

The type.

table Table

The table.

isPrimaryKey bool

if set to true, the column is primary key.

isNew bool

if set to true, indicates that the column is to be added to the schema when the activity is run..

readOnly bool

if set to true, indicates that the column is read only.

Column(XmlNode, Table)

Initializes a new instance of the Column class. Is used when reading the schema from an XML file, as part of a provider. must match the output created by SaveAsXML().

public Column(XmlNode xmlNode, Table table)

Parameters

xmlNode XmlNode

The XML node.

table Table

The table.

Fields

isNew

protected bool isNew

Field Value

bool

isPrimaryKey

protected bool isPrimaryKey

Field Value

bool

name

protected string name

Field Value

string

table

protected Table? table

Field Value

Table

type

protected Type? type

Field Value

Type

Properties

Group

public string? Group { get; set; }

Property Value

string

IsNew

Gets a value indicating whether this instance has been added to the schema during the mapping.

public bool IsNew { get; }

Property Value

bool

true if this instance is new; otherwise, false.

IsPrimaryKey

Gets or sets a value indicating whether this instance is a primary key. Must be true for at least one colunn in the table, can be true for several.

public virtual bool IsPrimaryKey { get; set; }

Property Value

bool

true if this instance is primary key; otherwise, false.

Name

Gets or sets the name of the column.

public virtual string Name { get; set; }

Property Value

string

The name of the column.

NameWithWhitespaceStripped

Gets or sets the name with whitespace stripped.

public virtual string NameWithWhitespaceStripped { get; set; }

Property Value

string

The name with whitespace stripped.

ReadOnly

Gets value indicating if the column is read only

public virtual bool ReadOnly { get; set; }

Property Value

bool

Table

Gets the table this column belongs to.

public virtual Table? Table { get; }

Property Value

Table

Type

Gets the type of the column.

public virtual Type? Type { get; }

Property Value

Type

Methods

SaveAsXml(XmlTextWriter)

Saves as XML. Used when saving the schema to XML file. Must match the constructor that take an XmlNode as an argument.

public virtual void SaveAsXml(XmlTextWriter xmlTextWriter)

Parameters

xmlTextWriter XmlTextWriter

The XML text writer.