Create Method (LineMate)

In This Topic

Creates a LineMate.

Syntax

C#
C++/CLI

public void Create( 
   string strName,
   string strMatchingMateNames,
   MultiLangString pMLSDescription,
   PointD3D pntStart,
   PointD3D pntEnd
)

public:
void Create( 
   String^ strName,
   String^ strMatchingMateNames,
   MultiLangString^ pMLSDescription,
   PointD3D pntStart,
   PointD3D pntEnd
)

Parameters

strName: Name identifying this mate.
strMatchingMateNames: Names of mates which can be snapped to this mate.
pMLSDescription: Description of set to this LineMate.
pntStart: Beginning of the line mate, relative.
pntEnd: End of the line mate, relative.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when param is `null` value. Check exception message for more info.
System.ArgumentException	Thrown if `strName` has zero length.
Eplan.EplApi.DataModel.ObjectAlreadyCreatedException	Thrown when the LineMate has already been created.

Remarks

Names of mates in strMatchingMateNames have to be separated by ';' char. It possible to specify that this mate matches all other mates if parameter strMatchingMateNames is null, empty or is equal to '*'. Value "*-R" of this parameter means that this mate matches all other mates but without mates from mounting rail (name of such mates is 'R').

Names are not case sensitive and can't contain char: '#'.

Please be aware that coordinates passed by pntStart, pntEnd are relative until a mate is added

Reference

LineMate Class
LineMate Members

Send Feedback