IcxFilterControl.GetFieldName(Integer) Method

Returns the FieldNames property value.

Declaration

function GetFieldName(Index: Integer): string;

Parameters

Name	Type
Index	Integer

Returns

Type
string

Remarks

This method is designed to be a ‘read’ method of the FieldNames property. When implemented, it returns the name of a filter item specified by the Index parameter. Item indexing must be zero-based. The filter items are either the items declared explicitly or the data items (such as fields, columns) available for filtering. For instance, a data bound filter control (the TcxDBFilterControl type) implements this method in the following way. First, it checks from which object field names must be obtained. If there are explicitly declared filter items in the Items property, it returns the value of the FieldName property of the specified filter item. Otherwise, its return value is the name of the specified field from a dataset object linked to the filter control via the DataSet property.