API Help
Eplan.EplApi.DataModel Namespace / Placement Class
Properties Methods

In This Topic
    Placement Class Members
    In This Topic

    The following tables list the members exposed by Placement.

    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 PropertyDrawingOrderSets display sequence. The drawing order flag will be used to sort elements according to drawing order within a group. If elements chare the same value the drawing order will result from order of the data model. Default value is 67.  
    Public PropertyGroupReturns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned.  
    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 placement is placed  
    Public PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsSetAsVisibleGets/Sets visibility of the object as set in its properties dialog.  
    Public PropertyIsTransient

    Determines if the the StorableObject is transient.

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

    it is a Page and it was not assigned a Project,

    it is a Placement or any class derived from it and was not assigned a 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 PropertyLocationGet or set the placement's location.  
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPageReturns the page the Placement is on, or assigns a Page object to the placement. If the placement was previously assigned to another page, it is removed from old one and assigned to the page given as an argument.  
    Public PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPropertiesExposes P8 properties.  
    Public PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodCopyToOverloaded. Copy Placement and insert the Copy into destination group. Copied placement will be inserted into desired project of destination group. If this placement is temporary, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted. Defines whether a layer should be matched by name.  
    Public MethodDispose()Destructor (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 MethodGetBoundingBoxPlacement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size.  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    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 MethodRemoveRemoves placement.  
    Public MethodScaleOverloaded. Scales the placement (or group of placements) by the specified factors in X and Y axis with scaling origin point specified by the ptOrigin parameter X axis factor. E.g. value of 2 makes the width two times bigger.Y axis factor. E.g. value of 0.5 makes the height two times smaller.Scaling origin point.  
    Public MethodSmartLockTries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; 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)
    Top
    See Also

    Reference

    Placement Class
    Eplan.EplApi.DataModel Namespace

     

     

    EPLAN API , 21.05.2020, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

    Send Feedback