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

C#
C++/CLI

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

	Name	Description
	WindowMacro Constructor	Constructor.

Top

Public Properties

	Name	Description
	CountOfPages	Get the count of Pages in this macro (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
	Description	Gets description in multiple languages (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
	HasReferencePoint	Returns true if a reference point has been defined for this macro.
	Location	The position of lower left corner of the macro defined by the user when storing it.
	Objects	Returns all Eplan.EplApi.DataModel.Placement contained in the macro.
	Objects3D	Returns all Eplan.EplApi.DataModel.Placement3D contained in the macro.
	Page	Returns the Eplan.EplApi.DataModel.Page on which the macro was created.
	PageProperty	Gets the property of the n-th page in this macro (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
	PlaceHolders	Returns all Eplan.EplApi.DataModel.Graphics.PlaceHolder contained in the macro.
	PlaceHolders3D	Returns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D contained in the macro.
	PlacementAreaTransformation	Returns the transformation of macro placement area.
	ReferencePoint	The reference point of the macro defined by the user when storing it.
	ReferencePoint3D	The position of user defined handle.
	RepresentationType	the used variant
	RepresentationTypes	macro Representation Types.
	Size	Returns 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).
	TopLevelObjects	Returns all Eplan.EplApi.DataModel.Placements, with no parent.
	TopLevelObjects3D	Returns all Eplan.EplApi.DataModel.Placement3D, with no parent.
	Variant	The used variant.

Top

Public Methods

	Name	Description
	CalculateReferencePoint	Calculates 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.
	CalculateReferencePoint3D	Calculates 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.
	ChangeCurrentVariant	Change 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
	Create	Overloaded. Writes a window macro file from the pPlacements If at least one given Placement object is valid, created macro is opened.
	Dispose()	Destructor for deterministic finalization of WindowMacro object. (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
	ExistVariant	Overloaded. checks, if the variant exists inside the window macro
	GetBoundingBox	Returns the bounding box of the macro. This is the size and position of the macrobox.
	GetBoundingBox3D	Returns the least bounding box containing all 3d elements of macro in current variant.
	GetVariants	Macro variants by representation type "nRepresentationType".
	GetWindowMacroInterface
	MacroRepresentationTypeNameFromId	Converts macro representation type to a displayed name.
	Open	Overloaded. Opens a macro file and reads the information.
	ResetPositions3D	Overloaded. Resets positions of items of a 3d macro according to one of its objects.
	Source	Get name of the source from current representation type
	SourceProject	Get name of the source project from current representation type
	Version	Get version from current representation type

Top

Reference

WindowMacro Members
Eplan.EplApi.DataModel.MasterData Namespace

Send Feedback