API Help
Eplan.EplApi.DataModel Namespace / SegmentPlacementsFilter Class
Members Example

In This Topic
    SegmentPlacementsFilter Class
    In This Topic
    This class represents filter of Eplan.EplApi.DataModel.Planning.SegmentPlacement and derived from it classes.
    Inheritance Hierarchy

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

    Syntax
    public class SegmentPlacementsFilter : PlacementsFilter 
    public ref class SegmentPlacementsFilter : public PlacementsFilter 
    Example
    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
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyOverridden. Sets the Page that StorableObjects matching the filter must be placed on.  
    Top
    Public Methods
    See Also