Click or drag to resize

Column: Settings

[This is preliminary documentation and is subject to change.]

Index

The column index. See BcfColumnIndex.

Name

The column name is used as columns key in column-collections and in generated code. See:

Summary

The column summary.

Type (c#)

The column type. Valid are all .net types except open generic types and static classes.

Caution note Caution

Use immutable types or treat instances as immutable. Changing instance values will not been recognized and may cause unexpected behavior.

Example
Copy
System.String
See:

Allow Null

If checked null will be accepted as value.See:

Primary Key

If checked the column is (a part) of tables primary key. If using multiple columns as primary keys the column index defines the key order. See:

Include In Undo

Specifies whether the values are managed by undo-redo feature. The setting does not affect Rollback. See:

Default (c#)

C# value used as default value.

Example
Copy
string.Empty
See:

Function (c#)

C# expression computing the value. Parameters have to be added in parameters grid (below column grid).

Column with Type: string one parameter with name strings.

Example
Copy
string.Join("-", strings)

See:

Async Option

Specifies how to compute values if asynchrony calculation is enabled. See:

Should Persist

Specifies columns BcfColumnShouldPersist property. When BCF-Editor generates the Data-Transfer-Objects (DTO) a property on Row-DTO-Interface will be added.

When BcfColumnShouldPersist is true, updating a columns cell will cause the BcfTransaction to renew BcfDataSetCurrentDataStateId.

See:

Create Property (Row)

Specifies whether a property on row-class will be generated for the column value.

Create Property (View)

Specifies whether a property on row-view-class will be generated for the column value.

ReadOnly

If true the row and row-view properties are generated without setter. This does NOT mean the value can not be changed. All cell values can be changed (at least temporary) using SetValueT.

Ref Count

Number of parameters using this column as source.

Column Property Name

Tables column-property name.

Use Default (Column Property Name)

True if "Column Property Name" is default (from columnname and Project/DataSet/Column Property Name Format).

Convert (c#)

Convert value function. Used when values are assiged untyped e.g. SetValueObject.

Definition
Copy
public delegate bool BcfConvert<T>(BcfColumn<T> column, object proposedValue, out T convertedValue);
Example
Copy
// enter in BCF-Editor:
Util.Convert

// required in referenced project:
public class Util {
  public static bool Convert<T>(BcfColumn<T> column, object proposedValue, out T convertedValue) {
    try {
      convertedValue = (T)Convert.ChangeType(proposedValue, typeof(T));
      return true;
    } catch(Exception) {
      convertedValue = default(T);
      return false;
    }
  }
}
See:

Format (c#)

Format value action. Used every time before a value is stored in a cell. Frequently used to truncate strings and to round decimals.

Definition
Copy
public delegate T BcfFormat<T>(BcfColumn<T> column, T proposedValue);
Example
Copy
// truncate string
(column, proposedValue) => proposedValue?.SubString(0, 50)
See:

Trigger (c#)

Trigger action. Used to intercept setting a value.

Definition
Copy
public delegate void BcfTrigger<T>(BcfCell<T> cell, T proposedValue, BcfUpdateCurrentCell update);
public delegate void BcfUpdateCurrentCell(bool force = false);
Example
Copy
// redirect value to 'OtherColumn' of same type
(cell, value, updateCell) => { row.SetValue<TColumnValue>("OtherColumn", value); updateCell(); }
See:

Discard (c#)

Discard value action. Performs cleanup on values when going out of (its datasets) scope.

Definition
Copy
public delegate void BcfDiscard<T>(BcfColumn<T> column, T value);
Example
Copy
(column, value) => value.Dispose()
See:

Value Constraint (c#)

Value constraint function returning false to reject a value.

Definition
Copy
public delegate bool BcfValueConstraint<T>(BcfColumn<T> column, T proposedValue);
Example
Copy
// allow values > 100 on int column
(column, value) => value > 100
See:

Equality Comparer (c#)

EqualityComparer to compare instances.

Example
Copy
StringComparer.InvariantCultureIgnoreCase
See:

Sequence (c#)

Sequence creating default values.

Example Guid
Copy
BcfSequence.FromFunc(Guid.NewGuid)
Example Int
Copy
new BcfIntSequence()
See:

Option Properties...

One additional column per defined column-option-property. See Column Option Properties: Commands and Column Option Properties: Settings. BCF-Editor generated code sets the properties on BcfColumnSetupT, TOptionsOptions and BcfColumnT, TOptionsOptions.

See Also