FunctionsFilter Class

In This Topic

This class represents a filter of Functions and derived classes. The FunctionsFilter can be accessed as a property of a Page object or can be used as a parameter for the DMObjectsFinder. Specifying more than one matching criterion for the filter (for example, the page on which the matching functions must be placed and the category of the matching functions) causes the returned functions to match both conditions.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.AbstractDMObjectFilter
      Eplan.EplApi.DataModel.StorableObjectsFilter
         Eplan.EplApi.DataModel.PlacementsFilter
            Eplan.EplApi.DataModel.FunctionsFilter

Syntax

C#
C++/CLI

public class FunctionsFilter : PlacementsFilter

public ref class FunctionsFilter : public PlacementsFilter

Example

This example shows how to filter functions by category:

Project myProject = m_oProject; // A valid project
Page myPage = myProject.Pages[0]; // A valid Page object

// Use a filter to get only functions with category 'Motor'
myPage.Filter.FunctionCategory = Eplan.EplApi.Base.Enums.FunctionCategory.Motor;

// Place all functions with category 'Motor' on page myPage
Function[] functions = myPage.Functions;

// Another way to do the same:
// Use a filter to get only functions with category 'Motor'
FunctionsFilter myFunctionsFilter = new FunctionsFilter();
myFunctionsFilter.FunctionCategory = Eplan.EplApi.Base.Enums.FunctionCategory.Motor;
myFunctionsFilter.Page = myPage;
DMObjectsFinder objFinder = new DMObjectsFinder(myProject);

// Place all functions with category 'Motor' on page myPage
functions = objFinder.GetFunctions(myFunctionsFilter);

The following example shows how to filter by user-defined properties:

Project myProject = m_oProject; // A valid project
Page myPage = myProject.Pages[0]; // A valid Page object

// Define test property
MultiLangString mlsTestValue = new MultiLangString();
mlsTestValue.AddString(ISOCode.Language.L_de_DE, "Test043c");
string strPropertyIdentyfingName = "Page.Test043c";
UserDefinedPropertyDefinition oUDPD = UserDefinedPropertyDefinition.Create(myProject, strPropertyIdentyfingName, UserDefinedPropertyDefinition.Enums.ClientType.Page);

// Set test property on myPage
myPage.Properties[strPropertyIdentyfingName] = mlsTestValue;

// Search page with property value
DMObjectsFinder objFinder = new DMObjectsFinder(myProject);
PagesFilter pagesFilter = new PagesFilter();
PagePropertyList pagePropertyList = new PagePropertyList();
AnyPropertyId anyPropertyId = new AnyPropertyId(myProject, strPropertyIdentyfingName);

pagePropertyList[anyPropertyId] = mlsTestValue;
pagesFilter.SetFilteredPropertyList(pagePropertyList);
Page[] arrPages1 = objFinder.GetPages(pagesFilter);

Public Constructors

	Name	Description
	FunctionsFilter Constructor	Overloaded.

Top

Public Properties

	Name	Description
	ExactNameMatching	Gets/Sets if the filtered function, when it is filtered by name, should be matched exactly. This means that if the searched name is only its prefix of the name, it will not match the filter. By default, this property is `FALSE`.
	FunctionCategory	Gets/Sets the filter category
	IsPlaced	Gets/Sets if the filtered function should be placed (i.e. should be located on a valid page).
	Name	Gets/Sets the name that was set to this filter.
	Page	Overridden. Sets the Page that StorableObjects matching the filter must be placed on.

Top

Public Methods

	Name	Description
	Dispose()	Destructor for deterministic finalization of `FunctionFilter` object. (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
	ResetFilter	Overridden. Resets the filter. Filter matches all StorableObjects then.
	SetFilteredPropertyList	Overloaded. Sets the P8 properties of the `Function`. Any function whose property values match those in this list will be considered by the `FunctionsFilter` and vice versa: Any function whose property values do NOT match those in this list will be filtered out by the `FunctionsFilter`.
	SetIdentifyingPropertyList	Overloaded. Sets the properties of the identifying elements of the `Function` structure identifiers. Any function whose property values match those in this list will be considered by the `FunctionsFilter` and vice versa: Any function whose property values do NOT match those in this list will be filtered out by the `FunctionsFilter`.

Top

Reference

FunctionsFilter Members
Eplan.EplApi.DataModel Namespace
DMObjectsFinder Class
Page Class

Use the Eplan Global Support Portal for feedback and support