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

In This Topic
    DMObjectsFinder Class
    In This Topic
    This class allows you to search the Project. It defines a set of methods for retrieving different API objects. If you want the result objects to match one or more conditions, you should use filters.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.DMObjectsFinder

    Syntax
    public class DMObjectsFinder 
    public ref class DMObjectsFinder 
    Remarks
    List of Function3D classes with their corresponding FunctionCategories:
    Area - AreaDefinition
    BusBar - CabMechBusBar
    Duct - CabMechConduit
    MountingRail - CabMechBodyAccessoryInside
    BusBarSystem - CabVirtBusbarsystem
    Cabinet - CabMechCabinet
    Component - ArticlePlacement, CabMechHousing, CabMechSystemAccessory
    CopperBundle - CabVirtCopperbundle
    Drilling - CabVirtNC
    InstallationSpace - AreaDefinition
    MountingPanel - CabMechHousing
    RoutingAccessory - CabMechRoutingAccessory
    RoutingSegment - Routing
    RoutingSpline - Routing
    Example
    The following example shows how to search a project using the DMObjectsFinder class and how to filter your search results:
    Project myProject = m_oProject; // A valid project
    Page myPage = myProject.Pages[0]; // A valid Page object
    
    DMObjectsFinder objFinder = new DMObjectsFinder(myProject);
    
    // Get all functions in the myProject Project
    Function[] functions = objFinder.GetFunctions(null);
    
    // Use a filter to get only functions with category 'Motor'
    FunctionsFilter myFunctionsFilter = new FunctionsFilter();
    myFunctionsFilter.FunctionCategory = Eplan.EplApi.Base.Enums.FunctionCategory.Motor;
    myFunctionsFilter.Page = myPage;
    
    // Place all functions with category 'Motor' on page myPage
    functions = objFinder.GetFunctions(myFunctionsFilter);
    
    
    
    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Methods
     NameDescription
    Public MethodDestructor  
    Public Method  
    Public MethodReturns ArticleReferences matching given filter.  
    Public MethodReturns ArticleReferences matching given filter.  
    Public MethodReturns ArticleReferences matching given filter from bill of materials-navigator.  
    Public MethodReturns BoxedDevices matching given filter.  
    Public MethodReturns BoxedDevices matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Cables and shieldings (Functions with category Shielding) matching given filter from cables-navigator.  
    Public MethodReturns Connections matching given filter. If null parameter is passed, all the project's connection objects are returned. Note: In case no filter used, number of objects returned may be bigger than the number of connections visible in the GUI's connection navigator. The GUI's connection navigator by default shows connections of the following placement types only: - Circuit - CircuitSingleLine - Overview - PairCrossReference - ProcessAndInstrumentationDiagram - PanelLayout  
    Public MethodReturns Connections matching given filter.  
    Public MethodReturns Connections matching given filter from connections-navigator.  
    Public MethodOverloaded. Returns Functions matching given filter. If "bWithConnectionDefinitionPoints" is true, returns ConnectionDefinitionPoints matching given filter, too.  
    Public MethodReturns Eplan.EplApi.DataModel.E3D.Function3Ds matching given filter.  
    Public MethodReturns Functions matching given custom filter.  
    Public MethodReturns Function matching given filter from devices-navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Harnesses matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Harnesses matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Harnesses matching given filter from wire harness navigator.  
    Public MethodReturns Functions matching given filter.  
    Public MethodReturns Functions matching given custom filter.  
    Public MethodReturns InterruptionPoints matching given filter from interruptionpoints-navigator.  
    Public MethodThis function takes objects of class NetDefinitionPoint and filters them with the given filter.  
    Public MethodReturns all items from the list tab of a navigator.  
    Public MethodReturns Options matching given filter from project-options-navigator.  
    Public MethodReturns Pages matching given filter.  
    Public MethodReturns Pages matching given filter.  
    Public Method\Returns Pages matching given filter from pages-navigator(user settings) or if such doesn't exist filter with use of project settings is created. There can be different results when using page filter now and in 1.9 version. For further information please look in P8 help chapter concerning page filter.  
    Public MethodReturns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D from project.  
    Public MethodReturns Eplan.EplApi.DataModel.Graphics.PlaceHolders matching given filter from placeholders-navigator.  
    Public MethodThis function takes objects of classes Placement and inherited from Placement except Page and filters them with the given filter. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding). This method does not return Eplan.EplApi.DataModel.Graphics.PropertyPlacement.  
    Public MethodReturns Eplan.EplApi.DataModel.E3D.Placement3Ds matching given filter.  
    Public MethodReturns all objects of classes Placement and inherited from Placement, except Page, which matches to given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.PlanningSegment matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.PlanningSegment matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PLCs matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PLCs matching given filter.  
    Public MethodReturns Functions matching given filter from plc-navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Terminal matching the given filter from PLC navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PlugStrips matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PlugStrips matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PlugStrips matching given filter from plugs-navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter from plugs-navigator.  
    Public MethodReturns PotentialDefinitions matching given filter from potentials-navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.SegmentDefinition matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.PlanningSegment matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.SegmentTemplate matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.SegmentTemplate matching the given filter.  
    Public MethodOverloaded. This function takes all objects of classes StorableObject and inherited from StorableObject except Page and filters them with the given filter. This method does not return Eplan.EplApi.DataModel.Graphics.PropertyPlacement and Eplan.EplApi.DataModel.MasterData.Symbol.  
    Public MethodReturns all objects of classes StorableObject and inherited from StorableObject, except Page, which matches to given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.MasterData.Symbols matching given filter from symbols-navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.TerminalStrip matching given filter from terminals-navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Terminals matching given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter from the terminals navigator.  
    Public MethodSets the project used. The same as project parameter in the constructor. Used when accessing API registered as COM.  
    Top
    See Also