Skip to content

SetComponentPenStyles.md

Latest commit

 

History

History
55 lines (45 loc) · 1.56 KB

SetComponentPenStyles.md

File metadata and controls

55 lines (45 loc) · 1.56 KB
Raw

SetComponentPenStyles

Description

Sets the left and right pen styles for a component in an object.

FUNCTION SetComponentPenStyles(
				obj            : HANDLE;
				componentIndex : INTEGER;
				leftPenStyle   : INTEGER;
				rightPenStyle  : INTEGER): BOOLEAN;
def vs.SetComponentPenStyles(obj, componentIndex, 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.
componentIndex INTEGER The index of the component.
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 := SetComponentPenStyles(obj, 1, 2, 3);
import vs

# Sets the left and right pen styles for a component in an object.
obj = vs.FSActLayer()  # handle to the first selected object on the active layer
componentIndex = 1
leftPenStyle = 0
rightPenStyle = 0

ok = vs.SetComponentPenStyles(obj, componentIndex, leftPenStyle, rightPenStyle)
if ok:
    vs.Message('SetComponentPenStyles succeeded')
else:
    vs.Message('SetComponentPenStyles failed')

See Also

VS Functions: GetComponentPenStyles

Version

Availability: from VectorWorks 12.0

Category