Click or drag to resize

BcfColumnT, TOptions Class

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

Represents a column in a BcfTable. This class cannot be inherited.
Inheritance Hierarchy
SystemObject
  CalculationWorks.BusinessModelBcfColumn
    CalculationWorks.BusinessModelBcfColumnT
      CalculationWorks.BusinessModelBcfColumnT, TOptions

Namespace:  CalculationWorks.BusinessModel
Assembly:  CalculationWorks.BusinessModel (in CalculationWorks.BusinessModel.dll) Version: 4.0.0-beta7
Syntax
public abstract class BcfColumn<T, TOptions> : BcfColumn<T>

Type Parameters

T
The value type.
TOptions
The Options-type.

The BcfColumnT, TOptions type exposes the following members.

Properties
  NameDescription
Public propertyAllowNull
Gets a value indicating the cells allow null as Value.
(Inherited from BcfColumn.)
Public propertyColumnId
Gets the column identifier unique in BcfDataSet.
(Inherited from BcfColumn.)
Public propertyContentEqualityComparison
Gets or sets the content equality comparison.
(Inherited from BcfColumnT.)
Public propertyConverter
Gets or sets the convert function.
(Inherited from BcfColumnT.)
Public propertyDataType
Gets the not-nullable type of the cells Value property. If value type is a nullable struct; the type-argument of NullableT will be returned; otherwise ValueType.
(Inherited from BcfColumn.)
Public propertyDefaultValue
Gets or sets the default value.
(Inherited from BcfColumnT.)
Public propertyDiscardAction
Gets the discard action.
(Inherited from BcfColumnT.)
Public propertyEqualityComparer
Gets or sets the equality comparer.
(Inherited from BcfColumnT.)
Public propertyFormatter
Gets or sets the format function.
(Inherited from BcfColumnT.)
Public propertyFunction
Gets the BcfFunction used to calculate the values in this column.
(Inherited from BcfColumnT.)
Public propertyHasConverter
Gets a value indicating Converter is not null.
(Inherited from BcfColumn.)
Public propertyHasDefaultValue
Gets a value indicating DefaultValue is not null.
(Inherited from BcfColumn.)
Public propertyHasDiscardAction
Gets a value indicating DiscardAction is not null.
(Inherited from BcfColumn.)
Public propertyHasFormatter
Gets a value indicating Formatter is not null.
(Inherited from BcfColumn.)
Public propertyHasFunction
Gets a value indicating the cells Value is computed.
(Inherited from BcfColumn.)
Public propertyHasSequence
Gets a value indicating Sequence is not null.
(Inherited from BcfColumn.)
Public propertyHasSurrogateConverter
Gets a value indicating HasSurrogateConverter is not null.
(Inherited from BcfColumn.)
Public propertyHasTrigger
Gets a value indicating Trigger is not null.
(Inherited from BcfColumn.)
Public propertyHasValueConstraint
Gets a value indicating ValueConstraint is not null.
(Inherited from BcfColumn.)
Public propertyIncludeInUndo
Gets a value indicating whether the column values are managed by undo-redo.
(Inherited from BcfColumn.)
Public propertyIndex
Gets the zero-based index of the column in the Table.Columns-collection.
(Inherited from BcfColumn.)
Public propertyIsChildKeyColumn
Gets a value indicating the column is part of a child-key.
(Inherited from BcfColumn.)
Public propertyIsDefined
Gets a value indicating this column is explicit defined in Columns. Columns added by optimizer (AllowOptimize) will return false.
(Inherited from BcfColumn.)
Public propertyIsKeyColumn
Gets a value indicating the column is part of a relation-key (parent or child) or of tables primary key.
(Inherited from BcfColumn.)
Public propertyIsOptimizerColumn
Gets a value indicating whether this column is created by optimizer or not.
(Inherited from BcfColumn.)
Public propertyIsParentKeyColumn
Gets a value indicating the column is part of a parent-key.
(Inherited from BcfColumn.)
Public propertyIsPrimaryKeyColumn
Gets a value indicating the column is part of tables PrimaryKey.
(Inherited from BcfColumn.)
Public propertyIsRelationKeyColumn
Gets a value indicating the column is part of a relation-key (parent or child).
(Inherited from BcfColumn.)
Public propertyName
Gets the columns name.
(Overrides BcfColumnName.)
Public propertyOptions
Gets or sets the column-options object. The value may be null.
Public propertySequence
Gets or sets the sequence.
(Inherited from BcfColumnT.)
Public propertyShouldPersist
Gets a value indicating whether the column values should be persisted when saving data.
(Inherited from BcfColumn.)
Public propertyTable
Gets the BcfTable the column belongs to.
(Overrides BcfColumnTable.)
Public propertyTrigger
Gets or sets the trigger action.
(Inherited from BcfColumnT.)
Public propertyValueConstraint
Gets or sets the value-constraint function.
(Inherited from BcfColumnT.)
Public propertyValueType
Gets the type of the cells Value property.
(Inherited from BcfColumn.)
Public propertyValueTypeIsClass
Gets a value indicating ValueType is a class.
(Inherited from BcfColumn.)
Public propertyValueTypeIsNotNullableStruct (Inherited from BcfColumn.)
Public propertyValueTypeIsNullableStruct (Inherited from BcfColumn.)
Top
Methods
  NameDescription
Public methodCompareContent
Compares two values using ContentEqualityComparison if set; otherwise EqualityComparer.
(Inherited from BcfColumnT.)
Public methodConvertAndFormat
Converts and formats the specified value as configured in Converter and Formatter and returns the result.
(Inherited from BcfColumnT.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFormatValue
Returns the formatted value. If no formatter specified on this column value will be returned.
(Inherited from BcfColumnT.)
Public methodGetDefaultValue
Get the DefaultValue as object.
(Inherited from BcfColumnT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextFromSequenceOrDefaultValue
Gets the next value from Sequence or if sequence is null the columns default value.
(Inherited from BcfColumnT.)
Public methodGetOptions
Gets the column-options object.
(Overrides BcfColumnGetOptions.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetOptions
Sets the column-options.
(Overrides BcfColumnSetOptions(Object).)
Public methodToString
Returns Name
(Inherited from BcfColumn.)
Public methodTryConvertAndFormat
Try to converts and formats the specified value as configured in Converter and Formatter.
(Inherited from BcfColumnT.)
Public methodTryConvertAndFormatObject
Tries to convert and format the specified value as configured in Converter and Formatter.
(Inherited from BcfColumn.)
Top
See Also