GraphicalPlacement Class

In This Topic

This class is a superclass for all graphical classes, like Line, Arc etc.

Inheritance Hierarchy

Syntax

C#
C++/CLI

public class GraphicalPlacement : Eplan.EplApi.DataModel.Placement

public ref class GraphicalPlacement : public Eplan.EplApi.DataModel.Placement

Remarks

Some properties of Data model classes are not linked with their owners even if from the syntax it may seem otherwise. Like in this line: oRectangle.Pen.ColorId = 5, the ColorId of the Pen is changed but oRectangle object doesn't know about it since the Pen property is a stand alone value not aware of oRectangle object existence. This remark applies to the following GraphicalPlacement property: Pen.

Public Constructors

	Name	Description
	GraphicalPlacement Constructor	Default constructor. Should never be used. Always throws NotImplementedException. It was designed only for COM compatibility.

Top

Public Properties

	Name	Description
	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)
	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)
	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.
	Layer	Gets or sets object's graphical layer. If object is not assigned to a project (Project is null), null is returned
	LayerId	Gets layer id of layer assigned to this object.
	Location	Get or set the placement's location. (Inherited from Eplan.EplApi.DataModel.Placement)
	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.
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	Allows properties access.
	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)
	Dispose()	Destructor for deterministic finalization of GraphicalPlacement object. (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)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	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)
	SetVisibilityDependingOnLayer	This method sets the visibility of the graphical instance to depend on the layer setting
	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

GraphicalPlacement Members
Eplan.EplApi.DataModel.Graphics Namespace

Send Feedback