Eplan Platform API
Eplan.EplApi.DataModel Namespace / StorableObjectsFilter Class
Members Example

StorableObjectsFilter Class
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
Syntax
public class StorableObjectsFilter : 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
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
 NameDescription
Public ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertySets the Page that StorableObjects matching the filter must be placed on.  
Top
Public Methods
 NameDescription
Public MethodDestructor (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
Public MethodOverridden. Resets the filter. Filter matches all StorableObjects then.  
Public MethodSets the StorableObjectPropertyList that StorableObjects matching the filter must have.  
Top
See Also