FieldDataTypeAttribute Class

Defines an attribute that will request use of a specific data type on a modeled table field. Typically only needed to enforce use of a specific DbType for parameters.

Inheritance Hierarchy

SystemObject
SystemAttribute
GSF.Data.ModelFieldDataTypeAttribute

Namespace: GSF.Data.Model
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.248-beta+a497a19de709fd99e2448886199a2c8824265ddf

Syntax

C++

JavaScript

Copy

[AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple = true)]
public sealed class FieldDataTypeAttribute : Attribute

<AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple := true)>
Public NotInheritable Class FieldDataTypeAttribute
	Inherits Attribute

[AttributeUsageAttribute(AttributeTargets::Property, AllowMultiple = true)]
public ref class FieldDataTypeAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple = true)>]
type FieldDataTypeAttribute = 
    class
        inherit Attribute
    end

GSF.Data.Model.FieldDataTypeAttribute = function();

Type.createClass(
	'GSF.Data.Model.FieldDataTypeAttribute',
	Attribute);

View Source

The FieldDataTypeAttribute type exposes the following members.

Constructors

	Name	Description
	FieldDataTypeAttribute(DbType)	Creates a new FieldDataTypeAttribute that will request use of specific DbType.
	FieldDataTypeAttribute(DbType, DatabaseType)	Creates a new FieldDataTypeAttribute that will request use of specific DbType for the specified DatabaseType.

Top

Properties

	Name	Description
	FieldDataType	Gets field data type that determines which DbType should be used when using database command operations.
	TargetDatabaseType	Gets target DatabaseType for this FieldDataTypeAttribute.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

Applying this attribute to a modeled table field with no database type parameter will specify that the field data type be used for all database types. Using a specific database type as a parameter to the attribute, e.g., [FieldDataType(DbType.DateTime2, DatabaseType.SQLServer)], means the field data type will only be applied to the specific database - however, the attribute allows multiple instances on the same identifier so you could specify different field data types for different database types. When multiple instances of the attribute are applied to the same identifier, the first attribute encountered that does not target a specific database will be considered the default value for all non-specified database types.

Reference

GSF.Data.Model Namespace