Functions3DFilter Class

In This Topic

Represents data used for filtering Eplan.EplApi.DataModel.E3D.Function3D by DMObjectsFinder

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.AbstractDMObjectFilter
      Eplan.EplApi.DataModel.StorableObjectsFilter
         Eplan.EplApi.DataModel.Placements3DFilter
            Eplan.EplApi.DataModel.Functions3DFilter

Syntax

C#
C++/CLI

public class Functions3DFilter : Placements3DFilter

public ref class Functions3DFilter : public Placements3DFilter

Example

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

MultiLangString mlsTestValue = new MultiLangString();
mlsTestValue.AddString(ISOCode.Language.L_de_DE, "Test043c");
string strPropertyIdentyfingName = "Page.Test043c";
UserDefinedPropertyDefinition oUDPD = UserDefinedPropertyDefinition.Create(m_oProject, strPropertyIdentyfingName, UserDefinedPropertyDefinition.Enums.ClientType.Page);

//set test property
Page oPage = m_oProject.Pages[0];
oPage.Properties[strPropertyIdentyfingName] = mlsTestValue;

//search page with property value
DMObjectsFinder oFinder = new DMObjectsFinder(m_oProject);
PagesFilter oPagesFilter = new PagesFilter();
PagePropertyList oPagePropertyList = new PagePropertyList();
AnyPropertyId oAnyPropertyId = new AnyPropertyId(m_oProject, strPropertyIdentyfingName);
oPagePropertyList[oAnyPropertyId] = mlsTestValue;
oPagesFilter.SetFilteredPropertyList(oPagePropertyList);
Page[] arrPages1 = oFinder.GetPages(oPagesFilter);

Public Constructors

	Name	Description
	Functions3DFilter Constructor	Default constructor.

Top

Public Properties

	Name	Description
	FunctionCategory	Gets/Sets the filter's category (Inherited from Eplan.EplApi.DataModel.Placements3DFilter)
	InstallationSpace	Sets the Eplan.EplApi.DataModel.E3D.InstallationSpace that Eplan.EplApi.DataModel.E3D.Placement3Ds matching the filter must be placed in. (Inherited from Eplan.EplApi.DataModel.Placements3DFilter)
	Page	Sets the Page that StorableObjects matching the filter must be placed on. (Inherited from Eplan.EplApi.DataModel.StorableObjectsFilter)
	Parent	Sets the Eplan.EplApi.DataModel.E3D.Placement3D for which all children will be found. (Inherited from Eplan.EplApi.DataModel.Placements3DFilter)
	Recursive	Gets a value indicating whether DMObjectsFinder search for children recursively traversing from parent down. (Inherited from Eplan.EplApi.DataModel.Placements3DFilter)

Top

Public Methods

	Name	Description
	Dispose()	Destructor for deterministic finalization of Functions3DFilter object. (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
	ResetFilter	Resets the filter. Filter matches all StorableObjects then. (Inherited from Eplan.EplApi.DataModel.StorableObjectsFilter)
	SetFilteredPropertyList	Overloaded. Sets the Eplan.EplApi.DataModel.E3D.Placement3DPropertyList that will be used for searching Eplan.EplApi.DataModel.E3D.Placement3D. (Inherited from Eplan.EplApi.DataModel.Placements3DFilter)

Top

Reference

Functions3DFilter Members
Eplan.EplApi.DataModel Namespace

Send Feedback