Eplan Platform API
Eplan.EplApi.DataModel Namespace / MacroBox Class
Properties Methods

In This Topic
    MacroBox Class Members
    In This Topic

    The following tables list the members exposed by MacroBox.

    Public Constructors
     NameDescription
    Public ConstructorDefault constructor. Should never be used. Always throws NotImplementedException. It was designed only for COM compatibility.  
    Top
    Public Properties
     NameDescription
    Public PropertyThe value determines if target is taken from net-based routing or not. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns a block which this SymbolReference object is part of. If this object is not a part of any block, this property returns NULL. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    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 PropertySets 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. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyGets or sets generate protected group property.  
    Public PropertyAn array of the symbols's connection points (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyAn array of SymbolReference.GraphicalConnection objects representing all auto-connecting lines connected to the pins of the symbol. This property may be useful to check graphical layout of connections associated with the symbol (including T-nodes, corners, etc.). (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyReturns true if the symbol's logical area is a polyline (consisting of segments) rather than just a rectangle. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyCoordinates of insertion point  
    Public PropertyInsertionPoint  
    Public PropertyGets or sets insert macro box property.  
    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 the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyIndicates whether surface is filled or not.  
    Public Property

    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 PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyGets/Sets an array of segments that the symbol's logical area may consist of. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyMacro name  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns 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. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to P8 properties of the MacroBox object.  
    Public PropertyReturns Eplan.EplApi.DataModel.Graphics.PropertyPlacements assigned to the SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns SymbolReference.PropertyPlacementsSchemas assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyAll referenced objects  
    Public PropertyThis property corresponds with the "Individual objects assignment" flag in the macro box dialog.  
    Public PropertyRepresentation Type property of the macro box  
    Public PropertySpecifies Eplan.EplApi.DataModel.MasterData.SymbolVariant assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertySet configuration type to select different variants for point or destination wiring (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyGets or sets take connection point designations into account property.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets or sets type of usage.  
    Public PropertyReturn true if the instance uses the local property instances, otherwise it uses the ones of the variant. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyVariant  
    Top
    Public Methods
     NameDescription
    Public MethodAdds reference to object, that belongs to macro  
    Public MethodConverts the symbol representing this object into a group of graphical placements. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public MethodOverloaded. 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. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodOverloaded. Creates a MacroBox object.  
    Public MethodDestructor for deterministic finalization of MacroBox 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 MethodPlacement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodGets a Placement object that represents the macro box graphically on a page.  
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns a rectangle which is the logical area of the object derived from SymbolReference. For objects having symbols consisting of segments, this method returns the bounding box of the polyline created by those segments. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public MethodGets list of property placements of given type. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodChecks, if the point is inside logical area of the symbol. Returns true, if the symbol has a logical area and the point is inside. The logical area may be a rectangle or a polyline without arcs. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    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 MethodRemoves placement. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodRemove all references  
    Public MethodRemove reference  
    Public MethodReorders property placements of one type, which are assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public MethodOverloaded. 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. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodSets rectangular logical area for objects derived from SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public MethodTries 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 MethodCopies or removes all local ProperyPlacemnets and sets flag (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also