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

In This Topic
    SymbolMacro Class
    In This Topic
    This class represents a symbol macro
    Inheritance Hierarchy

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

    Syntax
    public class SymbolMacro : WindowMacro 
    public ref class SymbolMacro : public WindowMacro 
    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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyThe position of lower left corner of the macro defined by the user when storing it. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns all Eplan.EplApi.DataModel.Placement contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns all Eplan.EplApi.DataModel.Placement3D contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns the Eplan.EplApi.DataModel.Page on which the macro was created. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns the transformation of macro placement area. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyThe reference point of the macro defined by the user when storing it. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyThe position of user defined handle. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public Propertythe used variant (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public Propertymacro Representation Types. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    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). (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns all Eplan.EplApi.DataModel.Placements, with no parent. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReturns all Eplan.EplApi.DataModel.Placement3D, with no parent. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyThe used variant. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    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 (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodOverloaded. Writes a window macro file from the pPlacements If at least one given Placement object is valid, created macro is opened. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodDestructor. (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public MethodOverloaded. checks, if the variant exists inside the window macro (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodReturns the bounding box of the macro. This is the size and position of the macrobox. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodReturns the least bounding box containing all 3d elements of macro in current variant. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodMacro variants by representation type "nRepresentationType". (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public Method (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodOverloaded. Opens a macro file and reads the information. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGet name of the source from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGet name of the source project from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGet version from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Top
    See Also