Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Content.Metadata.ICustomFieldHandler Interface Reference

A custom field handler defines the behaviour of a

See Also
MDataType.CUSTOM_STRING

metadata type. More...

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

Public Member Functions

object Parse (object obj)
 Parses any object that can be parsed into the internal representation of this field's data type. More...
 
bool AreEqual (object source, object target)
 Compares two objects for equality assuming that they are already of the internal value of this data type (i.e. parsed). More...
 

Properties

object InitialDefaultValue [get, set]
 Get initial default value for the data type. More...
 

Detailed Description

A custom field handler defines the behaviour of a

See Also
MDataType.CUSTOM_STRING

metadata type.

A single handler may be used for many metadata fields of the same custom data type and must be thread-safe.

Every custom field is represented externally as a string but may use a different type for internal representation as it is more efficient for comparisons.

Member Function Documentation

bool PushTechnology.ClientInterface.Client.Content.Metadata.ICustomFieldHandler.AreEqual ( object  source,
object  target 
)

Compares two objects for equality assuming that they are already of the internal value of this data type (i.e. parsed).

Parameters
sourceThe source object.
targetThe target object.
Returns
true if equal, or false if not equal (or either parameter not of the correct type).
object PushTechnology.ClientInterface.Client.Content.Metadata.ICustomFieldHandler.Parse ( object  obj)

Parses any object that can be parsed into the internal representation of this field's data type.

Parameters
objA value to parse - if null is supplied, then the default value should be returned. This value would typically be of type string but any type should be catered for, and the simplest way of doing this is using the ToString() method of the object that is supplied.
Returns
An object of the type used for internal representation of this data type.

Property Documentation

object PushTechnology.ClientInterface.Client.Content.Metadata.ICustomFieldHandler.InitialDefaultValue
getset

Get initial default value for the data type.

Returns a default value of the internal type for the field data type. The type of the object returned should be the internal representation for the data type.


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