API Help
Eplan.EplApi.DataModel.MasterData Namespace / WindowMacro Class
Members

In This Topic
    WindowMacro Class
    In This Topic
    This class represents a window macro
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.MasterData.Macro
          Eplan.EplApi.DataModel.MasterData.WindowMacro
             Eplan.EplApi.DataModel.MasterData.SymbolMacro

    Syntax
    public class WindowMacro : Macro 
    public ref class WindowMacro : public Macro 
    Remarks

    For variant of macro which contains 3d objects local coordinate system is created. Origin of this coordinate system is in the origin of first object from macro.

    If user does not point the location of handle then it is automatically calculated in origin of first object or its top parent.

    Public Constructors
     NameDescription
    Public ConstructorConstructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyGet the count of Pages in this macro (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public PropertyGets description in multiple languages (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public PropertyReturns true if a reference point has been defined for this macro.  
    Public PropertyThe position of lower left corner of the macro defined by the user when storing it.  
    Public PropertyReturns all Eplan.EplApi.DataModel.Placement contained in the macro.  
    Public PropertyReturns all Eplan.EplApi.DataModel.Placement3D contained in the macro.  
    Public PropertyReturns the Eplan.EplApi.DataModel.Page on which the macro was created.  
    Public PropertyGets the property of the n-th page in this macro (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public PropertyReturns all Eplan.EplApi.DataModel.Graphics.PlaceHolder contained in the macro.  
    Public PropertyReturns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D contained in the macro.  
    Public PropertyReturns the transformation of macro placement area.  
    Public PropertyThe reference point of the macro defined by the user when storing it.  
    Public PropertyThe position of user defined handle.  
    Public Propertythe used variant  
    Public Propertymacro Representation Types.  
    Public PropertyReturns the size of the macro. When available it is the size of the macro box, otherwise the graphical size (selection). If no selection was made when macro was created (for example via P8-API), it is a minimal size needed to contain all placements. If macro doesn't contain any placements, returned size is equal to (0,0).  
    Public PropertyReturns all Eplan.EplApi.DataModel.Placements, with no parent.  
    Public PropertyReturns all Eplan.EplApi.DataModel.Placement3D, with no parent.  
    Public PropertyThe used variant.  
    Top
    Public Methods
     NameDescription
    Public MethodCalculates the reference point of the macro Used to calculate reference point if reference point has not been defined by the user, when creating a macro. When reference point has been defined for then given macro, then output parameter is equal to ReferencePoint property.  
    Public MethodCalculates the reference point of the macro Used to calculate reference point if reference point has not been defined by the user, when creating a macro. When reference point has been defined for then given macro, then output parameter is equal to ReferencePoint property.  
    Public MethodChange current representation type and variant of macro This function is more efficient as changing the Properties RepresentationType and Variant separately besides, this function throws an exception, if the variant does not exist  
    Public MethodOverloaded. Writes a window macro file from the pPlacements If at least one given Placement object is valid, created macro is opened.  
    Public MethodDestructor for deterministic finalization of WindowMacro object. (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public MethodOverloaded. checks, if the variant exists inside the window macro  
    Public MethodReturns the bounding box of the macro. This is the size and position of the macrobox.  
    Public MethodReturns the least bounding box containing all 3d elements of macro in current variant.  
    Public MethodMacro variants by representation type "nRepresentationType".  
    Public Method  
    Public Methodstatic (Shared in Visual Basic)Converts macro representation type to a displayed name.  
    Public MethodOverloaded. Opens a macro file and reads the information.  
    Public MethodGet name of the source from current representation type  
    Public MethodGet name of the source project from current representation type  
    Public MethodGet version from current representation type  
    Top
    See Also