| BeginColumn | Objects - Architectural MiniCAD7.0 |
VectorScript Declaration:
PROCEDURE BeginColumn
( columnDistance:REAL (Coordinate) ) ; Python:
return None
def vs.BeginColumn(columnDistance): Description:
Procedure BeginColumn creates a column object in a Vectorworks document using 2D object creation procedure calls to define the "template" for the column object.
After specifying object procedure calls to define the column, you should call EndGroup to complete the column definition and create the actual object.
Parameters:
columnDistance Height of column. Example:
BeginColumn(12'); Oval(2',2',6',6'); EndGroup;
| BeginFloor | Objects - Architectural MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE BeginFloor
( thicknessDistance:REAL (Coordinate) ) ; Python:
return None
def vs.BeginFloor(thicknessDistance): Description:
Procedure BeginFloor creates a new floor object in a Vectorworks document. BeginFloor uses 2D object creation procedure calls to define the "template" for the object.
After specifying object procedure calls to define the floor object, you should call EndGroup to complete the column definition and create the actual object.
Parameters:
thicknessDistance Floor thickness. Example:
BeginFloor(6"); Rect(1,1,5,5); EndGroup;
| ConvertToUnstyledSlab | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE ConvertToUnstyledSlab
( slab:HANDLE ) ; Python:
return None
def vs.ConvertToUnstyledSlab(slab): Description:
Sets a slab to be unstyled.Parameters:
slab The slab.
| CreateSlab | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION CreateSlab
( profile:HANDLE ) :HANDLE ; Python:
return HANDLE
def vs.CreateSlab(profile): Description:
Creates a slab.Parameters:
profile The profile from which to create the slab. Result:
The slab.See Also:
ModifySlab
| CreateSlabStyle | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION CreateSlabStyle
( slabStyleName:STRING ) :HANDLE ; Python:
return HANDLE
def vs.CreateSlabStyle(slabStyleName): Description:
Creates a new Slab Style of the given name. If the name is already in use, the next available name will be used.Parameters:
slabStyleName The name of the new Slab Style. If the name is already in use, the next available name will be used. Result:
The new Slab Style.
| DeleteAllComponents | Objects - Architectural VectorWorks12.5 |
VectorScript Declaration:
FUNCTION DeleteAllComponents
( object:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteAllComponents(object): Description:
Deletes all components in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
| DeleteComponent | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION DeleteComponent
( object :HANDLE; componentIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteComponent(object, componentIndex): Description:
Deletes a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component to delete. See Also:
InsertNewComponent
| DelObjStoryBound | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE DelObjStoryBound
( object :HANDLE; boundID :INTEGER ) ; Python:
return None
def vs.DelObjStoryBound(object, boundID): Description:
Delete the specified story bounds from this object.Parameters:
object The object. boundID The identifier of the story bound. See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| DelObjStoryBounds | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE DelObjStoryBounds
( object:HANDLE ) ; Python:
return None
def vs.DelObjStoryBounds(object): Description:
Delete all story bounds for this object.Parameters:
object The object. See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| GetCompBotIsRelStory | Objects - Architectural Vectorworks 2015 |
VectorScript Declaration:
FUNCTION GetCompBotIsRelStory
( object :HANDLE; componentIndex :INTEGER; VAR bottomIsRelativeToStory :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, bottomIsRelativeToStory)
def vs.GetCompBotIsRelStory(object, componentIndex): Description:
Gets whether or not the component bottom is relative to a story.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. bottomIsRelativeToStory Returns whether or not the component bottom is relative to a story. See Also:
SetCompBotIsRelStory
| GetComponentAutoBoundEdgeOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentAutoBoundEdgeOffset
( object :HANDLE; componentIndex :INTEGER; VAR autoBoundEdgeOffset :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, autoBoundEdgeOffset)
def vs.GetComponentAutoBoundEdgeOffset(object, componentIndex): Description:
Gets the auto-bound edge offset of a component in an object.Parameters:
object The object. Can be a slab, Slab Style, or the Slab Preferences. componentIndex The index of the component. autoBoundEdgeOffset Returns the auto-bound edge offset. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component See Also:
SetComponentAutoBoundEdgeOffset
| GetComponentClass | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetComponentClass
( object :HANDLE; componentIndex :INTEGER; VAR componentClass :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, componentClass)
def vs.GetComponentClass(object, componentIndex): Description:
Gets the class of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. componentClass Returns the class of the component. See Also:
SetComponentClass
| GetComponentFill | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetComponentFill
( object :HANDLE; componentIndex :INTEGER; VAR fill :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, fill)
def vs.GetComponentFill(object, componentIndex): Description:
Gets the fill of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. fill Returns the fill of the component. Positive values for patterns, negative ref numbers for hatches. See Also:
SetComponentFill
| GetComponentFillColors | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetComponentFillColors
( object :HANDLE; componentIndex :INTEGER; VAR fillForeColor :INTEGER; VAR fillBackColor :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, fillForeColor, fillBackColor)
def vs.GetComponentFillColors(object, componentIndex): Description:
Gets the fore and back fill colors of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. fillForeColor Returns the fore color of the fill. fillBackColor Returns the back color of the fill. See Also:
SetComponentFillColors
| GetComponentFollowBottomWallPeaks | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentFollowBottomWallPeaks
( object :HANDLE; componentIndex :INTEGER; VAR followBottomWallPeaks :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, followBottomWallPeaks)
def vs.GetComponentFollowBottomWallPeaks(object, componentIndex): Description:
Gets the follow bottom wall peaks flag of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. followBottomWallPeaks Returns whether or not the component is following bottom wall peaks. See Also:
SetComponentFollowBottomWallPeaks
| GetComponentFollowTopWallPeaks | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentFollowTopWallPeaks
( object :HANDLE; componentIndex :INTEGER; VAR followTopWallPeaks :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, followTopWallPeaks)
def vs.GetComponentFollowTopWallPeaks(object, componentIndex): Description:
Gets the follow top wall peaks flag of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. followTopWallPeaks Returns whether or not the component is following top wall peaks. See Also:
SetComponentFollowTopWallPeaks
| GetComponentManualEdgeOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentManualEdgeOffset
( object :HANDLE; componentIndex :INTEGER; VAR manualEdgeOffset :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, manualEdgeOffset)
def vs.GetComponentManualEdgeOffset(object, componentIndex): Description:
Gets the manual edge offset of a component in an object.Parameters:
object The object. Can be a slab, Slab Style, or the Slab Preferences. componentIndex The index of the component. manualEdgeOffset Returns the manual edge offset. See Also:
SetComponentManualEdgeOffset
| GetComponentName | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetComponentName
( object :HANDLE; componentIndex :INTEGER ) :STRING ; Python:
return STRING
def vs.GetComponentName(object, componentIndex): Description:
Gets the name of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. Result:
The name of the component.See Also:
SetComponentName
| GetComponentNetArea | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentNetArea
( object :HANDLE; componentIndex :INTEGER ) :REAL ; Python:
return REAL
def vs.GetComponentNetArea(object, componentIndex): Description:
Gets the net area of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. Result:
The net area of the component.See Also:
GetComponentNetVolume
| GetComponentNetVolume | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentNetVolume
( object :HANDLE; componentIndex :INTEGER ) :REAL ; Python:
return REAL
def vs.GetComponentNetVolume(object, componentIndex): Description:
Gets the net volume of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. Result:
The net volume of the component.See Also:
GetComponentNetArea
| GetComponentPenColors | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetComponentPenColors
( object :HANDLE; componentIndex :INTEGER; VAR leftPenForeColor :INTEGER; VAR leftPenBackColor :INTEGER; VAR rightPenForeColor :INTEGER; VAR rightPenBackColor :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor)
def vs.GetComponentPenColors(object, componentIndex): Description:
Gets the colors of the pens of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. leftPenForeColor Returns the fore color of the left pen. leftPenBackColor Returns the back color of the left pen. rightPenForeColor Returns the fore color of the right pen. rightPenBackColor Returns the back color of the right pen. See Also:
SetComponentPenColors
| GetComponentPenStyles | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetComponentPenStyles
( object :HANDLE; componentIndex :INTEGER; VAR leftPenStyle :INTEGER; VAR rightPenStyle :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, leftPenStyle, rightPenStyle)
def vs.GetComponentPenStyles(object, componentIndex): Description:
Gets the left and right side pen styles of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. leftPenStyle Returns the pen style of the component's left line. Positive values for patterns, negative values for dash styles. rightPenStyle Returns the pen style of the component's right line. Positive values for patterns, negative values for dash styles. See Also:
SetComponentPenStyles
| GetComponentPenWeights | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetComponentPenWeights
( object :HANDLE; componentIndex :INTEGER; VAR leftPenWeight :INTEGER; VAR rightPenWeight :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, leftPenWeight, rightPenWeight)
def vs.GetComponentPenWeights(object, componentIndex): Description:
Gets the pen weights of the left and right sides of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. leftPenWeight Returns the pen weight of the component's left line. rightPenWeight Returns the pen weight of the component's right line. See Also:
SetComponentPenWeights
| GetComponents | Objects - Architectural Vectorworks 2015 |
VectorScript Declaration:
FUNCTION GetComponents
( object:HANDLE ) :HANDLE ; Python:
return HANDLE
def vs.GetComponents(object): Description:
Gets the components of the object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
| GetComponentTexture | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentTexture
( object :HANDLE; componentIndex :INTEGER; VAR texture :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, texture)
def vs.GetComponentTexture(object, componentIndex): Description:
Gets the texture of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. texture Returns the ref number of the texture. 0 for no texture. -1 for class texture. See Also:
SetComponentTexture
| GetComponentUseFillClassAttr | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetComponentUseFillClassAttr
( object :HANDLE; componentIndex :INTEGER; VAR useFillClassAttributes :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, useFillClassAttributes)
def vs.GetComponentUseFillClassAttr(object, componentIndex): Description:
Gets the use fill class attributes flag of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. useFillClassAttributes Returns whether or not the component is using class attributes for its fill. See Also:
SetComponentUseFillClassAttr
| GetComponentUsePenClassAttr | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetComponentUsePenClassAttr
( object :HANDLE; componentIndex :INTEGER; VAR useLeftPenClassAttributes :BOOLEAN; VAR useRightPenClassAttributes :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, useLeftPenClassAttributes, useRightPenClassAttributes)
def vs.GetComponentUsePenClassAttr(object, componentIndex): Description:
Gets the use class attributes flags of the pens of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. useLeftPenClassAttributes Returns whether or not the component is using class attributes for its left pen. useRightPenClassAttributes Returns whether or not the component is using class attributes for its right pen. See Also:
SetComponentUsePenClassAttr
| GetComponentWallBottomOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentWallBottomOffset
( object :HANDLE; componentIndex :INTEGER; VAR offsetFromWallBottom :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, offsetFromWallBottom)
def vs.GetComponentWallBottomOffset(object, componentIndex): Description:
Gets the offset from wall bottom of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. offsetFromWallBottom Returns the offset from wall bottom of the component. See Also:
SetComponentWallBottomOffset
| GetComponentWallTopOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetComponentWallTopOffset
( object :HANDLE; componentIndex :INTEGER; VAR offsetFromWallTop :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, offsetFromWallTop)
def vs.GetComponentWallTopOffset(object, componentIndex): Description:
Gets the offset from wall top of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. offsetFromWallTop Returns the offset from wall top of the component. See Also:
SetComponentWallTopOffset
| GetComponentWidth | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetComponentWidth
( object :HANDLE; componentIndex :INTEGER; VAR width :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, width)
def vs.GetComponentWidth(object, componentIndex): Description:
Gets the width of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. width Returns the width of the component. See Also:
SetComponentWidth
| GetCompTopIsRelStory | Objects - Architectural Vectorworks 2015 |
VectorScript Declaration:
FUNCTION GetCompTopIsRelStory
( object :HANDLE; componentIndex :INTEGER; VAR topIsRelativeToStory :BOOLEAN ) :BOOLEAN ; Python:
return (BOOLEAN, topIsRelativeToStory)
def vs.GetCompTopIsRelStory(object, componentIndex): Description:
Gets whether or not the component top is relative to a story.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. topIsRelativeToStory Returns whether or not the component top is relative to a story. See Also:
SetCompTopIsRelStory
| GetCoreWallComponent | Objects - Architectural Vectorworks 2010 |
VectorScript Declaration:
FUNCTION GetCoreWallComponent
( object:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetCoreWallComponent(object): Description:
Gets the core wall component of an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. Result:
The index of the core wall component. If it is 0, there is no core wall component.See Also:
SetCoreWallComponent
| GetDatumSlabComponent | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetDatumSlabComponent
( object:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetDatumSlabComponent(object): Description:
Gets the datum slab component of an object.Parameters:
object The object. Can be a slab, Slab Style, or the Slab Preferences. Result:
The index of the datum slab component.See Also:
SetDatumSlabComponent
| GetNumberOfComponents | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetNumberOfComponents
( object :HANDLE; VAR numComponents :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, numComponents)
def vs.GetNumberOfComponents(object): Description:
Gets the number of components in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. numComponents Returns the number of components.
| GetObjBoundElevation | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetObjBoundElevation
( object :HANDLE; boundID :INTEGER ) :REAL ; Python:
return REAL
def vs.GetObjBoundElevation(object, boundID): Description:
Get the elevation of the specified bound ID relative to the object's layer.Parameters:
object The object. boundID The identifier of the story bound. Result:
Return the elevation of the specified bound ID relative to the object's layer.See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| GetObjStoryBound | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetObjStoryBound
( object :HANDLE; boundID :INTEGER; VAR boundType :INTEGER; VAR boundStory :INTEGER; VAR layerLevelType :STRING; VAR offset :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, boundType, boundStory, layerLevelType, offset)
def vs.GetObjStoryBound(object, boundID): Description:
Get the data of the specified story bound of this object.Parameters:
object The object. boundID The identifier of the story bound. boundType Bounding type: 0 - DefaultWallHeight; 1 - LayerZ; 2 - Story boundStory The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below. layerLevelType The layer type which defines this bound offset The offset distance from the specified bound story Result:
Return TRUE if the operation is successful.See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| GetObjStoryBoundsAt | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetObjStoryBoundsAt
( object :HANDLE; index :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetObjStoryBoundsAt(object, index): Description:
Return the story bound ID of the specified story bound index. The index is between 1 and the result of GetObjStoryBoundsCnt.Parameters:
object The object. index Index of the story bound which ID will be returned. This index should be between 1 and the result of GetObjStoryBoundsCnt. Result:
Return the story bound ID.See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| GetObjStoryBoundsCnt | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetObjStoryBoundsCnt
( object:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetObjStoryBoundsCnt(object): Description:
Return the number of story bounds defined for this object.Parameters:
object The object. Result:
The number of story bounds for this object.See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| GetSlabHeight | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetSlabHeight
( slab:HANDLE ) :REAL ; Python:
return REAL
def vs.GetSlabHeight(slab): Description:
Gets the height of a slab.Parameters:
slab The slab. Result:
The height of the slab.See Also:
SetSlabHeight
| GetSlabPreferences | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetSlabPreferences
:HANDLE ; Python:
return HANDLE
def vs.GetSlabPreferences(): Description:
Gets the Slab Preferences. This can be used with the component calls and the Style selectors.Result:
The Slab Preferences.
| GetSlabPreferencesStyle | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetSlabPreferencesStyle
:LONGINT ; Python:
return LONGINT
def vs.GetSlabPreferencesStyle(): Description:
Gets the Slab Style of the Slab Preferences.Result:
The ref number of the Slab Style of the Slab Preferences. 0 for unstyled.See Also:
SetSlabPreferencesStyle
| GetSlabStyle | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetSlabStyle
( slab:HANDLE ) :LONGINT ; Python:
return LONGINT
def vs.GetSlabStyle(slab): Description:
Gets the Slab Style of a slab.Parameters:
slab The slab. Result:
The ref number of the Slab Style of the slab. 0 for unstyled.See Also:
SetSlabStyle
| GetStoryLayerInfo | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetStoryLayerInfo
( index :INTEGER; VAR name :STRING; VAR scaleFactor :REAL; VAR layerLevelType :STRING; VAR eleveationOffset :REAL; VAR defaultWallHeight :REAL ) :Boolean ; Python:
return (Boolean, name, scaleFactor, layerLevelType, eleveationOffset, defaultWallHeight)
def vs.GetStoryLayerInfo(index): Description:
Returns information on the given story layer templateParameters:
index Index of story. name Returns with Name of story layer template scaleFactor Returns with Scale Factor of story layer template layerLevelType Returns with Level Type of story layer template eleveationOffset Returns with the Elevation Offset of story layer template defaultWallHeight Returns with the Default Wall Height of story layer template Result:
Boolean - TRUE if the story at given index was found, FALSE if no story was found at the given index.
| GetWallPreferences | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetWallPreferences
:HANDLE ; Python:
return HANDLE
def vs.GetWallPreferences(): Description:
Gets the Wall Preferences. This can be used with the component calls and the Style selectors.Result:
The Wall Preferences.
| HasObjStoryBound | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION HasObjStoryBound
( object :HANDLE; boundID :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.HasObjStoryBound(object, boundID): Description:
Determine if the object has the specified story bound ID present.Parameters:
object The object. boundID The identifier of the story bound. Result:
Retrun TRUE if the story bound ID is present. Otherwise - FALSE.See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| HasObjStoryBounds | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
FUNCTION HasObjStoryBounds
( object:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.HasObjStoryBounds(object): Description:
Determine if the object has any story bounds.Parameters:
object The object. Result:
Return TRUE if the object has any story bounds. Otherwise - FALSE.See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| InsertNewComponent | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION InsertNewComponent
( object :HANDLE; beforeComponentIndex :INTEGER; width :REAL (Coordinate); fill :LONGINT; leftPenWeight :INTEGER; rightPenWeight :INTEGER; leftPenStyle :INTEGER; rightPenStyle :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.InsertNewComponent(object, beforeComponentIndex, width, fill, leftPenWeight, rightPenWeight, leftPenStyle, rightPenStyle): Description:
Inserts a new component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. beforeComponentIndex The index before which to insert the new component. width The width of the component. fill The fill of the component. Positive values for patterns, negative ref numbers for hatches. leftPenWeight The pen weight of the component's left line. rightPenWeight The pen weight of the component's right line. leftPenStyle The pen style of the component's left line. Positive values for patterns, negative values for dash styles. rightPenStyle The pen style of the component's right line. Positive values for patterns, negative values for dash styles. See Also:
DeleteComponent
| MakeCornerWindow | Objects - Architectural Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE MakeCornerWindow
( hWindow :HANDLE; hWall :HANDLE; cornerWindow :BOOLEAN; NoneClass :STRING; Sill2DClass :STRING; IsFlipped :BOOLEAN ) ; Python:
return None
def vs.MakeCornerWindow(hWindow, hWall, cornerWindow, NoneClass, Sill2DClass, IsFlipped): Description:
Moves a window into corner position.
| ModifySlab | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION ModifySlab
( slab :HANDLE; modifier :HANDLE; isClipObject :BOOLEAN; componentFlags :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.ModifySlab(slab, modifier, isClipObject, componentFlags): Description:
Adds to or clips from a slab.Parameters:
slab The slab. modifier The adding or clipping object. isClipObject Whether the modifier is an add object or a clip object. componentFlags Bit flags that indicate which components will be affected by the modification. Result:
Whether or not the modification succeeds.See Also:
CreateSlab
| SetCompBotIsRelStory | Objects - Architectural Vectorworks 2015 |
VectorScript Declaration:
FUNCTION SetCompBotIsRelStory
( object :HANDLE; componentIndex :INTEGER; bottomIsRelativeToStory :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetCompBotIsRelStory(object, componentIndex, bottomIsRelativeToStory): Description:
Sets whether or not the component bottom is relative to a story.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. bottomIsRelativeToStory Whether or not the component bottom is relative to a story. See Also:
GetCompBotIsRelStory
| SetComponentAutoBoundEdgeOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentAutoBoundEdgeOffset
( object :HANDLE; componentIndex :INTEGER; autoBoundEdgeOffset :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentAutoBoundEdgeOffset(object, componentIndex, autoBoundEdgeOffset): Description:
Sets the auto-bound edge offset of a component in an object.Parameters:
object The object. Can be a slab, Slab Style, or the Slab Preferences. componentIndex The index of the component. autoBoundEdgeOffset The auto-bound edge offset. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component See Also:
GetComponentAutoBoundEdgeOffset
| SetComponentClass | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetComponentClass
( object :HANDLE; componentIndex :INTEGER; componentClass :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentClass(object, componentIndex, componentClass): Description:
Sets the class of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. componentClass The class of the component. See Also:
GetComponentClass
| SetComponentFill | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetComponentFill
( object :HANDLE; componentIndex :INTEGER; fill :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentFill(object, componentIndex, fill): Description:
Sets the fill of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. fill The fill of the component. Positive values for patterns, negative object indexes for hatches. See Also:
GetComponentFill
| SetComponentFillColors | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetComponentFillColors
( object :HANDLE; componentIndex :INTEGER; fillForeColor :INTEGER; fillBackColor :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentFillColors(object, componentIndex, fillForeColor, fillBackColor): Description:
Sets the fore and back fill colors of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. fillForeColor The fore color of the fill. fillBackColor The back color of the fill. See Also:
GetComponentFillColors
| SetComponentFollowBottomWallPeaks | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentFollowBottomWallPeaks
( object :HANDLE; componentIndex :INTEGER; followBottomWallPeaks :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentFollowBottomWallPeaks(object, componentIndex, followBottomWallPeaks): Description:
Sets the follow bottom wall peaks flag of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. followBottomWallPeaks Whether or not the component will follow bottom wall peaks. See Also:
GetComponentFollowBottomWallPeaks
| SetComponentFollowTopWallPeaks | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentFollowTopWallPeaks
( object :HANDLE; componentIndex :INTEGER; followTopWallPeaks :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentFollowTopWallPeaks(object, componentIndex, followTopWallPeaks): Description:
Sets the follow top wall peaks flag of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. followTopWallPeaks Whether or not the component will follow top wall peaks. See Also:
GetComponentFollowTopWallPeaks
| SetComponentManualEdgeOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentManualEdgeOffset
( object :HANDLE; componentIndex :INTEGER; manualEdgeOffset :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentManualEdgeOffset(object, componentIndex, manualEdgeOffset): Description:
Sets the manual edge offset of a component in an object.Parameters:
object The object. Can be a slab, Slab Style, or the Slab Preferences. componentIndex The index of the component. manualEdgeOffset The manual edge offset. See Also:
GetComponentManualEdgeOffset
| SetComponentName | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetComponentName
( object :HANDLE; componentIndex :INTEGER; componentName :STRING ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentName(object, componentIndex, componentName): Description:
Sets the name of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. componentName The name of the component. See Also:
GetComponentName
| SetComponentPenColors | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetComponentPenColors
( object :HANDLE; componentIndex :INTEGER; leftPenForeColor :INTEGER; leftPenBackColor :INTEGER; rightPenForeColor :INTEGER; rightPenBackColor :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentPenColors(object, componentIndex, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor): Description:
Sets the colors of the pens of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. leftPenForeColor The fore color of the left pen. leftPenBackColor The back color of the left pen. rightPenForeColor The fore color of the right pen. rightPenBackColor The back color of the right pen. See Also:
GetComponentPenColors
| SetComponentPenStyles | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetComponentPenStyles
( object :HANDLE; componentIndex :INTEGER; leftPenStyle :INTEGER; rightPenStyle :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentPenStyles(object, componentIndex, leftPenStyle, rightPenStyle): Description:
Sets the left and right pen styles for a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. leftPenStyle The pen style of the component's left line. Positive values for patterns, negative values for dash styles. rightPenStyle The pen style of the component's right line. Positive values for patterns, negative values for dash styles. See Also:
GetComponentPenStyles
| SetComponentPenWeights | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetComponentPenWeights
( object :HANDLE; componentIndex :INTEGER; leftPenWeight :INTEGER; rightPenWeight :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentPenWeights(object, componentIndex, leftPenWeight, rightPenWeight): Description:
Sets the left and right pen weights for a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. leftPenWeight The pen weight of the component's left line. rightPenWeight The pen weight of the component's right line. See Also:
GetComponentPenWeights
| SetComponentTexture | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentTexture
( object :HANDLE; componentIndex :INTEGER; texture :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentTexture(object, componentIndex, texture): Description:
Sets the texture of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. texture The ref number of the texture. 0 for no texture. -1 for class texture. See Also:
GetComponentTexture
| SetComponentUseFillClassAttr | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetComponentUseFillClassAttr
( object :HANDLE; componentIndex :INTEGER; useFillClassAttributes :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentUseFillClassAttr(object, componentIndex, useFillClassAttributes): Description:
Sets the use fill class attributes flag of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. useFillClassAttributes Whether or not the component will use class attributes for its fill. See Also:
GetComponentUseFillClassAttr
| SetComponentUsePenClassAttr | Objects - Architectural VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetComponentUsePenClassAttr
( object :HANDLE; componentIndex :INTEGER; useLeftPenClassAttributes :BOOLEAN; useRightPenClassAttributes :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentUsePenClassAttr(object, componentIndex, useLeftPenClassAttributes, useRightPenClassAttributes): Description:
Sets the use class attributes flags of the pens of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. useLeftPenClassAttributes Whether or not the component will use class attributes for its left pen. useRightPenClassAttributes Whether or not the component will use class attributes for its right pen. See Also:
GetComponentUsePenClassAttr
| SetComponentWallBottomOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentWallBottomOffset
( object :HANDLE; componentIndex :INTEGER; offsetFromWallBottom :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentWallBottomOffset(object, componentIndex, offsetFromWallBottom): Description:
Sets the offset from wall bottom of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. offsetFromWallBottom The offset from wall bottom of the component. See Also:
GetComponentWallBottomOffset
| SetComponentWallTopOffset | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetComponentWallTopOffset
( object :HANDLE; componentIndex :INTEGER; offsetFromWallTop :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentWallTopOffset(object, componentIndex, offsetFromWallTop): Description:
Sets the offset from wall top of a component in an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. offsetFromWallTop The offset from wall top of the component. See Also:
GetComponentWallTopOffset
| SetComponentWidth | Objects - Architectural VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetComponentWidth
( object :HANDLE; componentIndex :INTEGER; width :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetComponentWidth(object, componentIndex, width): Description:
Sets the width of a component in an object.Parameters:
object The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex The index of the component. width The width of the component. See Also:
GetComponentWidth
| SetCompTopIsRelStory | Objects - Architectural Vectorworks 2015 |
VectorScript Declaration:
FUNCTION SetCompTopIsRelStory
( object :HANDLE; componentIndex :INTEGER; topIsRelativeToStory :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetCompTopIsRelStory(object, componentIndex, topIsRelativeToStory): Description:
Sets whether or not the component top is relative to a story.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. componentIndex The index of the component. topIsRelativeToStory Whether or not the component top is relative to a story. See Also:
GetCompTopIsRelStory
| SetCoreWallComponent | Objects - Architectural Vectorworks 2010 |
VectorScript Declaration:
PROCEDURE SetCoreWallComponent
( object :HANDLE; coreWallComponent :INTEGER ) ; Python:
return None
def vs.SetCoreWallComponent(object, coreWallComponent): Description:
Sets the core wall component of an object.Parameters:
object The object. Can be a wall, round wall, Wall Style, or the Wall Preferences. coreWallComponent The index of the core wall component. 0 will cause there to be no core wall component. See Also:
GetCoreWallComponent
| SetDatumSlabComponent | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SetDatumSlabComponent
( object :HANDLE; datumSlabComponent :INTEGER ) ; Python:
return None
def vs.SetDatumSlabComponent(object, datumSlabComponent): Description:
Sets the datum slab component of an object.Parameters:
object The object. Can be a slab, Slab Style, or the Slab Preferences. datumSlabComponent The index of the datum slab component. See Also:
GetDatumSlabComponent
| SetObjectStoryBound | Objects - Architectural Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE SetObjectStoryBound
( object :HANDLE; boundID :INTEGER; boundType :INTEGER; boundStory :INTEGER; layerLevelType :STRING; offset :REAL ) ; Python:
return None
def vs.SetObjectStoryBound(object, boundID, boundType, boundStory, layerLevelType, offset): Description:
Set the data of the specified story bound of this object.Parameters:
object The object. boundID The identifier of the story bound. boundType Bounding type: 0 - LayerZ; 1 - DefaultWallHeight; 2 - Story boundStory The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below. layerLevelType The layer type which defines this bound offset The offset distance from the specified bound story See Also:
HasObjStoryBounds HasObjStoryBound GetObjStoryBound SetObjectStoryBound DelObjStoryBounds DelObjStoryBound GetObjStoryBoundsCnt GetObjStoryBoundsAt
| SetSlabHeight | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SetSlabHeight
( slab :HANDLE; height :REAL (Coordinate) ) ; Python:
return None
def vs.SetSlabHeight(slab, height): Description:
Sets the height of a slab.Parameters:
slab The slab. height The height of the slab. See Also:
GetSlabHeight
| SetSlabPreferencesStyle | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SetSlabPreferencesStyle
( slabStyle:LONGINT ) ; Python:
return None
def vs.SetSlabPreferencesStyle(slabStyle): Description:
Sets the Slab Style of the Slab Preferences.Parameters:
slabStyle The ref number of the Slab Style to apply to the Slab Preferences. 0 for unstyled. See Also:
GetSlabPreferencesStyle
| SetSlabStyle | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SetSlabStyle
( slab :HANDLE; slabStyle :LONGINT ) ; Python:
return None
def vs.SetSlabStyle(slab, slabStyle): Description:
Sets the Slab Style of a slab.Parameters:
slab The slab. slabStyle The ref number of the Slab Style to apply to the slab. 0 for unstyled. See Also:
GetSlabStyle
| SlabFromPoly | Objects - Architectural Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SlabFromPoly
( poly:HANDLE ) ; Python:
return None
def vs.SlabFromPoly(poly): Description:
Creates a slab object from the referenced polyline. The current settings for the slab object are used to create the new slab.Parameters:
poly The polyline that the slab will be created from.
| SyncMatrixToBound | Objects - Architectural Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE SyncMatrixToBound
( object :HANDLE; BoundID :INTEGER ) ; Python:
return None
def vs.SyncMatrixToBound(object, BoundID): Description:
Synchronize the object's matrix with the specified story bound.Parameters:
object The object handle. BoundID The identifier of the story bound.