API Help
Eplan.EplApi.DataModel.E3D Namespace / AuxiliaryLine Class
Members

In This Topic
    AuxiliaryLine Class
    In This Topic
    Represents auxiliary line drawn on a layout space.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.E3D.Placement3D
             Eplan.EplApi.DataModel.E3D.AuxiliaryLine

    Syntax
    public class AuxiliaryLine : Placement3D 
    public ref class AuxiliaryLine : public Placement3D 
    Remarks
    AuxiliaryLine behaviors differently then rest of EPLAN 3D objects. It can have a parent but it is not visible as a child of that parent. The only way to gain this object from a project is either by DMObjectsFinder or SelectionSet.
    Public Constructors
     NameDescription
    Public ConstructorCreates not placed AuxiliaryLine object with defined start and end position.  
    Top
    Public Properties
     NameDescription
    Public PropertyOffset form beginning of installation space coordinate system to lower left back corner of object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyAbsolute position and rotation represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyAbsolute position and rotation represented by transformation matrix where transformation of macro is considered. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyDetermines if connection point data are saved locally at the part placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns all children of this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyColor of 3D Placement (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyAll existing 3d connections whose beginning or end is this placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyArray of connection points data. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPosition of the AuxiliaryLine end relatively to its parent.  
    Public PropertyReturns the Eplan.EplApi.DataModel.FunctionDefinition of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns InstallationSpace in which this object exists. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyIndicates whether object is currently hidden in 3D editor view. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if a mesh is created for this objects and assigned for it. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns true if the placement is placed. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns true if placement area is defined for this Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property

    Determines if the the StorableObject is transient.

    The StorableObject is transient when it was created by default constructor and:

    it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project,

    it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the Eplan.EplApi.DataModel.Graphics.GraphicalLayer of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyLength of AuxiliaryLine.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyOverridden. Gets or Sets parent placement. Caution: The Change of the parent will also change the absolute position because Placement3D stores the position relative to his parent  
    Public PropertyReturns transformation defining plane of placement area. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns children of this object which are Plane. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyEPLAN properties of the AuxiliaryLine object.  
    Public PropertyReturns Placement3D.PropertyPlacementsSchemas assigned to this Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns PropertyPlacementsSchemas assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyPosition and rotation relative to the parent placement represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyPosition of the AuxiliaryLine beginning relatively to its parent.  
    Public PropertyGets the root 3d placement from tree of 3d elements which this object is part of. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturn true if the instance uses the local property instances, otherwise it uses the ones of the variant. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Top
    Public Methods
     NameDescription
    Public MethodCreates new connection point position. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodAdd copy of a mate to a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodCopy 3D Placements the objects and their children will be copied into the same Project as newParent Then parent of the copied objects will be set to newParent new parent of copied objectsobjects to copy (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public Methodstatic (Shared in Visual Basic)Creates not placed AuxiliaryLine object with defined start and end position.  
    Public Methodstatic (Shared in Visual Basic)Creates transient, not placed AuxiliaryLine object with defined start and end position.  
    Public MethodDestructor for deterministic finalization of AuxiliaryLine object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodFind source mate by name. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodFind target mate by name. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns bounding box of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGet array of all source mates from this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public Methodget Array of all target mates from this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodMove this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodMove this object relative to its parent. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodRemoves object from project and all its children. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodRemoves connection point data stored under given index. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodSets parent placement. Sets parent placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodTries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodStores data from connection point position in function under given index. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodCopies or removes all local ProperyPlacemnets and sets flag (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also