M

ConnectorElement.CreatePipeConnector

Description:
Create a new pipe ConnectorElement with a face and an edge.

Remarks:
Regenerates the document.

Overloads (2):

CreatePipeConnector

CreatePipeConnector(Document,PipeSystemType,Reference)

CreatePipeConnector(Document,PipeSystemType,Reference,Edge)

public static ConnectorElement CreatePipeConnector(
	Document document,
	PipeSystemType pipeSystemType,
	Reference planarFace,
	Edge edge
)

Public Shared Function CreatePipeConnector ( 
	document As Document,
	pipeSystemType As PipeSystemType,
	planarFace As Reference,
	edge As Edge
) As ConnectorElement

public:
static ConnectorElement^ CreatePipeConnector(
	Document^ document, 
	PipeSystemType pipeSystemType, 
	Reference^ planarFace, 
	Edge^ edge
)

static member CreatePipeConnector : 
        document : Document * 
        pipeSystemType : PipeSystemType * 
        planarFace : Reference * 
        edge : Edge -> ConnectorElement

Document

document

The document to add the connector to.
PipeSystemType

pipeSystemType

The PipeSystemType of the connector.
Reference

planarFace

The planar face to place the connector on.
Edge

edge

One of the edges in the edge loop that defines the connector location on the planar face.

Return Value ConnectorElement The pipe ConnectorElement.

ArgumentException

The reference is not a planar face. -or- document is not a family document. -or- Thrown when the edge does not belong to the face.
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration
InvalidOperationException

Connector creation is not allowed in this family.