WindowMacro(WindowMacro,Int32,Mate,MoveKind,NumerationMode) Method

In This Topic

Places objects from window macro into layout space.

Syntax

C#
C++/CLI

public StorableObject[] WindowMacro( 
   WindowMacro oMacro,
   int nVariant,
   Mate oTargetMate,
   Insert3D.MoveKind nMoveCondition,
   WindowMacro.Enums.NumerationMode nNumerationMode
)

public:
array<StorableObject^>^ WindowMacro( 
   WindowMacro^ oMacro,
   int nVariant,
   Mate^ oTargetMate,
   Insert3D.MoveKind nMoveCondition,
   WindowMacro.Enums.NumerationMode nNumerationMode
)

Parameters

oMacro: Opened macro object.
nVariant: Index of the macro variant to be placed (0 based).
oTargetMate: target mate
nMoveCondition: Determines if the macro will be placed with absolute coordinates or relatively to the target's mate Placement3D
nNumerationMode: Numeration mode used during inserting objects.

Return Value

Inserted placements.

Exceptions

Exception	Description
ArgumentException	Thrown in case of invalid parameters.
ArgumentNullException	Null was set to a parameter.
Eplan.EplApi.Base.BaseException	An error occurred during inserting the macro. Please refer to the error message.

Remarks

Method places items according to macro's handle and a target mate, similarly as in GUI.

Reference

Insert3D Class
Insert3D Members
Overload List

Send Feedback