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

InterruptionPointsFilter Class
This class represents filter of InterruptionPoint and derived from it classes. The InterruptionPointsFilter 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.InterruptionPointsFilter

Syntax
public class InterruptionPointsFilter : PlacementsFilter 
Example
DMObjectsFinder oFinder = new DMObjectsFinder(m_oTestProject);
InterruptionPointsFilter oIPFilter = new InterruptionPointsFilter();
oIPFilter.Name = "IP";
InterruptionPoint[] oIPTs = oFinder.GetInterruptionPoints(oIPFilter);

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 if the filtered function, when is filtered by name, should be matched exactly, it means that if searched name is only its name' prefix, it is not matching to the filter. Dafault this property is false.  
Public PropertyReturns the name that was set to this filter.  
Public PropertyOverridden. Sets the Page that StorableObjects matching the filter must be placed on.  
Top
Public Methods
 NameDescription
Public Method (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
Public MethodOverridden. Resets the filter. Filter matches all StorableObjects then.  
Public MethodOverloaded. Sets the InterruptionPointPropertyList that InterruptionPoints matching the filter must have.  
Top
See Also