Skip to content

SetDLComponentName.md

Latest commit

 

History

History
52 lines (41 loc) · 1 KB

SetDLComponentName.md

File metadata and controls

52 lines (41 loc) · 1 KB
Raw

SetDLComponentName

Description

Sets the name of the component at index in the Double Line Preferences.

FUNCTION SetDLComponentName(
				index         : INTEGER;
				componentName : STRING): BOOLEAN;
def vs.SetDLComponentName(index, componentName):
    return BOOLEAN

Parameters

Name Type Description
index INTEGER The index of the component.
componentName STRING The name of the component.

Remarks

CJG 3-23-07

Examples

resultOK := SetDLComponentName(1, 'Example');
import vs

# Sets the name of the component at index in the Double Line Preferences.
index = 1
componentName = 'Example'

ok = vs.SetDLComponentName(index, componentName)
if ok:
    vs.Message('SetDLComponentName succeeded')
else:
    vs.Message('SetDLComponentName failed')

See Also

VS Functions: GetDLComponentName

Version

Availability: from VectorWorks13.0

Category