A string metadata definition. More...

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

Properties
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

A string metadata definition.

This defines an IMField field that is represented as a variable length string of characters. In the simplest case this can contain any unicode characters but subtypes may imply some special meaning and therefore constraints upon the field content.

The field will be represented internally as a string and its byte representation will be whatever is appropriate for encoding of unicode strings for transport.

It is possible to parse the value of an item of this type from any object as the object.ToString() method will be used.

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

var factory = Diffusion.Metadata; var aString = factory.String( "A", "---" );

Alternatively for more complex requirements an IMStringBuilder may be used.

Property Documentation

bool PushTechnology.ClientInterface.Client.Content.Metadata.IMString.AllowsEmpty

get

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

string PushTechnology.ClientInterface.Client.Content.Metadata.IMString.DefaultValue

get

Returns the default value that required occurrences of the field should be initialised to.

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

UCIStack/Client/Content/Metadata/IMString.cs

Properties

Detailed Description

Property Documentation