Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField Interface Reference

More...

Inheritance diagram for PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField:
PushTechnology.DiffusionCore.Messaging.Data.metadata.IMNode PushTechnology.DiffusionCore.Messaging.Data.metadata.MFieldImpl PushTechnology.DiffusionCore.Messaging.Data.metadata.MFieldCustomString PushTechnology.DiffusionCore.Messaging.Data.metadata.MFieldDecimalString PushTechnology.DiffusionCore.Messaging.Data.metadata.MFieldIntegerString PushTechnology.DiffusionCore.Messaging.Data.metadata.MFieldString

Public Member Functions

void SetDefaultValue (object value)
 Sets a default value that required occurrences of the field are to be initialised to. More...
 

Properties

MDataType DataType [get]
 Returns the data type of the field. More...
 
object DefaultValue [get]
 Returns the default value that the field should be initialised to. Returns a non-null value used to initialise required fields. The type of the returned object will be the internal representation type for the data type. More...
 
int Scale [get, set]
 Gets/sets the scale of the field. More...
 
bool AllowsEmpty [get, set]
 Indicates whether the field allows an empty value when parsed from string input. More...
 
ICustomFieldHandler CustomFieldHandler [get]
 If the data type is CustomString, then this will return the custom string handler. More...
 

Detailed Description

Member Function Documentation

void PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField.SetDefaultValue ( object  value)

Sets a default value that required occurrences of the field are to be initialised to.

Parameters
valueAn initial value - the object specified will be parsed into the internal type representation for the data type.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.metadata.MFieldImpl.

Property Documentation

bool PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField.AllowsEmpty
getset

Indicates whether the field allows an empty value when parsed from string input.

By default, MDataType.String type fields allow empty input but other types do not. This may be used to change this default behaviour.

When a field allows empty input and an empty (zero length string) is parsed, then its internal representation will be a zero-length string and not an object of the default type for the field.

ICustomFieldHandler PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField.CustomFieldHandler
get

If the data type is CustomString, then this will return the custom string handler.

Returns the custom string handler, or null if this is not a custom type.

MDataType PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField.DataType
get

Returns the data type of the field.

object PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField.DefaultValue
get

Returns the default value that the field should be initialised to. Returns a non-null value used to initialise required fields. The type of the returned object will be the internal representation type for the data type.

Returns
int PushTechnology.DiffusionCore.Messaging.Data.metadata.IMField.Scale
getset

Gets/sets the scale of the field.

The scale is the number of digits to the right of the decimal point for a field of type DecimalString. For non-decimal data types this value is ignored.

When not explicitly set, a value of 2 is assumed.