API Help
Eplan.EplApi.DataModel.MasterData Namespace / SymbolMacro Class
Properties Methods

In This Topic
    SymbolMacro Class Members
    In This Topic

    The following tables list the members exposed by SymbolMacro.

    Public Constructors
     NameDescription
    Public ConstructorSymbolMacro ConstructorConstructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyCountOfPagesGet the count of Pages in this macro (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public PropertyDescriptionGets description in multiple languages (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public PropertyHasReferencePointReturns true if a reference point has been defined for this macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyLocationThe position of lower left corner of the macro defined by the user when storing it. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyObjectsReturns all Eplan.EplApi.DataModel.Placement contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyObjects3DReturns all Eplan.EplApi.DataModel.Placement3D contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyPageReturns the Eplan.EplApi.DataModel.Page on which the macro was created. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyPagePropertyGets the property of the n-th page in this macro (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public PropertyPlaceHoldersReturns all Eplan.EplApi.DataModel.Graphics.PlaceHolder contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyPlaceHolders3DReturns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyPlacementAreaTransformationReturns the transformation of macro placement area. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReferencePointThe reference point of the macro defined by the user when storing it. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyReferencePoint3DThe position of user defined handle. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyRepresentationTypethe used variant (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyRepresentationTypesmacro Representation Types. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertySizeReturns 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 PropertyTopLevelObjectsReturns all Eplan.EplApi.DataModel.Placements, with no parent. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyTopLevelObjects3DReturns all Eplan.EplApi.DataModel.Placement3D, with no parent. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public PropertyVariantThe used variant. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Top
    Public Methods
     NameDescription
    Public MethodCalculateReferencePointCalculates 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 MethodCalculateReferencePoint3DCalculates 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 MethodChangeCurrentVariantChange 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 MethodCreateOverloaded. 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 MethodDispose()Destructor. (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
    Public MethodExistVariantOverloaded. checks, if the variant exists inside the window macro (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGetBoundingBoxReturns the bounding box of the macro. This is the size and position of the macrobox. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGetBoundingBox3DReturns the least bounding box containing all 3d elements of macro in current variant. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGetVariantsMacro variants by representation type "nRepresentationType". (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodGetWindowMacroInterface (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodOpenOverloaded. Opens a macro file and reads the information. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodResetPositions3DOverloaded. Resets positions of items of a 3d macro according to one of its objects. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodSourceGet name of the source from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodSourceProjectGet name of the source project from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Public MethodVersionGet version from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
    Top
    See Also

    Reference

    SymbolMacro Class
    Eplan.EplApi.DataModel.MasterData Namespace

     

     

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

    Send Feedback