Decimal string field metadata. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Content.Metadata.IMDecimalString:

Properties
int	Scale `[get]`
	Returns the scale of the field. More...

Properties inherited from PushTechnology.ClientInterface.Client.Content.Metadata.IMString
string	DefaultValue `[get]`
	Returns the default value that required occurrences of the field should be initialised to. More...

bool	AllowsEmpty `[get]`
	Indicates whether the field allows an empty value when parsd from string input. More...

Properties inherited from PushTechnology.ClientInterface.Client.Content.Metadata.IMField
MFieldType	FieldType `[get]`
	Returns the data type of the field. More...

Properties inherited from PushTechnology.ClientInterface.Client.Content.Metadata.IMNode
string	Name `[get]`
	Returns the node name. More...

MetadataNodeType	NodeType `[get]`
	Returns the node type. More...

MNodeDataType	DataType `[get]`
	Returns the data type of the node implementation. More...

string	FullName `[get]`
	Returns the full name of the node defining its hierarchy. More...

Multiplicity	Multiplicity `[get]`
	Returns the node's multiplicity within its parent. More...

IMGroup	Parent `[get, set]`
	Returns the parent record (or message). More...

Detailed Description

Decimal string field metadata.

This defines an IMString field containing a decimal number representation.

A decimal number has an optional decimal point and is parsed, compared and output according to the scale (the number of digits to the right of the decimal point) of the field.

Represented internally as a decimal.

It is possible to parse the value of an item of this type from any object whose object.ToString method returns a value that can be successfully supplied to the decimal constructor. In addition, if the field IMString.AllowsEmpty permits it then an empty field (zero length string) could also be parsed.

The easiest way to create a decimal metadata field is using IMetadataFactory.Decimal(string) or one of its variants that allow an initial value to be supplied. For example:

var factory = Diffusion.Metadata; var dec = factory.Decimal( "A", 2.00);

Alternatively for more complex requirements an IMDecimalStringBuilder may be used.

Property Documentation

int PushTechnology.ClientInterface.Client.Content.Metadata.IMDecimalString.Scale

get

Returns the scale of the field.

The scale is the number of digits to the right of the decimal point.

The documentation for this interface was generated from the following file:

LegacyModule/Client/Content/Metadata/IMDecimalString.cs

Properties

Detailed Description

Property Documentation