M

ConnectorElement.CreateElectricalConnector

Description:
Create a new electrical ConnectorElement.

Remarks:
Regenerates the document.

Overloads (2):

CreateElectricalConnector

CreateElectricalConnector(Document,ElectricalSystemType,Reference)

CreateElectricalConnector(Document,ElectricalSystemType,Reference,Edge)

public static ConnectorElement CreateElectricalConnector(
	Document document,
	ElectricalSystemType electricalSystemType,
	Reference planarFace,
	Edge edge
)

Public Shared Function CreateElectricalConnector ( 
	document As Document,
	electricalSystemType As ElectricalSystemType,
	planarFace As Reference,
	edge As Edge
) As ConnectorElement

public:
static ConnectorElement^ CreateElectricalConnector(
	Document^ document, 
	ElectricalSystemType electricalSystemType, 
	Reference^ planarFace, 
	Edge^ edge
)

static member CreateElectricalConnector : 
        document : Document * 
        electricalSystemType : ElectricalSystemType * 
        planarFace : Reference * 
        edge : Edge -> ConnectorElement

Document

document

The document to add the connector to.
ElectricalSystemType

electricalSystemType

The ElectricalSystemTYpe 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 electrical 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.