GetPagesWithFilterScheme Method

In This Topic

\Returns Pages matching given filter from pages-navigator(user settings) or if such doesn't exist filter with use of project settings is created. There can be different results when using page filter now and in 1.9 version. For further information please look in P8 help chapter concerning page filter.

Syntax

C#
C++/CLI

public Page[] GetPagesWithFilterScheme( 
   string strFilterScheme
)

public:
array<Page^>^ GetPagesWithFilterScheme( 
   String^ strFilterScheme
)

Parameters

strFilterScheme: Scheme\-name of filter pages\-navigator

Return Value

* if scheme-name is empty, the current filter-scheme will be used. * if scheme-name is null, the method returns elements which are visible when no filter schema is used in a GUI navigator.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when \internal used query throw exception.
System.ArgumentException	Thrown when filter schema does not exist.
System.ArgumentNullException	Thrown if strFilterScheme is set to null.

Remarks

If you have an old page filter scheme (List with preselection) and a new filter scheme wit the same name, this method will use the new one. In case of an old filter scheme, the scheme is always the one for the pre-filter.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Page Class

Send Feedback