Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Designer Class / PlaceCavitySeal Method
The attached part which is placed.
Occurrence when the part is attached.
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. Default is mandatory accessories.
Example
In This Topic
    PlaceCavitySeal Method
    In This Topic
    Place a cavity seal.
    Syntax
    public IOccCavitySeal PlaceCavitySeal( 
   LibCavitySeal part,
   I3DOccurrence parentOccurrence,
   ApiLinkType linkType
)

    Parameters

    part
    The attached part which is placed.
    parentOccurrence
    Occurrence when the part is attached.
    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. Default is mandatory accessories.

    Return Value

    Placed occurrence.
    Exceptions
    ExceptionDescription
    EPLAN.Harness.API.Exceptions.FileClosedException This file is not opened.
    EPLAN.Harness.API.Exceptions.HpdApiNotInitializedExceptionApi 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.IncorrectPartTypeExceptionThrown when the type of part can not be placed by the method or the part cannot be place to the occurrence.
    EPLAN.Harness.API.Exceptions.PartPlacementFailedExceptionThrown when placing this part failed.
    Example
    This example shows how to place a cavity seal part to workspace.
    /// Obtain workspace beforehand and open for writing.
Workspace workspace = ...
workspace.Open(false, false);

// Obtain part from active library
IEnumerable<BaseLibraryPart> parts = project.ActiveConnection.GetLibraryPartsByPartNumber("cavity seal");
BaseLibraryPart part = parts.FirstOrDefault();

// Obtain occurence from designer
BaseOccurrence occurence = workspace.GetAllOccurrences<OccWsWire>().FirstOrDefault(occ => occ.Name.ToString() == "wire1");

// Place a attached part to occurrence
workspace.PlaceCavitySeal(part as LibCavitySeal, occurence);
    See Also

    Reference

    Designer Class
    Designer Members
    BaseLibraryPart Class
    BaseOccurrence Class
    TransformProperty<T> Class

    Send Feedback