FieldAttribute Members

NFX Class Library

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

The FieldAttribute type exposes the following members.

Constructors

	Name	Description
	FieldAttribute(Type)	Initializes a new instance of the FieldAttribute class
	FieldAttribute(JSONDataMap, String, StoreFlag, Boolean, DataKind, Boolean, Boolean, Object, Object, Object, Int32, Int32, CharCase, String, String, String, String, Boolean, String, String, String)	Used for injection of pre-parsed value list
	FieldAttribute(String, StoreFlag, Boolean, DataKind, Boolean, Boolean, String, Object, Object, Object, Int32, Int32, CharCase, String, String, String, String, Boolean, String, String, String, Boolean)	Initializes a new instance of the FieldAttribute class
	FieldAttribute(Type, String, String, Object, Object, Object, Object, Object, String, Object, Object, Object, Object, Object, Object, String, String, String, String, Object, String, String, String, Object)	Initializes a new instance of the FieldAttribute class

Methods

	Name	Description
	Equals	(Overrides Attribute Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	(Overrides Attribute GetHashCode .)
	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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ParseValueList	Returns a ValueList parsed into key values as: val1: descr1,val2: desc2...
	ParseValueListString	Returns a string parsed into key values as: val1: descr1,val2: desc2...
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	BackendName	Provides an overriden name for this field
	BackendType	Provides an overriden type for this field in backend, i.e. CLR string may be stored as ErlPid in erlang
	CharCase	Controls character casing of textual fields
	CloneFromRowType	When set, points to a Typed-Row derivative that is used as a full clone
	Default	Provides default value
	Description	Provides description
	DisplayFormat	Display format string or null
	FormatDescription	Description for regular expression used for field format validation if set
	FormatRegExp	Regular expression used for field format validation if set
	IsArow	True if this field definition is used by Arow serializer
	Key	Determines whether this field is a part of the primary key
	Kind	Provides hint/classification for textual field data
	m_MetadataContent	(Inherited from TargetedAttribute.)
	Max	Provides high-bound validation check
	MaxLength	Imposes a limit on maximum amount of characters in a textual field
	Min	Provides low-bound validation check
	MinLength	Imposes a limit on minimum amount of characters in a textual field
	NonUI	If true indicates that this field is ignored when generating UI and ignored when UI supplies the value to the server. Pass true to protect server-only structures from being modified by client
	Required	Determines whether the field must have data
	StoreFlag	Determines whether field should be loaded/stored from/to storage
	TargetName	Returns the name of target, i.e. the name of database engine i.e. "ORACLE11g" or "MySQL" (Inherited from TargetedAttribute.)
	ValueList	Returns a ";/,/\|"-delimited list of permitted field values - used for lookup validation
	Visible	Determines whether the field is shown to user (i.e. as a grid column)

Properties

	Name	Description
	HasValueList	Returns true if the value list is set or internal JSONDataMap is set
	Metadata	Returns structured metadata or null if there is no metadata defined (Inherited from TargetedAttribute.)
	MetadataContent	Returns metadata content string in Laconic format or null. Root not is not specified. I.e.: 'a=1 b=true c{...}' (Inherited from TargetedAttribute.)
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)