Skip to content

InsertNewComponent.md

Latest commit

 

History

History
67 lines (57 loc) · 2.12 KB

InsertNewComponent.md

File metadata and controls

67 lines (57 loc) · 2.12 KB
Raw

InsertNewComponent

Description

Inserts a new component in an object.

FUNCTION InsertNewComponent(
				obj                  : HANDLE;
				beforeComponentIndex : INTEGER;
				width                : REAL;
				fill                 : LONGINT;
				leftPenWeight        : INTEGER;
				rightPenWeight       : INTEGER;
				leftPenStyle         : INTEGER;
				rightPenStyle        : INTEGER): BOOLEAN;
def vs.InsertNewComponent(obj, beforeComponentIndex, width, fill, leftPenWeight, rightPenWeight, leftPenStyle, rightPenStyle):
    return BOOLEAN

Parameters

Name Type Description
obj HANDLE The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
beforeComponentIndex INTEGER The index before which to insert the new component.
width REAL The width of the component.
fill LONGINT The fill of the component. Positive values for patterns, negative ref numbers for hatches.
leftPenWeight INTEGER The pen weight of the component's left line.
rightPenWeight INTEGER The pen weight of the component's right line.
leftPenStyle INTEGER The pen style of the component's left line. Positive values for patterns, negative values for dash styles.
rightPenStyle INTEGER The pen style of the component's right line. Positive values for patterns, negative values for dash styles.

Examples

resultOK := InsertNewComponent(obj, 1, 1.0, 2, 3, 10, 5, 1);
import vs

# Inserts a new component in an object.
obj = vs.FSActLayer()  # handle to the first selected object on the active layer
beforeComponentIndex = 1
width = 2.0
fill = 1
leftPenWeight = 2
rightPenWeight = 3
leftPenStyle = 0
rightPenStyle = 0

ok = vs.InsertNewComponent(obj, beforeComponentIndex, width, fill, leftPenWeight, rightPenWeight, leftPenStyle, rightPenStyle)
if ok:
    vs.Message('InsertNewComponent succeeded')
else:
    vs.Message('InsertNewComponent failed')

See Also

VS Functions: DeleteComponent

Version

Availability: from VectorWorks 12.0

Category