Create
Version comparisonPer-version detail
Click a version below to see what changed in that release vs your current frame (2020).
2020
current
Wire.Create(Document, ElementId, ElementId, WiringType, IList<XYZ>, Connector, Connector)
| document | Document | The document. |
| wireTypeId | ElementId | The id of the wire type of the newly created wire. |
| viewId | ElementId | 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: <ul><li>If there are 2 total points supplied, the wire is a straight-line wire.</li><li>If there are 3 total points supplied, the wire is a circular arc wire.</li><li>If there are 4 or more points, the wire is a spline wire.</li></ul> If the wiring type is WiringType.Chamfer, a polyline wire will be created connecting all the points. |
| vertexPoints | IList<XYZ> | The vertex point of the wire. If the startConnectorTo is <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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 <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, the last vertex of the vertexPoints will be the end point, otherwise, the end connector origin will be the end point. |
| startConnectorTo | Connector | The connector to which the wire start point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| endConnectorTo | Connector | The connector to which the wire end point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| → returns | Wire | The wire created. |
Wire.Create(Document, ElementId, ElementId, WiringType, IList<XYZ>, Connector, Connector)
| document | Document | The document. |
| wireTypeId | ElementId | The id of the wire type of the newly created wire. |
| viewId | ElementId | 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: <ul><li>If there are 2 total points supplied, the wire is a straight-line wire.</li><li>If there are 3 total points supplied, the wire is a circular arc wire.</li><li>If there are 4 or more points, the wire is a spline wire.</li></ul> If the wiring type is WiringType.Chamfer, a polyline wire will be created connecting all the points. |
| vertexPoints | IList<XYZ> | The vertex point of the wire. If the startConnectorTo is <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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 <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, the last vertex of the vertexPoints will be the end point, otherwise, the end connector origin will be the end point. |
| startConnectorTo | Connector | The connector to which the wire start point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| endConnectorTo | Connector | The connector to which the wire end point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| → returns | Wire | The wire created. |
Wire.Create(Document, ElementId, ElementId, WiringType, IList<XYZ>, Connector, Connector)
| document | Document | The document. |
| wireTypeId | ElementId | The id of the wire type of the newly created wire. |
| viewId | ElementId | 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: <ul><li>If there are 2 total points supplied, the wire is a straight-line wire.</li><li>If there are 3 total points supplied, the wire is a circular arc wire.</li><li>If there are 4 or more points, the wire is a spline wire.</li></ul> If the wiring type is WiringType.Chamfer, a polyline wire will be created connecting all the points. |
| vertexPoints | IList<XYZ> | The vertex point of the wire. If the startConnectorTo is <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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 <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, the last vertex of the vertexPoints will be the end point, otherwise, the end connector origin will be the end point. |
| startConnectorTo | Connector | The connector to which the wire start point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| endConnectorTo | Connector | The connector to which the wire end point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| → returns | Wire | The wire created. |
Wire.Create(Document, ElementId, ElementId, WiringType, IList<XYZ>, Connector, Connector)
| document | Document | The document. |
| wireTypeId | ElementId | The id of the wire type of the newly created wire. |
| viewId | ElementId | 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: <ul><li>If there are 2 total points supplied, the wire is a straight-line wire.</li><li>If there are 3 total points supplied, the wire is a circular arc wire.</li><li>If there are 4 or more points, the wire is a spline wire.</li></ul> If the wiring type is WiringType.Chamfer, a polyline wire will be created connecting all the points. |
| vertexPoints | IList<XYZ> | The vertex point of the wire. If the startConnectorTo is <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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 <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, the last vertex of the vertexPoints will be the end point, otherwise, the end connector origin will be the end point. |
| startConnectorTo | Connector | The connector to which the wire start point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| endConnectorTo | Connector | The connector to which the wire end point connects. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span>, 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. |
| → returns | Wire | The wire created. |