VS:Set2DComponentGroup

From Vectorworks Developer
Revision as of 00:46, 14 February 2019 by CBM-c- (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Description

Sets the specified 2D component group of a symbol definition or plug-in object. Use Top/Plan if you want to add the group into the main container of the object.


Table - 2D components

Constant 2D component
0 Not Set
1 Top
2 Bottom
3 Top and Bottom Cut
4 Front
5 Back
6 Front and Back Cut
7 Left
8 Right
9 Left and Right Cut
10 Top/Plan
FUNCTION Set2DComponentGroup(
objectHandle  :HANDLE;
groupHandle  :HANDLE;
component  :INTEGER) : BOOLEAN;
def vs.Set2DComponentGroup(objectHandle, groupHandle, component):
    return BOOLEAN

Parameters

objectHandle HANDLE Handle to the object.
groupHandle HANDLE Handle to the graphics group. Can be a group or a single object. To delete the corresponding group provide NULL.
component INTEGER 2D component.

Return Value

Returns TRUE if the operation was successful.

Version

Availability: from Vectorworks 2019

See Also

VS Functions:

VS:Get2DComponentGroup

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

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox