Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Designer Class / Route Method
Objects that will be routed.
Bundles for routing.
Example
In This Topic
    Route Method (Designer)
    In This Topic
    Route selected objects through given bundles.
    Syntax

    Parameters

    objects
    Objects that will be routed.
    bundles
    Bundles for routing.
    Exceptions
    ExceptionDescription
    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.
    This operation was denied because of your license.
    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.
    Thrown when the occurrence is not part of this document.
    Thrown when you try to route a cable wire.
    Thrown when you try to route a routable occurrence through the same bundle it is already routed through.
    Example
    This example shows how to use route function on selected objects.
    Workspace workspace = ...
    
    // Obtain routable occurrences which you want to route.
    IRoutable wire = ...
    IRoutable bundle = ...
    
    // Obtain bundles you want to route the objects through.
    IBundle bundle1 = ...
    IBundle bundle2 = ...
    IBundle bundle3 = ...
    
    // Route the objects through the bundles.
    workspace.Route(new List<IRoutable>() { bundle, wire }, new List<IBundle>() { bundle1, bundle2, bundle3 });
    See Also