VS:GetComponentWallTopOffset

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

Description

Gets the offset from wall top of a component in an object.

FUNCTION GetComponentWallTopOffset(
                  object                  :HANDLE;
                  componentIndex          :INTEGER;
                  VAR offsetFromWallTop   :REAL) : BOOLEAN;

def vs.GetComponentWallTopOffset(object, componentIndex):
    return (BOOLEAN, offsetFromWallTop)

Parameters

object		HANDLE		The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex		INTEGER		The index of the component.
offsetFromWallTop		REAL		Returns the offset from wall top of the component.

Version

Availability: from Vectorworks 2011

See Also

VS Functions:

VS:SetComponentWallTopOffset

VS Functions: [[VS:SetComponentWallTopOffset]]