Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Designer Class / PlaceControlPoint Method
A part on which the control point is to be placed.
First edge point among which the control point is to be placed.
Second edge point among which the control point is to be placed.
Position of the control point.
Example
In This Topic
    PlaceControlPoint Method (Designer)
    In This Topic
    Place control point on cable, wire, bundle etc.
    Syntax

    Parameters

    parentOcc
    A part on which the control point is to be placed.
    firstPoint
    First edge point among which the control point is to be placed.
    secondPoint
    Second edge point among which the control point is to be placed.
    position
    Position of the control point.

    Return Value

    Placed control point.
    Exceptions
    ExceptionDescription
    Argument is null.
    Argument is invalid. The exception is thrown when a wrong argument is passed to the method or the setter of property.
    This file is not opened.
    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.
    Thrown when the type of part can not be placed by the method.
    Thrown when placing this part failed.
    Thrown when edge points do not lie next to each other.
    Remarks

    Controls points have to be neighboring.

    Example
    This example shows how to place a control point to a wire.
    // Obtain workspace beforehand and open for writing.
    Workspace workspace = ...
    workspace.Open(false, false);
    
    // Obtain wire from workspace.
    OccWsWire wire = workspace.GetAllOccurrences<OccWsWire>().FirstOrDefault(occ => occ.Name.ToString() == "wire1");
    
    // Obtain control points from wire.
    List<IControlPoint> controlPoints = cable.GetAllControlPoints().ToList();
    IControlPoint firstPoint = controlPoints.FirstOrDefault(c => c.Name.ToString() == "occ_1");
    IControlPoint secondPoint = t.FirstOrDefault(c => c.Name.ToString() == "occ_2");
    
    // Position of the control point.
    TransformProperty<LengthProperty> position = new TransformProperty<LengthProperty>
    (
    	new LengthProperty(-50, Unit.Millimeter),
    	new LengthProperty(120, Unit.Millimeter),
    	new LengthProperty(70, Unit.Millimeter)
    );
    
    // Place attached part to occurrence.
    workspace.PlaceControlPoint(wire, firstPoint, secondPoint, position);
    See Also