Skip to content

ColumnDefinition Class

Definition of a table’s column.

Methods

MethodDescription
CompareTo(other)Compare this column definition to another column definition.

Properties

PropertyDescription
AddedGets whether this column was added via a transform.
CategoryGets the validation category for this column.
DescriptionGets the description for this column.
IsLocalizableGets if the column is localizable. Can be because the type is localizable, or because the column was explicitly set to be so.
KeyColumnGets the foreign key column that this column refers to.
KeyTableGets the table that has the foreign key for this column
LengthGets the length of the column.
MaxValueGets the maximum value for the column.
MinValueGets the minimum value for the column.
ModularizeTypeGets the type of modularization for this column.
NameGets the name of the column.
NullableGets if the column is nullable.
PossibilitiesGets the set of possibilities for this column.
PrimaryKeyGets if the column is a primary key.
TypeGets the type of the column.
UnrealGets if column is Unreal.
UseCDataGets if whitespace should be preserved in a CDATA node.
WixToolset.Data.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8

CompareTo(other) Method {#compareto_other}

Compare this column definition to another column definition.

Declaration

public int CompareTo(
  ColumnDefinition other
)

Parameters

ParameterTypeDescription
otherColumnDefinitionThe to compare with this one.

Return value

int 0 if the columns’ core propeties are the same; otherwise, non-0.

Remarks

Only Windows Installer traits are compared, allowing for updates to WiX-specific table definitions.

Added Property {#added}

Gets whether this column was added via a transform.

Declaration

public bool Added { get; set; }

Category Property {#category}

Gets the validation category for this column.

Declaration

public ColumnCategory Category { get; set; }

Description Property {#description}

Gets the description for this column.

Declaration

public string Description { get; set; }

IsLocalizable Property {#islocalizable}

Gets if the column is localizable. Can be because the type is localizable, or because the column was explicitly set to be so.

Declaration

public bool IsLocalizable { get; set; }

KeyColumn Property {#keycolumn}

Gets the foreign key column that this column refers to.

Declaration

public System.Nullable<System.Int32> KeyColumn { get; set; }

KeyTable Property {#keytable}

Gets the table that has the foreign key for this column

Declaration

public string KeyTable { get; set; }

Length Property {#length}

Gets the length of the column.

Declaration

public int Length { get; set; }

MaxValue Property {#maxvalue}

Gets the maximum value for the column.

Declaration

public System.Nullable<System.Int64> MaxValue { get; set; }

MinValue Property {#minvalue}

Gets the minimum value for the column.

Declaration

public System.Nullable<System.Int64> MinValue { get; set; }

ModularizeType Property {#modularizetype}

Gets the type of modularization for this column.

Declaration

public ColumnModularizeType ModularizeType { get; set; }

Name Property {#name}

Gets the name of the column.

Declaration

public string Name { get; set; }

Nullable Property {#nullable}

Gets if the column is nullable.

Declaration

public bool Nullable { get; set; }

Possibilities Property {#possibilities}

Gets the set of possibilities for this column.

Declaration

public string Possibilities { get; set; }

PrimaryKey Property {#primarykey}

Gets if the column is a primary key.

Declaration

public bool PrimaryKey { get; set; }

Type Property {#type}

Gets the type of the column.

Declaration

public ColumnType Type { get; set; }

Unreal Property {#unreal}

Gets if column is Unreal.

Declaration

public bool Unreal { get; set; }

UseCData Property {#usecdata}

Gets if whitespace should be preserved in a CDATA node.

Declaration

public bool UseCData { get; set; }