GetPagesWithFilterScheme Method

In This Topic

Returns Eplan.EplApi.DataModel.Pages matching the given filter from the pages navigator (user settings) or, if no filter is given, the filter created using the project settings.

Syntax

C#
C++/CLI

public Page[] GetPagesWithFilterScheme( 
   string strFilterScheme
)

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

Parameters

strFilterScheme: Scheme name of filter from the page navigator

Return Value

• If scheme name is empty, the current filter scheme will be used.
• If scheme name is NULL, the method returns elements that are visible if no filter scheme is used in a GUI navigator.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown if internally used query throws exception.
System.ArgumentException	Thrown if filter scheme does not exist.
System.ArgumentNullException	Thrown if strFilterScheme is set to NULL.

Remarks

• Note: Different Eplan versions can produce different results when using page filters.
• For further information, please refer to the PagesFilter chapter.
• If you have an old page filter scheme (list with preselection) and a new filter scheme with 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

Use the Eplan Global Support Portal for feedback and support