TableDefinition Class
Definition of a table in a database.
Methods
Section titled “Methods”| Method | Description |
|---|---|
| CompareTo(updated) | Compares this table definition to another table definition. |
| CreateRow(sourceLineNumbers) | In general this method shouldn’t be used - create rows from a Table instead. Creates a new row object of the type specified in this definition. |
Properties
Section titled “Properties”| Property | Description |
|---|---|
| Columns | Gets the collection of column definitions for this table. |
| Item | Gets the column definition in the table by index. |
| Name | Gets the name of the table. |
| SymbolDefinition | Gets the symbol definition associated with this table. |
| SymbolIdIsPrimaryKey | Gets if the primary key is the id of the symbol definition associated with this table. |
| Unreal | Gets if the table is unreal. |
Fields
Section titled “Fields”| Field | Description |
|---|---|
| MaxColumnsInRealTable | Tracks the maximum number of columns supported in a real table. This is a Windows Installer limitation. |
WixToolset.Data.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8 |
CompareTo(updated) Method
Section titled “CompareTo(updated) Method”Compares this table definition to another table definition.
Declaration
Section titled “Declaration”public int CompareTo( TableDefinition updated)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| updated | TableDefinition | The updated to compare with this target definition. |
Return value
Section titled “Return value”int 0 if the tables’ core properties are the same; otherwise, non-0.
Remarks
Section titled “Remarks”Only Windows Installer traits are compared, allowing for updates to WiX-specific table definitions.
CreateRow(sourceLineNumbers) Method
Section titled “CreateRow(sourceLineNumbers) Method”In general this method shouldn’t be used - create rows from a Table instead. Creates a new row object of the type specified in this definition.
Declaration
Section titled “Declaration”public Row CreateRow( WixToolset.Data.SourceLineNumber sourceLineNumbers)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| sourceLineNumbers | WixToolset.Data.SourceLineNumber | Original source lines for this row. |
Return value
Section titled “Return value”Row Created row.
Columns Property
Section titled “Columns Property”Gets the collection of column definitions for this table.
Declaration
Section titled “Declaration”public ColumnDefinition[] Columns { get; set; }Item Property
Section titled “Item Property”Gets the column definition in the table by index.
Declaration
Section titled “Declaration”public ColumnDefinition Item[ int columnIndex] { get; set; }Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| columnIndex | int | Index of column to locate. |
Name Property
Section titled “Name Property”Gets the name of the table.
Declaration
Section titled “Declaration”public string Name { get; set; }SymbolDefinition Property
Section titled “SymbolDefinition Property”Gets the symbol definition associated with this table.
Declaration
Section titled “Declaration”public WixToolset.Data.IntermediateSymbolDefinition SymbolDefinition { get; set; }SymbolIdIsPrimaryKey Property
Section titled “SymbolIdIsPrimaryKey Property”Gets if the primary key is the id of the symbol definition associated with this table.
Declaration
Section titled “Declaration”public bool SymbolIdIsPrimaryKey { get; set; }Unreal Property
Section titled “Unreal Property”Gets if the table is unreal.
Declaration
Section titled “Declaration”public bool Unreal { get; set; }