Filter

_Org_ShowFilter, Org_EnableFilter, Org_ExtentFilter, Org_SetFilter

Org_EnableFilter

This function runs the Tools > Enable Filter command.

Description 

 Org_EnableFilter(
   int  EnableFilter
);

This function enables or disables the already defined filter in the current datasource.

Parameters

int EnableFilter

Specifies whether to enable or disable the current filter of the active datasource.

0

Disable the filter.

1

Enable the filter.

Org_ExtentFilter

Description 

 Org_ExtentFilter(
   int  FilterOperation,
   char *FieldName,
   int  FilterType,
   char *FilterValues1,
   char *FilterValues2
);

Adds new condition to the filter in Organizer.

Parameters

int FilterOperation

Boolean operation between the condition in the new filter and in the active one.

0

Logical OR

1

Logical AND

-1

Replaces the active filter, same as Org_SetFilter

char *FieldName

Name or unique name of the field.

int FilterType

Type of the filter. For field types Text, Multiline Text and External Link the parameter can contain following values:

0

Match from start.

1

Match exact.

2

Match anywhere.

3

Match any word.

4

Match all words.

0

FilterValue is comma separated values of range borders.

1

FilterValue is single value and condition is equal.

0

FilterValue is comma separated values of range borders.

1

FilterValue is single date and condition is equal.

2

FilterValue is single date and number of days before the date, which define range.

3

FilterValue is single date and number of weeks before the date, which define range.

4

FilterValue is single date and number of months before the date, which define range.

char *FilterValues1

Single or comma separated condition values.

char *FilterValues2

Single or comma separated condition values.

Org_SetFilter

Description 

 Org_SetFilter(
   char *FieldName,
   int  FilterType,
   char *FilterValues1,
   char *FilterValues2
);

Sets the filtering condition in the Organizer. To add another condition, use the Org_ExtentFilter function.

Parameters

char *FieldName

Name or unique name of the field.

int FilterType

Type of the filter.

For field types Text, Multiline Text and External Link the parameter can contain following values:

0

Match from start.

1

Match exact.

2

Match anywhere.

3

Match any word.

4

Match all words.

For field types Number and Decimal Number the parameter can contain following values:

0

FilterValue is comma separated values of range borders.

1

FilterValue is single value and condition is equal.

For field type Date the parameter can contain following values:

0

FilterValue is comma separated values of range borders.

1

FilterValue is single date and condition is equal.

2

FilterValue is single date and number of days before the date, which define range.

3

FilterValue is single date and number of weeks before the date, which define range.

4

FilterValue is single date and number of months before the date, which define range.

For other field types this parameter has no sense.

char *FilterValues1

Single or comma separated condition values.

char *FilterValues2

Single or comma separated condition values.

_Org_ShowFilter

This function runs the Tools > Define Filter command.

Description 

 _Org_ShowFilter();

This function displays the Filter dialog box to enable specify filter for the current datasource images.