Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Nailboard Class / PlaceGap Method
Anchor point.
Grip point.
The length by which the segment between anchor and grip point will be shrunk. 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 gapLength = 10 cm, the resulting distance between CP1 and CP2 will be 90 cm.
In This Topic
    PlaceGap Method
    In This Topic
    Place gap symbol between two control points.
    Syntax

    Parameters

    anchorPoint
    Anchor point.
    gripPoint
    Grip point.
    gapLength
    The length by which the segment between anchor and grip point will be shrunk. 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 gapLength = 10 cm, the resulting distance between CP1 and CP2 will be 90 cm.

    Return Value

    Created gap occurrence.
    Exceptions
    ExceptionDescription
    Argument is null.
    This file is not opened.
    You can not perform this action on a document opened as read only.
    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.
    The object is in invalid state. Obtain a new one.
    The operation was not successful.
    See Also