PropertyPlacement Class

In This Topic

This class represents text object showing a value of property of other object. It is not possible to change property placements of SymbolVariant because symbols library database is readonly. In this case BaseException will be thrown (e.g. when changing IsVisible property). Please use the Eplan.EplApi.Datamodel.SymboReference.UseLocalPropertyPlacements() method in order to change the local PropertyPlacements of Eplan.EplApi.DataModel.SymbolReference object. The following example shows how to use class PropertyPlacement.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.Placement
         Eplan.EplApi.DataModel.Graphics.GraphicalPlacement
            Eplan.EplApi.DataModel.Graphics.TextBase
               Eplan.EplApi.DataModel.Graphics.PropertyPlacement
                  Eplan.EplApi.DataModel.ContextPropertyPlacement

Syntax

C#
C++/CLI

public class PropertyPlacement : TextBase

public ref class PropertyPlacement : public TextBase

Remarks

It is possible to set new Location of PropertyPlacement even if it has been docked.

Example

The following example shows how to use class PropertyPlacement.

m_functionWithPropertyPlacementsAndSchemas.SwitchLocalPropertyPlacements(true);
PropertyPlacement oPropertyPlacement = new PropertyPlacement();
oPropertyPlacement.Create(m_functionWithPropertyPlacementsAndSchemas, 20011);
oPropertyPlacement.IsVisible = true;
oPropertyPlacement.Height = 15;
oPropertyPlacement.Location = new PointD(10.0, 25.0);
oPropertyPlacement.Remove();

Public Constructors

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

Top

Public Properties

	Name	Description
	AlignmentBoxFixedHeight	Specifies that height is fixed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	AlignmentBoxFixedWidth	Specifies that width is fixed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	AlignmentBoxHeight	Specifies the height of alignment box. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	AlignmentBoxNeverHyphenateWords	Specifies that words are wrapped. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	AlignmentBoxRemoveBreaks	Specifies that breaks are removed. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	AlignmentBoxWidth	Specifies the width of alignment box. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Centered	The property specifies whether the block (main property + docked properties) should be centered
	Contents	Overridden. Contents of object represented by this type.
	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)
	DisplayedProperty	Return Eplan.EplApi.DataModel.AnyPropertyId equal to displayed property id.
	DockingDirection	Specifies docking direction for text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	DrawAlignmentBox	Returns the alignment box type (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	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)
	DrawTextBoxType	Returns the text box type (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	FixedLanguage	Specifies language for text when property LanguageMode value is set to LangModeFix. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Font	Font for displayed text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	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)
	HasBox	Returns true if the Text has an alignment box. In GUI it's 'Activate alignment box' checkbox. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Height	Returns height of the Text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	IsAutomaticallyTranslated	Gets/sets the flag which corresponds to "Do not translate automatically" checkbox in GUI. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	IsDocked	Gets/Sets a value that indicates whether the text is docked or not. Setting IsDocked to true is possible only on PropertyPlacement object which Parent is a SymbolReference object. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	IsLeaderLineActivated	Returns true if the leader line is activated (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	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. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	Justification	Returns the justification of the Text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	LanguageMode	Specifies language mode of text. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	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	Get or set the placement's location. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Page	Overridden. 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.
	ParagraphSpacing	Specifies the Paragraph Spacing. This property is used for PropertyPlacemets attributes. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Parent
	ParserParameter	Set / Get Parameters of the text (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Pen	Sets Pen related to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
	Project	Overridden. Returns the project the StorableObject belongs to.
	Properties	.NET Property enabling access to P8 properties of the PropertyPlacement object.
	Relation	Gets/Sets Relation of PropertyPlacement.
	RelationIndex	Gets/Sets RelationIndex of PropertyPlacement.
	Rotation	Returns the rotation of the Text, in radians. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	RowSpacing	Specifies the Row Spacing. This property is used for PropertyPlacemets attributes. From layer: -16002, Single: 100, 1.5 lines: 150, Double: 200. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Source	Returns the object, that properties are shown by this PropertyPlacement
	TextColorId	Color for displayed text. Color index (0-255) Please use -16002 as "From layer" value. Predefined values for line color index are: 0 = black 1 = red 2 = yellow 3 = green 4 = cyan 5 = blue 6 = magenta 7 = white 252 = darkgray 253 = gray (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	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 the PropertyPlacement object related to parent.
	Dispose()	Destructor (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DockText	Docks one text to another. You can see how it works in GUI. Select element on schematic, display properties, show property placements and dock / undock them. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetBoundingBox	Overridden. Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size.
	GetDisplayString	Overridden. Returns formated display string of the content
	GetHashCode	Serves as the default hash function. (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	Overridden. Removes 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 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)
	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)
	UndockText	Undock text from another oner one. You can see how it works in GUI. Select element on schematic, display properties, show property placements and dock / undock them. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBase)

Top

Reference

PropertyPlacement Members
Eplan.EplApi.DataModel.Graphics Namespace

Send Feedback