Skip to content

GetDLComponentUsePenClassAttr.md

Latest commit

 

History

History
51 lines (40 loc) · 1.45 KB

GetDLComponentUsePenClassAttr.md

File metadata and controls

51 lines (40 loc) · 1.45 KB
Raw

GetDLComponentUsePenClassAttr

Description

Gets the useclass attributes flags of the left and right side pens of the component at index in the Double Line Preferences.

FUNCTION GetDLComponentUsePenClassAttr(
				index                    : INTEGER;
				VAR leftPenUseClassAttr  : BOOLEAN;
				VAR rightPenUseClassAttr : BOOLEAN): BOOLEAN;
def vs.GetDLComponentUsePenClassAttr(index):
    return (BOOLEAN, leftPenUseClassAttr, rightPenUseClassAttr)

Parameters

Name Type Description
index INTEGER The index of the component.
leftPenUseClassAttr BOOLEAN Returns whether or not the component is using class attributes for its left pen.
rightPenUseClassAttr BOOLEAN Returns whether or not the component is using class attributes for right pen.

Remarks

CJG 3-23-07

Examples

resultOK := GetDLComponentUsePenClassAttr(1, TRUE, FALSE);
import vs

# Gets the useclass attributes flags of the left and right side pens of the
# component at index in the Double Line Preferences.
index = 1

ok, leftPenUseClassAttr, rightPenUseClassAttr = vs.GetDLComponentUsePenClassAttr(index)
vs.Message('GetDLComponentUsePenClassAttr returned: ' + str((ok, leftPenUseClassAttr, rightPenUseClassAttr)))

See Also

VS Functions: SetDLComponentUsePenClassAttr

Version

Availability: from VectorWorks13.0

Category