Eplan Platform API
Eplan.EplApi.DataModel.E3D Namespace / Group3D Class
Properties Methods

In This Topic
    Group3D Class Members
    In This Topic

    The following tables list the members exposed by Group3D.

    Public Constructors
     NameDescription
    Public ConstructorGroup3D ConstructorDefault constructor. Creates the Group3D object.  
    Top
    Public Properties
     NameDescription
    Public PropertyCrossReferencedObjectsAllReturns 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 PropertyDatabaseIdentifierReturns 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 PropertyGroupHandleMateGets handle mate  
    Public PropertyIsLocked

    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 PropertyIsPlacedReturns true if the Group3D object is placed  
    Public PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsTransient

    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 PropertyIsValidDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyParentGets parent of the Group3D object.  
    Public PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProperties.NET Property enabling access to P8 properties of the Group3D object.  
    Public PropertySubPlacement3DsReturns all grouped Placement3Ds.  
    Public PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodAddMateOverloaded. Adds a mate to a group  
    Public MethodCreateCreates a new Group3D object.  
    Public MethodDispose()Destructor for deterministic finalization of the Group3D object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetMatesGets group mates  
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodInsertSubPlacement3DInserts Placement3D to the 3D group.  
    Public MethodInsertSubPlacement3DsInserts Placement3Ds to the 3D group.  
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodMoveMoves the Group3D object relative to absolute axis origin.  
    Public MethodRemoveRemoves the 3D group and all grouped Placement3Ds.  
    Public MethodRemoveSubPlacement3DOverloaded. Removes Placement3D from the 3D group and from the project. The Placement3D object passed into this method is no longer valid.  
    Public MethodRemoveSubPlacement3DsOverloaded. Removes Placement3Ds from the 3D group and from the project. The Placement3D objects passed into this method are no longer valid.  
    Public MethodSmartLockTries 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 MethodToStringIdentifierReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodUnGroupOverloaded. Removes Placement3Ds only from the 3D group.  
    Top
    See Also

    Reference

    Group3D Class
    Eplan.EplApi.DataModel.E3D Namespace

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support