OpenTap.IStringConvertProvider Interface Reference

Plugin interface for string convert providers. More...

Inheritance diagram for OpenTap.IStringConvertProvider:

Public Member Functions
string	GetString (object value, CultureInfo culture)
	Returns a string when the implementation supports converting the value. Otherwise, returns null.
object	FromString (string stringData, ITypeData type, object contextObject, CultureInfo culture)
	Creates an object from stringdata. The returned object should be of type 'type'. Returns null if it cannot convert stringdata to type.

Detailed Description

Plugin interface for string convert providers.

FromString(GetString(value), value.GetType()) shall always return a non-null value, if GetString(value) returns a non-null value.

Member Function Documentation

FromString()

object OpenTap.IStringConvertProvider.FromString	(	string	stringData,
		ITypeData	type,
		object	contextObject,
		CultureInfo	culture )

Creates an object from stringdata. The returned object should be of type 'type'. Returns null if it cannot convert stringdata to type.

Parameters

stringData
type
contextObject	The object on which the value is set.
culture	The culture used for the conversion. This value can will default to InvariantCulture if nothing else is selected.

Returns

GetString()

string OpenTap.IStringConvertProvider.GetString	(	object	value,
		CultureInfo	culture )

Returns a string when the implementation supports converting the value. Otherwise, returns null.

Parameters

value	Cannot be null.
culture	The culture used for the conversion.

Returns