M

Wire.Create

Description:
Creates a new wire.

public static Wire Create(
	Document document,
	ElementId wireTypeId,
	ElementId viewId,
	WiringType wiringType,
	IList<XYZ> vertexPoints,
	Connector startConnectorTo,
	Connector endConnectorTo
)

Public Shared Function Create ( 
	document As Document,
	wireTypeId As ElementId,
	viewId As ElementId,
	wiringType As WiringType,
	vertexPoints As IList(Of XYZ),
	startConnectorTo As Connector,
	endConnectorTo As Connector
) As Wire

public:
static Wire^ Create(
	Document^ document, 
	ElementId^ wireTypeId, 
	ElementId^ viewId, 
	WiringType wiringType, 
	IList<XYZ^>^ vertexPoints, 
	Connector^ startConnectorTo, 
	Connector^ endConnectorTo
)

static member Create : 
        document : Document * 
        wireTypeId : ElementId * 
        viewId : ElementId * 
        wiringType : WiringType * 
        vertexPoints : IList<XYZ> * 
        startConnectorTo : Connector * 
        endConnectorTo : Connector -> Wire

Document

document

The document.
ElementId

wireTypeId

The id of the wire type of the newly created wire.
ElementId

viewId

The view in which the wire is to be visible. This must be the id of a floor plan or reflected ceiling plan view.
WiringType

wiringType
Specifiies the wiring type for the newly created wire. The shape of the wire is determined by this value and the total number of points supplied via the vertexPoints and endpoint connectors. If the wiring type is WiringType.Arc:
- If there are 2 total points supplied, the wire is a straight-line wire.
- If there are 3 total points supplied, the wire is a circular arc wire.
- If there are 4 or more points, the wire is a spline wire.
If the wiring type is WiringType.Chamfer, a polyline wire will be created connecting all the points.
IList<XYZ>

vertexPoints

The vertex point of the wire. If the startConnectorTo is null, the first vertex of the vertexPoints will be the start point, otherwise, the start connector origin will be the start point. If the endConnectorTo is null, the last vertex of the vertexPoints will be the end point, otherwise, the end connector origin will be the end point.
Connector

startConnectorTo

The connector to which the wire start point connects. If null, the start point connects to no existing connector. If set with a connector, the connector's origin will be added to the wire's vertices as the start point.
Connector

endConnectorTo

The connector to which the wire end point connects. If null, the end point connects to no existing connector. If set with a connector, the connector's origin will be added to the wire's vertices as the end point.

Return Value Wire The wire created.

// Create an unconnected straight line wire between two points
public Wire CreateWire(Document document)
{
    Wire wire = null;

    FilteredElementCollector collector = new FilteredElementCollector(document);
    IList<Element> wireTypes = collector.OfCategory(BuiltInCategory.OST_Wire).WhereElementIsElementType().ToElements();
    WireType wireType = wireTypes.First() as WireType;

    if (wireType != null)
    {
        IList<XYZ> wireVertices = new List<XYZ>();
        wireVertices.Add(new XYZ(0, 0, 0));
        wireVertices.Add(new XYZ(2, 0, 0));

        wire = Wire.Create(document, wireType.Id, document.ActiveView.Id, WiringType.Arc, wireVertices, null, null);
    }

    return wire;
}

ArgumentException

wireTypeId is not a valid WireType id. -or- viewId does not represent a view valid for a Wire element. Either a floor plan or reflected ceiling plan is expected. -or- vertexPoints is not valid, because one or more points are coincident by comparing the X and Y of the points, or there are not at least two points including the connectors. -or- startConnectorTo cannot be connected to a wire, as it is not an electrical connector. -or- endConnectorTo cannot be connected to a wire, as it is not an electrical connector.
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

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