DimensionItem Class Members

In This Topic

The following tables list the members exposed by DimensionItem.

Public Constructors

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

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)
	DimensionCalculated	Gets/Sets whether the value of the dimension (the dimension's text) is automatically calculated.
	DimensionDisableZero	Gets whether presicion is setted or not.
	DimensionDistanceToLine	Gets the distance dimension text to dimension line.
	DimensionExtensionLine	Gets length dimension extension help line.
	DimensionLineTermination	Gets the dimension line termination.
	DimensionPositionCalculated	Gets/Sets whether the dimension's text is automatically positioned (in relation to the dimension item itself).
	DimensionPrecision	Gets the presicion of DimensionItem.
	DimensionPrefix	Gets the prefix of DimensionItem.
	DimensionShowUnits	Gets whether unit is displayed or not.
	DimensionSuffix	Gets the suffix of DimensionItem.
	DimensionText	Gets the value of DimensionItem.
	DimensionUnit	Gets the unit of DimensionItem.
	DimensionValueCenteredInLine	Determines whether dimension value is centered in line
	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)
	EndPoint	Gets or sets the end point of the dimension item.
	ExtensionLineFirst	Gets whether first extension help line is displayed or not.
	ExtensionLineSecond	Gets whether second extension help line is displayed or not.
	FirstPoint	Gets or sets the first point of the dimension item.
	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. (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.
	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 Page object.
	SecondPoint	Gets or sets the second point of the dimension item.
	SuppressDimensionLine	Determines whether dimension line is suppressed
	TextColor	Color for displayed text. Color index (0-255) Please use -16002 as "From layer" value. Predefined values for line colour index are: 0 = black 1 = red 2 = yellow 3 = green 4 = cyan 5 = blue 6 = magenta 7 = white 252 = darkgray 253 = gray
	TextFontInfo	Font for displayed text.
	TextHeight	Returns height of the Text.
	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 DimensionItem on a given page.
	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)
	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	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 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)

Top

Reference

DimensionItem Class
Eplan.EplApi.DataModel.Graphics Namespace

Send Feedback