PlaceRapidLight(RapidLightDefinition,TransformProperty<LengthProperty>) Method

In This Topic

Place rapid light to scene.

Syntax

public IOccRapidLight PlaceRapidLight( 
   RapidLightDefinition definition,
   TransformProperty<LengthProperty> position
)

Parameters

definition: Rapid light definition.
position: Position of the rapid light.

Return Value

Placed rapid Light.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.Studio.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.Studio.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.IncorrectPartTypeException	Thrown when the type of part can not be placed by the method.
EPLAN.Harness.API.Exceptions.PartPlacementFailedException	Thrown when placing this part failed.

Example

This example shows how to place a rapid light.

// Obtain workspace beforehand and open for writing.
Workspace workspace = ...
workspace.Open(false, false);

// Special component definition.
RapidLightDefinition definition = new RapidLightDefinition();
definition.Color = Color.Aqua;

// Position of the rapid special component.
TransformProperty<LengthProperty> position = new TransformProperty<LengthProperty>
(
	new LengthProperty(-50, Unit.Millimeter),
	new LengthProperty(120, Unit.Millimeter),
	new LengthProperty(70, Unit.Millimeter)
);

// Place attached part to occurrence.
workspace.PlaceRapidLight(definition, position);

Reference

Designer Class
Designer Members
Overload List
TransformProperty<T> Class

Send Feedback