PolyLine Class

In This Topic

Inheritance Hierarchy
Syntax
Example
Public Constructors
Public Properties
Public Methods
See Also

This class represent PolyLine on the Eplan.EplApi.DataModel.Page. The following example shows how to use class PolyLine.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.Placement
         Eplan.EplApi.DataModel.Graphics.GraphicalPlacement
            Eplan.EplApi.DataModel.Graphics.PolyLine
               Eplan.EplApi.DataModel.Graphics.Spline

Syntax

C#
C++/CLI

public class PolyLine : GraphicalPlacement

public ref class PolyLine : public GraphicalPlacement

Example

The following example shows how to use class PolyLine.

PolyLine oPolyLine = new PolyLine();
oPolyLine.Create(m_oPage);

PointD oPint1 = new PointD(30.0, 30.0);
PointD oPint2 = new PointD(50.0, 40.0);
PointD oPint3 = new PointD(70.0, 50.0);
PointD oPint4 = new PointD(40.0, 60.0);

oPolyLine.SetPointAt(0, ref oPint1);
oPolyLine.SetPointAt(1, ref oPint2);
oPolyLine.SetPointAt(2, ref oPint3);
oPolyLine.SetPointAt(3, ref oPint4);

oPolyLine.SetBulgeAt(0, 5.5);

Public Constructors

	Name	Description
	PolyLine Constructor	Constructor. When object created with this constructor, its `create` method must be call.

Top

Public Properties

	Name	Description
	Closed	True, if the poly line is closed.
	CrossReferencedObjectsAll	Returns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DatabaseIdentifier	Returns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DrawingOrder	Sets display sequence. The drawing order flag will be used to sort elements according to drawing order within a group. If elements chare the same value the drawing order will result from order of the data model. Default value is 67. (Inherited from Eplan.EplApi.DataModel.Placement)
	FillPattern	Gets or sets the fill pattern of the PolyLine. Pattern types Bitmap, Eplan and System are not supported.
	Group	Returns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Placement)
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsPlaced	Returns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsSetAsVisible	Gets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
	IsSurfaceFilled	This property specifies if the polyline is filled. When the polyline is not closed setting this property throws an exception
	IsTransient	Determines if the the StorableObject is transient. The StorableObject is transient when it was created by default constructor and: it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project, it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsVisible	Gets/Sets the actual visibility state of the object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	Layer	Gets or sets object's graphical layer. If object is not assigned to a project (Project is null), null is returned (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	LayerId	Gets layer id of layer assigned to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	Location	Overridden. Get or set the placement's location.
	NumberOfPoints	Number of vertices of a poly line.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Page	Returns the page the Placement is on, or assigns a Page object to the placement. If the placement was previously assigned to another page, it is removed from old one and assigned to the page given as an argument. (Inherited from Eplan.EplApi.DataModel.Placement)
	Pen	Sets Pen related to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	.NET Property enabling access to P8 properties of the PolyLine object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	CopyTo	Overloaded. Copy Placement and insert the Copy into destination group. Copied placement will be inserted into desired project of destination group. If this placement is temporary, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted. Defines whether a layer should be matched by name. (Inherited from Eplan.EplApi.DataModel.Placement)
	Create	Overloaded. Creates a PolyLine object.
	CreateTransient	Overridden. Creates transient and not placed PolyLine object.
	Dispose()	Destructor (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetBoundingBox	Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. (Inherited from Eplan.EplApi.DataModel.Placement)
	GetBulgeAt	Returns the corner arc of one vertex of a poly line
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetPointAt	Returns the coordinates of a vertex of a polyline
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Remove	Removes placement. (Inherited from Eplan.EplApi.DataModel.Placement)
	Scale	Overloaded. Scales the placement (or group of placements) by the specified factors in X and Y axis with scaling origin point specified by the ptOrigin parameter. (Inherited from Eplan.EplApi.DataModel.Placement)
	SetBulgeAt	Sets the corner arc of one vertex of a poly line
	SetPointAt	Sets one vertex of a polyline If the index of this point does not yet exist it will be added.
	SetVisibilityDependingOnLayer	This method sets the visibility of the graphical instance to depend on the layer setting (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	SmartLock	Tries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

PolyLine Members
Eplan.EplApi.DataModel.Graphics Namespace

Send Feedback