VS:GetComponentClass

From Vectorworks Developer
Jump to: navigation, search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Gets the class of a component in an object.
FUNCTION GetComponentClass(
obj  :HANDLE;
componentIndex  :INTEGER;
VAR componentClass  :LONGINT) : BOOLEAN;
def vs.GetComponentClass(obj, componentIndex):
    return (BOOLEAN, componentClass)

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.
componentClass LONGINT Returns the class of the component.

Remarks

To get the name of the class, use VS:Index2Name, not VS:ClassList to convert componentClass to a STRING.

Version

Availability: from VectorWorks 2008

See Also

VS Functions:

VS:SetComponentClass

VS Functions: [[VS:SetComponentClass]]
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox