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

C#
C++/CLI

public class SymbolMacro : WindowMacro

public ref class SymbolMacro : public WindowMacro

Public Constructors

	Name	Description
	SymbolMacro 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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Location	The position of lower left corner of the macro defined by the user when storing it. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Objects	Returns all Eplan.EplApi.DataModel.Placement contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Objects3D	Returns all Eplan.EplApi.DataModel.Placement3D contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Page	Returns the Eplan.EplApi.DataModel.Page on which the macro was created. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	PlaceHolders3D	Returns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D contained in the macro. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	PlacementAreaTransformation	Returns the transformation of macro placement area. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	ReferencePoint	The reference point of the macro defined by the user when storing it. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	ReferencePoint3D	The position of user defined handle. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	RepresentationType	the used variant (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	RepresentationTypes	macro Representation Types. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	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). (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	TopLevelObjects	Returns all Eplan.EplApi.DataModel.Placements, with no parent. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	TopLevelObjects3D	Returns all Eplan.EplApi.DataModel.Placement3D, with no parent. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Variant	The used variant. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)

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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	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. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	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 (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Create	Overloaded. 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)
	Dispose()	Destructor. (Inherited from Eplan.EplApi.DataModel.MasterData.Macro)
	ExistVariant	Overloaded. checks, if the variant exists inside the window macro (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	GetBoundingBox	Returns the bounding box of the macro. This is the size and position of the macrobox. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	GetBoundingBox3D	Returns the least bounding box containing all 3d elements of macro in current variant. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	GetVariants	Macro variants by representation type "nRepresentationType". (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	GetWindowMacroInterface	(Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Open	Overloaded. Opens a macro file and reads the information. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	ResetPositions3D	Overloaded. Resets positions of items of a 3d macro according to one of its objects. (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Source	Get name of the source from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	SourceProject	Get name of the source project from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)
	Version	Get version from current representation type (Inherited from Eplan.EplApi.DataModel.MasterData.WindowMacro)

Top

Reference

SymbolMacro Members
Eplan.EplApi.DataModel.MasterData Namespace

Send Feedback