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

In This Topic
    Placements3DFilter Class
    In This Topic
    Represents data used for filtering Eplan.EplApi.DataModel.E3D.Placement3D by DMObjectsFinder
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.AbstractDMObjectFilter
          Eplan.EplApi.DataModel.StorableObjectsFilter
             Eplan.EplApi.DataModel.Placements3DFilter
                Eplan.EplApi.DataModel.Functions3DFilter

    Syntax
    public class Placements3DFilter : StorableObjectsFilter 
    public ref class Placements3DFilter : public StorableObjectsFilter 
    Example
    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 ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets/Sets the filter's category  
    Public PropertySets the Eplan.EplApi.DataModel.E3D.InstallationSpace that Eplan.EplApi.DataModel.E3D.Placement3Ds matching the filter must be placed in.  
    Public PropertySets the Page that StorableObjects matching the filter must be placed on. (Inherited from Eplan.EplApi.DataModel.StorableObjectsFilter)
    Public PropertySets the Eplan.EplApi.DataModel.E3D.Placement3D for which all children will be found.  
    Public PropertyGets a value indicating whether DMObjectsFinder search for children recursively traversing from parent down.  
    Top
    Public Methods
     NameDescription
    Public MethodDestructor for deterministic finalization of Placement3DFilter object. (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
    Public MethodResets the filter. Filter matches all StorableObjects then. (Inherited from Eplan.EplApi.DataModel.StorableObjectsFilter)
    Public MethodOverloaded. Sets the Eplan.EplApi.DataModel.E3D.Placement3DPropertyList that will be used for searching Eplan.EplApi.DataModel.E3D.Placement3D.  
    Top
    See Also