Skip to content

RemoveFilter - cDRReport

Methods - Properties - Events

Method Type

Function

Return Type

Boolean

Arguments

Argument Description
sReportID ID of the report. Can be ID of the main report or the ID of a sub-report. This argument can be passed as an empty string, which can be represented as C_USEMAINDRREPORTID.
iFilter The N-th filter defined in the report.

Description

Removes the specified filter number from the filters defined by the filter expert or added via AddFilter in the report. Filters start counting from 0.

The function returns true when the action is successful.

If a filter number that does not exist is passed, the action will be ignored, and no error will be given.

This method cannot be used before the report OCX object is initialized. The COM object creation is performed as part of the OpenReport method if it has not been done previously.

DataFlex Framework usage

  • Web
  • Windows
  • FlexTron

Sample

Object oReport is a cDRReport
    Set psReportName to 'MyReport.dr'
End_Object

Object oRunReportButton is a Button
    Set Label to 'Run Report'

    Procedure OnClick
        Boolean bDone
        String sReportId

        Get OpenReport of oReport to sReportId
        If (sReportId <> '') Begin
            // The following instruction assumes there is a filter defined
            Get RemoveFilter Of oReport sReportId 0 to bDone
            Send OutputReport of oReport
            Send CloseReport of oReport sReportId
        End
    End_Procedure
End_Object