M

Document.NewFlexDuct

Description:
Adds a new flexible duct into the document, using two connector, and duct type.

Remarks:
If the connectors are fitting or equipment connectors of the correct domain, and if the connectors' direction match the direction of the flexible duct to be created, the connectors will be automatically connected. A transition fitting will be added at the connector(s) if necessary. If the connector's type, domain, does not match the one of the input connector, no connection will be established.

Overloads (3):

NewFlexDuct

NewFlexDuct(Connector,Connector,FlexDuctType)

NewFlexDuct(Connector,IList[XYZ],FlexDuctType)

NewFlexDuct(IList[XYZ],FlexDuctType)

public FlexDuct NewFlexDuct(
	Connector connector1,
	Connector connector2,
	FlexDuctType ductType
)

Public Function NewFlexDuct ( 
	connector1 As Connector,
	connector2 As Connector,
	ductType As FlexDuctType
) As FlexDuct

public:
FlexDuct^ NewFlexDuct(
	Connector^ connector1, 
	Connector^ connector2, 
	FlexDuctType^ ductType
)

member NewFlexDuct : 
        connector1 : Connector * 
        connector2 : Connector * 
        ductType : FlexDuctType -> FlexDuct

Connector

connector1

The first connector to be connected to the duct.
Connector

connector2

The second connector to be connected to the duct.
FlexDuctType

ductType

The type of the flexible duct.

Return Value FlexDuct If creation was successful then a new flexible duct is returned, otherwise an exception with failure information will be thrown.

ArgumentNullException

Thrown when the input argument connector1 or connector2 is.
InvalidOperationException

Thrown when the flexible duct cannot be created or regenerate fails.
ArgumentException

Thrown if the flexible duct type does not exist in the given document.