RemoveSpecialComponentFromBundle Method

In This Topic

Removes special component from a bundle and places it to an arbitrary position.

Syntax

public IOccSharedPoint RemoveSpecialComponentFromBundle( 
   ISpecialComponentBase specialComponentOcc,
   TransformProperty<LengthProperty> position
)

Parameters

specialComponentOcc: Special component to remove from a bundle.
position: New position for the special component.

Return Value

Created shared control point where the special electrical component used to be.

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.ArgumentNullException
EPLAN.Harness.API.Exceptions.SpecialComponentHasNoBundleException	Thrown when the special component has no parent bundle.

Remarks

All wires connected to the special component will remain connected. The bundles connected to the special component will be merged into one new bundle.

Example

This example shows how to remove a special component from a bundle.

Workdesk workdesk = ...

// Obtain special component and define its new position
ISpecialComponentBase specialComponent = ...
var position = ...

// Remove from bundle
wordesk.RemoveSpecialComponentFromBundle(specialComponent, position);

Reference

Designer Class
Designer Members
Workspace Class
Workdesk Class

Send Feedback