PlacementsFilter Class

In This Topic

This class represents filter for Placements objects.

The PlacementsFilter can be accessed as a property of a Page object or can be used as a parameter for DMObjectsFinder.

Inheritance Hierarchy

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

Syntax

C#
C++/CLI

public class PlacementsFilter : StorableObjectsFilter

public ref class PlacementsFilter : public StorableObjectsFilter

Example

DMObjectsFinder oFinder = new DMObjectsFinder(m_oTestProject);
PlacementsFilter oFilter = new PlacementsFilter();
oFilter.Page = m_oTestProject.Pages[10];
Placement[] oP = oFinder.GetPlacements(oFilter);

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
	PlacementsFilter Constructor	Overloaded.

Top

Public Properties

	Name	Description
	Page	Overridden. Sets the Page that StorableObjects matching the filter must be placed on.

Top

Public Methods

	Name	Description
	Dispose()	Destructor (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
	ResetFilter	Overridden. Resets the filter. Filter matches all Placements then.
	SetFilteredPropertyList	Overloaded. Sets the PlacementPropertyList that Placements matching the filter must have.

Top

Reference

PlacementsFilter Members
Eplan.EplApi.DataModel Namespace
DMObjectsFinder Class
Placement Class

Send Feedback