Eplan Platform API
Eplan.EplApi.DataModel Namespace / DMObjectsFinder Class
Methods

In This Topic
    DMObjectsFinder Class Members
    In This Topic

    The following tables list the members exposed by DMObjectsFinder.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Methods
     NameDescription
    Public MethodDestructor  
    Public Method  
    Public MethodReturns Eplan.EplApi.DataModel.ArticleReferences matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.ArticleReferences matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.ArticleReferences matching the given filter from the bill of materials navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.BoxedDevices matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.BoxedDevices matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Cables and shieldings (Eplan.EplApi.DataModel.Functions with category "Shielding") matching the given filter from the cable navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.CableUnites matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.CableUnites matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.CableUnites matching the given filter from the wire harness navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.Connections matching the given filter.
    If the filter parameter is NULL, all the project connection objects are returned.
    Note: If no filter is used, the number of objects returned may be bigger than the number of connections visible in the GUI connection navigator.
    The GUI connection navigator by default shows connections of the following placement types only:
    • Circuit
    • CircuitSingleLine
    • Overview
    • PairCrossReference
    • ProcessAndInstrumentationDiagram
    • PanelLayout
     
    Public MethodReturns Eplan.EplApi.DataModel.Connections matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Connections matching the given filter from the connection navigator.  
    Public MethodReturns user defined MateEntrys of all project Placement3Ds matching the given filter.  
    Public MethodOverloaded. Returns Eplan.EplApi.DataModel.Functions matching the given filter.
    If the "bWithConnectionDefinitionPoints" parameter is TRUE, also returns Eplan.EplApi.DataModel.ConnectionDefinitionPoints matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.E3D.Function3Ds matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Functions matching the given custom filter.  
    Public MethodReturns Functions matching the given filter from the device navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Harnesses matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Harnesses matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Harnesses matching the given filter from the wire harness navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.Functions matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Functions matching the given custom filter.  
    Public MethodReturns Eplan.EplApi.DataModel.InterruptionPoints matching the given filter from the interruptionpoint navigator.  
    Public MethodThis function takes objects of class Eplan.EplApi.DataModel.NetDefinitionPoint and filters them with the given filter.  
    Public MethodReturns all items from the list tab of a navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.Options matching the given filter from the project options navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.Pages matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Pages matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Pages matching the given filter from the pages navigator (user settings) or, if no filter is given, the filter created using the project settings.  
    Public MethodReturns all 3D placeholders from the project.  
    Public MethodReturns Eplan.EplApi.DataModel.Graphics.PlaceHolders matching the given filter from the placeholder navigator.  
    Public MethodThis function takes all objects of the Placement class and all classes that inherit from Placement except Eplan.EplApi.DataModel.Page objects 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 PropertyPlacements.  
    Public MethodReturns Eplan.EplApi.DataModel.E3D.Placement3Ds matching the given filter. This method does not return MateEntrys.  
    Public MethodThis function takes all objects of the Placement class and all classes that inherit from Placement except Eplan.EplApi.DataModel.Page objects and filters them with the given filter.
     
    Public MethodReturns PlanningSegments matching the given filter.  
    Public MethodReturns PlanningSegments matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PLCs matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PLCs matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.Functions matching the given filter from the PLC navigator.  
    Public MethodReturns PLC terminals matching the given filter from the PLC navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Plugs matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PlugStrips matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PlugStrips matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.PlugStrips matching the given filter from the plug navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Plugs matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Plugs matching the given filter from the plug navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.PotentialDefinitions matching the given filter from the potential navigator.  
    Public MethodReturns SegmentDefinitions matching the given filter.  
    Public MethodReturns PlanningSegments matching the given filter.  
    Public MethodReturns SegmentTemplates matching the given filter.  
    Public MethodReturns SegmentTemplates matching the given filter.  
    Public MethodOverloaded. This function takes all objects of the StorableObject class and all classes that inherit from StorableObject except Eplan.EplApi.DataModel.Page objects and filters them with the given filter.
    This method does not return PropertyPlacements and Symbols.  
    Public MethodThis function takes all objects of the StorableObject class and all classes that inherit from StorableObject except Eplan.EplApi.DataModel.Page objects and filters them with the given filter.
     
    Public MethodReturns Eplan.EplApi.DataModel.Symbols matching the given filter from the symbol navigator.  
    Public MethodReturns Terminals matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching the given filter.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching the given filter.  
    Public MethodReturns TerminalStrips matching the given filter from terminal navigator.  
    Public MethodReturns Eplan.EplApi.DataModel.EObjects.Terminals matching the given filter.  
    Public MethodReturns Terminals matching the given filter from the terminal navigator.  
    Public MethodSets the project used. The same as project parameter in the constructor. Used when accessing API registered as COM.  
    Top
    See Also