AutoPlaceAttachedParts Method

In This Topic

Automatically add, remove or delete redundant attached parts.

Syntax

public IEnumerable<AutoAttachedPartResult> AutoPlaceAttachedParts( 
   AutoAttachPartsSettings autoAttachPartsSettings
)

Parameters

autoAttachPartsSettings: Settings for automatic placing of attached parts.

Return Value

IEnumerable of EPLAN.Harness.API.DataStructures.AutoAttachedPartResult.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ArgumentNullException
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.FileClosedException	This file is not opened.
EPLAN.Harness.API.Exceptions.FileOpenedAsReadOnlyException	You can not perform this action on a document opened as read only.
EPLAN.Harness.API.Exceptions.NoActiveLibraryException	The exception that is thrown when the project has no active library.

Example

This example shows how to automatically add wire terminals to pins.

// Open Workspace or Workdesk.
Designer designer = ...
designer.Open(false, false);

// Specify what you want to do.
AutoAttachPartsSettings settings = new AutoAttachPartsSettings(AutoPlaceAttachedPartsAction.AddObjects)
{
	AutoPlaceWireTerminalsOnPins = true
};

IEnumerable<AutoAttachedPartResult> autoAttachedPartResults = designer.AutoPlaceAttachedParts(settings);

Reference

Designer Class
Designer Members
AutoAttachedPartResult Class

Send Feedback