ShrinkBundle Method

In This Topic

Place gap symbol between two control points.

Syntax

public OccNbGap ShrinkBundle( 
   BaseNbControlPoint anchorPoint,
   BaseNbControlPoint gripPoint,
   LengthProperty shrankDistance
)

anchorPoint: Anchor point.
gripPoint: Grip point.
shrankDistance: The length which the segment between anchor and grip points will be shrunk to. For example, if we have two control points CP1 and CP2 on a segment such that the distance between them is 100 cm, then if we call this method on CP1 and CP2 with shrankDistance = 10 cm, the resulting distance between CP1 and CP2 will be 10 cm.

Created gap occurrence.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ArgumentNullException	Argument is null.
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.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.OperationFailedException	The operation was not successful.

Send Feedback