StorableObjectsFilter Class

In This Topic

This class represents filter for StorableObjects objects.

The StorableObjectsFilter 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.Placements3DFilter
         Eplan.EplApi.DataModel.PlacementsFilter
         Eplan.EplApi.DataModel.PlanningSegmentsFilter
         Eplan.EplApi.DataModel.SegmentDefinitionsFilter
         Eplan.EplApi.DataModel.SegmentTemplatesFilter

Syntax

C#
C++/CLI

public class StorableObjectsFilter : AbstractDMObjectFilter

public ref class StorableObjectsFilter : public AbstractDMObjectFilter

Example

DMObjectsFinder oFinder = new DMObjectsFinder(m_oTestProject);
StorableObjectsFilter oFilter = new StorableObjectsFilter();
oFilter.Page = m_oTestProject.Pages[10];
StorableObject[] oSO = oFinder.GetStorableObjects(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
	StorableObjectsFilter Constructor	Overloaded.

Top

Public Properties

	Name	Description
	Page	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 StorableObjects then.
	SetFilteredPropertyList	Sets the StorableObjectPropertyList that StorableObjects matching the filter must have.

Top

Reference

StorableObjectsFilter Members
Eplan.EplApi.DataModel Namespace
DMObjectsFinder Class
StorableObject Class

Send Feedback