Skip to content

GetObjectVariableString.md

Latest commit

 

History

History
67 lines (54 loc) · 1.58 KB

GetObjectVariableString.md

File metadata and controls

67 lines (54 loc) · 1.58 KB
Raw

GetObjectVariableString

Description

Returns the value of a VectorWorks object property. Used with properties returning a STRING value.

For specific object selector index values, see the Script Appendix.

FUNCTION GetObjectVariableString(
				h     : HANDLE;
				index : INTEGER): STRING;
def vs.GetObjectVariableString(h, index):
    return STRING

Parameters

Name Type Description
h HANDLE Handle to object.
index INTEGER Object property index.

Examples

VectorScript

dimstdName:= GetObjectVariableString(h,27);

Python

dimstdName = vs.GetObjectVariableString(h,27)
BEGIN
IF GetObjectVariableString(TempH1,kVPLocatorVar) <> '' THEN
	SetRField(ActiveParmHand,ActiveRecName,kNNA_ItemName,GetObjectVariableString(TempH1,kVPLocatorVar));
SetRField(ActiveParmHand,ActiveRecName,kNNA_SheetName, GetLName(GetLayer(TempH1)));
END;

BEGIN
vpTitle := GetObjectVariableString(vpHand, 1032);
gTitle := vpTitle;
END;

BEGIN
	returnPos := 0;
	currFieldValue := GetRField(pluginH, recordName, fieldName);
	newFieldValue := GetObjectVariableString(pluginLayer, 159);
import vs

# Returns the value of a VectorWorks object property.
h = vs.FSActLayer()  # handle to the first selected object on the active layer
index = 1

text = vs.GetObjectVariableString(h, index)
vs.Message('GetObjectVariableString returned: ' + str(text))

Version

Availability: from VectorWorks9.0

Category