SymbolReference Class

In This Topic

A class that represents logical elements of Project's Page that are placed in projects logical hierarchy. Although it does not have to be a device, in most cases it is.

Inheritance Hierarchy

Syntax

C#
C++/CLI

public class SymbolReference : Placement

public ref class SymbolReference : public Placement

Remarks

Some properties of Data model classes are not linked with their owners even if from the syntax it may seem otherwise. For example: 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 SymbolReference property: PropertyPlacements. When a new object was created by API, the displayed properties are set from original default schema of the symbol, even if another was set as default by user.

Example

oRectangle.Pen.ColorId = 5;

Public Constructors

	Name	Description
	SymbolReference Constructor	Default constructor. Creates the SymbolReference object.

Top

Public Properties

	Name	Description
	AreTargetsSpecifed	The value determines if target is taken from net-based routing or not.
	Block	Returns a block which this SymbolReference object is part of. If this object is not a part of any block, this property returns NULL.
	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)
	GraphicalConnectionPoints	An array of the symbols's connection points
	GraphicalConnections	An array of SymbolReference.GraphicalConnection objects representing all auto-connecting lines connected to the pins of the symbol. This property may be useful to check graphical layout of connections associated with the symbol (including T-nodes, corners, etc.).
	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)
	HasPolylineAsLogicalArea	Returns true if the symbol's logical area is a polyline (consisting of segments) rather than just a rectangle.
	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 Page and it was not assigned a Project, it is a Placement or any class derived from it and was not assigned a 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)
	Location	Overridden. Get or set the placement's location.
	LogicalAreaSegments	Gets/Sets an array of segments that the symbol's logical area may consist of.
	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)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	EPLAN properties of the SymbolReference object.
	PropertyPlacements	Returns Eplan.EplApi.DataModel.Graphics.PropertyPlacements assigned to the SymbolReference.
	PropertyPlacementsSchemas	Returns PropertyPlacementsSchemas assigned to this SymbolReference.
	SymbolVariant	Specifies Eplan.EplApi.DataModel.MasterData.SymbolVariant assigned to this SymbolReference.
	SymbolWiringType	Set configuration type to select different variants for point or destination wiring
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	UseLocalPropertyPlacements	Return true if the instance uses the local property instances, otherwise it uses the ones of the variant.

Top

Public Methods

	Name	Description
	ConvertToGraphics	Converts the symbol representing this object into a group of graphical placements.
	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 SymbolReference. It is placed on the page passed as a parameter, using a given SymbolVariant.
	Dispose()	Destructor for deterministic finalization of SymbolReference 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)
	GetLogicalArea	Returns a rectangle which is the logical area of the object derived from SymbolReference. For objects having symbols consisting of segments, this method returns the bounding box of the polyline created by those segments.
	GetPropertyPlacements	Gets list of property placements of given type.
	IsPointInsideLogicalArea	Checks, if the point is inside logical area of the symbol. Returns true, if the symbol has a logical area and the point is inside. The logical area may be a rectangle or a polyline without arcs.
	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)
	ReorderPropertyPlacements	Reorders property placements of one type, which are assigned to this SymbolReference.
	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 X axis factor. E.g. value of 2 makes the width two times bigger.Y axis factor. E.g. value of 0.5 makes the height two times smaller.Scaling origin point. (Inherited from Eplan.EplApi.DataModel.Placement)
	SetLogicalArea	Sets rectangular logical area for objects derived from SymbolReference.
	SmartLock	Tries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	SwitchLocalPropertyPlacements	Copies or removes all local ProperyPlacemnets and sets flag
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

SymbolReference Members
Eplan.EplApi.DataModel Namespace

Send Feedback