Schema.FieldDef Members

Schema FieldDef Members

NFX Class Library

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

The Schema FieldDef type exposes the following members.

Constructors

	Name	Description
	Schema FieldDef(SerializationInfo, StreamingContext)	Initializes a new instance of the Schema FieldDef class
	Schema FieldDef(String, Type, FieldAttribute)	Initializes a new instance of the Schema FieldDef class
	Schema FieldDef(String, Type, QuerySource ColumnDef)	Initializes a new instance of the Schema FieldDef class
	Schema FieldDef(String, Type, IEnumerable FieldAttribute )	Initializes a new instance of the Schema FieldDef class
	Schema FieldDef(String, Int32, Type, IEnumerable FieldAttribute , PropertyInfo)	Initializes a new instance of the Schema FieldDef class

Methods

	Name	Description
	Equals	(Overrides Object 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.)
	GetBackendNameForTarget(String)	Returns the name of the field in backend that was possibly overriden for a particular target
	GetBackendNameForTarget(String, FieldAttribute )	Returns the name of the field in backend that was possibly overriden for a particular target along with store flag
	GetHashCode	(Overrides Object GetHashCode .)
	GetObjectData
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	(Overrides Object ToString .)
	ValueDescription	For fields with ValueList returns value's description per specified schema
	WriteAsJSON	Writes fielddef as JSON. Do not call this method directly, instead call rowset.ToJSON() or use JSONWriter class

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
	m_Order

Properties

	Name	Description
	AnyTargetKey	Returns true when this field is attributed as being a key field in an attribute that targets ANY_TARGET
	AnyVisible	Returns true when this field is attributed as being a visible in any of the targeted attribute
	Attrs	Returns field attributes
	Description	Returns description from field attribute or parses it from field name
	Item	Returns a FieldAttribute that matches the supplied targetName, or if one was not defined then returns FieldAttribute which matches any target or null
	MemberInfo	For TypedRow-descendants returns a PropertyInfo object for the underlying property
	Name	Returns the name of the field
	NonNullableType	For nullable value types returns the field type regardless of nullability, it is the type argument of Nullable struct; For reference types returns the same type as Type property
	NonUI	Returns true when at least one attribute was marked as NonUI - meaning that this field must not be serialized-to/deserialized-from client UI
	Order	Gets absolute field order index in a row
	Type	Returns the field type