Skip to content

GetObjStoryBoundsAt.md

Latest commit

 

History

History
53 lines (43 loc) · 1.4 KB

GetObjStoryBoundsAt.md

File metadata and controls

53 lines (43 loc) · 1.4 KB
Raw

GetObjStoryBoundsAt

Description

Return the story bound ID of the specified story bound index. The index is between 1 and the result of GetObjStoryBoundsCnt.

FUNCTION GetObjStoryBoundsAt(
				obj   : HANDLE;
				index : INTEGER): INTEGER;
def vs.GetObjStoryBoundsAt(obj, index):
    return INTEGER

Parameters

Name Type Description
obj HANDLE The object.
index INTEGER Index of the story bound which ID will be returned. This index should be between 1 and the result of GetObjStoryBoundsCnt.

Examples

resultN := GetObjStoryBoundsAt(obj, 1);
import vs

# Return the story bound ID of the specified story bound index.
obj = vs.FSActLayer()  # handle to the first selected object on the active layer
index = 1

resultN = vs.GetObjStoryBoundsAt(obj, index)
vs.Message('GetObjStoryBoundsAt returned: ' + str(resultN))

See Also

VS Functions: HasObjStoryBounds | HasObjStoryBound | GetObjStoryBound | SetObjectStoryBound | DelObjStoryBounds | DelObjStoryBound | GetObjStoryBoundsCnt | GetObjStoryBoundsAt

Version

Availability: from Vectorworks 2012

Category