Skip to content

GetCompPenStylesN.md

Latest commit

 

History

History
50 lines (40 loc) · 1.4 KB

GetCompPenStylesN.md

File metadata and controls

50 lines (40 loc) · 1.4 KB
Raw

GetCompPenStylesN

Description

Gets the pen styles of a component in an object.

FUNCTION GetCompPenStylesN(
				object            : HANDLE;
				componentIndex    : INTEGER;
				VAR leftPenStyle  : LONGINT;
				VAR rightPenStyle : LONGINT): BOOLEAN;
def vs.GetCompPenStylesN(object, componentIndex):
    return (BOOLEAN, leftPenStyle, rightPenStyle)

Parameters

Name Type Description
object HANDLE The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.
componentIndex INTEGER The index of the component.
leftPenStyle LONGINT Returns the left pen style of the component.
rightPenStyle LONGINT Returns the right pen style of the component.

Examples

resultOK := GetCompPenStylesN(object, 1, 2, 3);
import vs

# Gets the pen styles of a component in an object.
object = vs.FSActLayer()  # handle to the first selected object on the active layer
componentIndex = 1

ok, leftPenStyle, rightPenStyle = vs.GetCompPenStylesN(object, componentIndex)
vs.Message('GetCompPenStylesN returned: ' + str((ok, leftPenStyle, rightPenStyle)))

See Also

VS Functions: SetCompPenStylesN

Version

Availability: from Vectorworks 2016

Category