Programming Mechworks PDM > .NET API > MwPDMApi Namespace > Database Class > Database Methods

It makes available from the command shell interface the Filter functionality available in the browser Document and Query pages.

Namespace: MwPDMApi
Assembly: MwPDMApi (in MwPDMApi.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Visual Basic
Public Sub Filter ( _ filterName As String, _ filterQuery As String, _ gridType As DocType, _ filterAllTables As Boolean, _ filterAllDatabase As Boolean _ )

Visual Basic

Public Sub Filter ( _

filterName As String, _
filterQuery As String, _
gridType As DocType, _
filterAllTables As Boolean, _
filterAllDatabase As Boolean _
)

C#
public void Filter( string filterName, string filterQuery, DocType gridType, bool filterAllTables, bool filterAllDatabase )

public void Filter(

string filterName,
string filterQuery,
DocType gridType,
bool filterAllTables,
bool filterAllDatabase
)

Visual C++
public: void Filter( String^ filterName, String^ filterQuery, DocType gridType, bool filterAllTables, bool filterAllDatabase )

Visual C++

public:

void Filter(
String^ filterName,
String^ filterQuery,
DocType gridType,
bool filterAllTables,
bool filterAllDatabase
)

JavaScript
function filter(filterName, filterQuery, gridType, filterAllTables, filterAllDatabase);

Parameters

filterName

Type: System.String
the title of the filter query; a fle with name _filter title_.TXT will be created in the %TEMP% directory

filterQuery

Type: System.String
filter query, it must be of the syntax valid for the WHERE clause of the SQL language

gridType

Type: MwPDMApi.DocType
if NONE, sets the Query Page as active and applies the filter to the Generic grid, otherwise sets the Document Page as active page and applies the filter to the given type grid

filterAllTables

Type: System.Boolean
if TRUE it applies the filter to all the grid indipendently from the value in type, FALSE it applies the filter only to the grid specified in type parameter

filterAllDatabase

Type: System.Boolean
if TRUE it applies the filter to all databases, FALSE it applies the filter only to the current recordset loaded in the browser

Remarks