VS:SetComponentName: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(Shorten OBJECT, reserved word) |
||
(One intermediate revision by one other user not shown) | |||
Line 11: | Line 11: | ||
<def> | <def> | ||
<funcDef lang="vs"> | <funcDef lang="vs"> | ||
FUNCTION SetComponentName( | FUNCTION SetComponentName(obj:HANDLE; componentIndex:INTEGER; componentName:STRING) : BOOLEAN; | ||
</funcDef> | </funcDef> | ||
<funcDef lang="py"> | <funcDef lang="py"> | ||
def vs.SetComponentName( | def vs.SetComponentName(obj, componentIndex, componentName): | ||
return BOOLEAN | return BOOLEAN | ||
</funcDef> | </funcDef> | ||
Line 23: | Line 23: | ||
<lineList ident=1> | <lineList ident=1> | ||
<line> | <line> | ||
obj | |||
HANDLE | HANDLE | ||
The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. | The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. |
Latest revision as of 20:07, 10 February 2016
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Sets the name of a component in an object.
FUNCTION SetComponentName(
obj :HANDLE;
componentIndex :INTEGER;
componentName :STRING) : BOOLEAN;
def vs.SetComponentName(obj, componentIndex, componentName): return BOOLEAN
Parameters
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. componentName STRING The name of the component.
Version
Availability: from VectorWorks 2008
See Also
VS Functions:
VS Functions:
[[VS:GetComponentName]]