PlaceSurfaceProtection(LibSurfaceProtection,IOccBundle,ApiLinkType) Method

In This Topic

Place surface protection on an existing bundle.

Syntax

public IOccSurfaceProtection PlaceSurfaceProtection( 
   LibSurfaceProtection part,
   IOccBundle bundle,
   ApiLinkType linkType
)

Parameters

part: Surface protection from library.
bundle: Bundle where surface protection will be placed.
linkType: Determines if part's accessories will be placed with part. Mandatory, Optional, both types or None accessories can be placed. This enum has the Flags attribute.

Return Value

Placed surface protection.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ArgumentNullException
EPLAN.Harness.API.Exceptions.ArgumentException
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.LicensingErrorException	This operation was denied because of your license.
EPLAN.Harness.API.Exceptions.PartPlacementFailedException	The exception that is thrown when the part cannot be placed to workspace/workdesk.
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.

Example

This example shows how to place a new surface protection on the bundle.

Workdesk workdesk = ...

// Prepare Bundle.
IOccBundle bundle = ...

// Prepare LibSurfaceProtection.
LibSurfaceProtection surfaceProtection = ...

IOccSurfaceProtection surfaceProtectionOcc = workdesk.PlaceSurfaceProtection(surfaceProtection, bundle);

Reference

Designer Class
Designer Members
Overload List
PlacePosition Class
TransformProperty<T> Class
IOccConnectableWithBundle Interface
LibSurfaceProtection Class
LengthProperty Class
IOccBundle Interface

Send Feedback