Interface IStonefieldQueryValueConverterPlugin

The interface that Value Converter plugins must implement.


public abstract interface IStonefieldQueryValueConverterPlugin

Remarks

Plugin classes implementing this interface must have an attribute that implements IStonefieldQueryValueConverterPluginMetaData.

Interface Members

MemberDescription

Convert

Converts the specified value from the database to the value to be displayed.

public object Convert(object value);

public object Convert(object value,
    DataRow row);

ConvertBack

Converts the specified display value to the value for a WHERE clause.

public object ConvertBack(object value);

GetConvertedValuesList

Returns a list of possible values for this converter if IsListType returns true.

public IList GetConvertedValuesList();

IsListType

Returns true if this converter contains its own list of values.

public bool IsListType();

Reset

Resets the converter.

public void Reset();

AliasList

A list of aliases for the fields that have been retrieved from the database. If it was necessary to rename a field this list will contain the corresponding column name for that field in the passed-in DataRow.

DataEngine

A reference to a DataEngine that can be used to query the database.

DatasourceName

The name of the data source Stonefield Query is currently connected to.

Field

A reference to the field this is a converter for.

Report

A reference to the report being run.

Requirements

Namespace: Stonefield.Query.Plugins
Assembly: interfaces.dll