Position Property (OccWsAnnotation)

In This Topic

Gets (or sets) the position of this occurrence.

Syntax

public TransformProperty<LengthProperty> Position {get; set;}

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.HpdApi.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.HpdApi.Init method. If API is in failed state, you can not resurrect it.
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.OccurrenceDeletedException	The exception that is thrown when you trying to access to already deleted occurrence.
EPLAN.Harness.API.Exceptions.OccurrenceIsAnchoredException	Thrown when this occurrence is anchored. Set the Anchored property of this occurrence to false to be able change the position.

Remarks

Position in X, Y and Z axes. Values are returned in default units.

Example

This example shows how to set a new position for an occurrence.

// Obtain the occurrence.
OccWsConnector connector = ...

// Create a new position.
TransformProperty<LengthProperty> position = new TransformProperty<LengthProperty>
(
	new LengthProperty(10, Unit.Millimeter),
	new LengthProperty(-10, Unit.Millimeter),
	new LengthProperty(0, Unit.Millimeter)
);

connector.Position = position;

This example shows how to edit position of this occurrence.

// Obtain the occurrence.
OccWsConnector connector = ...

// Get the actual position and edit only the X axis.
TransformProperty<LengthProperty> position = connector.Position;
position.X = new LengthProperty(50, Unit.Millimeter);

connector.Position = position;

Reference

OccWsAnnotation Class
OccWsAnnotation Members
TransformProperty<T> Class
LengthProperty Class

Send Feedback