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

In This Topic
    PlanningSegmentsFilter Class
    In This Topic
    This class represents filter for Eplan.EplApi.DataModel.Planning.SegmentDefinitions objects.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.AbstractDMObjectFilter
          Eplan.EplApi.DataModel.StorableObjectsFilter
             Eplan.EplApi.DataModel.PlanningSegmentsFilter

    Syntax
    public class PlanningSegmentsFilter : StorableObjectsFilter 
    public ref class PlanningSegmentsFilter : public StorableObjectsFilter 
    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 PropertyValue compared with property DMPLAOBJECT_FULLDESIGNATION while searching for planning segments.  
    Public PropertySets the Page that StorableObjects matching the filter must be placed on. (Inherited from Eplan.EplApi.DataModel.StorableObjectsFilter)
    Top
    Public Methods
     NameDescription
    Public MethodDestructor (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
    Public MethodOverridden. Resets the filter. Filter matches all StorableObjects then.  
    Public MethodOverloaded. Sets the Eplan.EplApi.DataModel.Planning.PlanningSegmentPropertyList that Eplan.EplApi.DataModel.Planning.PlanningSegments matching the filter must have.  
    Top
    See Also