Field Class
Field containing data for a column in a row.
Methods
Section titled “Methods”| Method | Description |
|---|---|
| AsInteger() | Gets the field as an integer. |
| AsNullableInteger() | Gets the field as an integer that could be null. |
| AsString() | Gets the field as a string. |
| BestEffortSet(value) | Sets the value of a particular field in the row without validating. |
| Create(columnDefinition) | Instantiate a new Field object of the correct type. |
| IsIdentical(field) | Determine if this field is identical to another field. |
| ToString() | Overrides the built in object implementation to return the field’s data as a string. |
Properties
Section titled “Properties”| Property | Description |
|---|---|
| Column | Gets or sets the column definition for this field. |
| Data | Gets or sets the data for this field. |
| Modified | Gets or sets whether this field is modified. |
| PreviousData | Gets or sets the previous data. |
WixToolset.Data.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8 |
AsInteger() Method
Section titled “AsInteger() Method”Gets the field as an integer.
Declaration
Section titled “Declaration”public int AsInteger()Return value
Section titled “Return value”int Field’s data as an integer.
AsNullableInteger() Method
Section titled “AsNullableInteger() Method”Gets the field as an integer that could be null.
Declaration
Section titled “Declaration”public System.Nullable<System.Int32> AsNullableInteger()Return value
Section titled “Return value”System.Nullable<System.Int32> Field’s data as an integer that could be null.
AsString() Method
Section titled “AsString() Method”Gets the field as a string.
Declaration
Section titled “Declaration”public string AsString()Return value
Section titled “Return value”string Field’s data as a string.
BestEffortSet(value) Method
Section titled “BestEffortSet(value) Method”Sets the value of a particular field in the row without validating.
Declaration
Section titled “Declaration”public bool BestEffortSet( System.Object value)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| value | System.Object | Value of a field in the row. |
Return value
Section titled “Return value”bool True if successful, false if validation failed.
Create(columnDefinition) Method
Section titled “Create(columnDefinition) Method”Instantiate a new Field object of the correct type.
Declaration
Section titled “Declaration”public static Field Create( ColumnDefinition columnDefinition)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| columnDefinition | ColumnDefinition | The column definition for the field. |
Return value
Section titled “Return value”Field The new Field object.
IsIdentical(field) Method
Section titled “IsIdentical(field) Method”Determine if this field is identical to another field.
Declaration
Section titled “Declaration”public bool IsIdentical( Field field)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| field | Field | The other field to compare to. |
Return value
Section titled “Return value”bool true if they are equal; false otherwise.
ToString() Method
Section titled “ToString() Method”Overrides the built in object implementation to return the field’s data as a string.
Declaration
Section titled “Declaration”public string ToString()Return value
Section titled “Return value”string Field’s data as a string.
Column Property
Section titled “Column Property”Gets or sets the column definition for this field.
Declaration
Section titled “Declaration”public ColumnDefinition Column { get; set; }Data Property
Section titled “Data Property”Gets or sets the data for this field.
Declaration
Section titled “Declaration”public System.Object Data { get; set; }Modified Property
Section titled “Modified Property”Gets or sets whether this field is modified.
Declaration
Section titled “Declaration”public bool Modified { get; set; }PreviousData Property
Section titled “PreviousData Property”Gets or sets the previous data.
Declaration
Section titled “Declaration”public string PreviousData { get; set; }