Rotation Property (OccWdRibbonLabel)

In This Topic

Gets (or sets) the rotation of this occurrence.

Syntax

public TransformProperty<AngleProperty> Rotation {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 rotation.

Remarks

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

Example

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

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

// Create a new rotation.
TransformProperty<AngleProperty> rotation = new TransformProperty<AngleProperty>
(
	new AngleProperty(45, Unit.Degree),
	new AngleProperty(0, Unit.Degree),
	new AngleProperty(-90, Unit.Degree)
);

connector.Rotation = rotation;

This example shows how to edit the rotation of an occurrence.

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

// Get the actual rotation and edit only Z axis.
TransformProperty<AngleProperty> rotation = connector.Rotation;
rotation.Z = new AngleProperty(60, Unit.Degree);

connector.Rotation = rotation;

Reference

OccWdRibbonLabel Class
OccWdRibbonLabel Members
TransformProperty<T> Class
TransformProperty<T> Class

Send Feedback