Skip to content

GetStoryOfLayer.md

Latest commit

 

History

History
58 lines (44 loc) · 1.12 KB

GetStoryOfLayer.md

File metadata and controls

58 lines (44 loc) · 1.12 KB
Raw

GetStoryOfLayer

Description

Returns the Story that the indicated Layer is associated with. Returns NULL if the Layer is not associated with a Story.

FUNCTION GetStoryOfLayer(layer : HANDLE): HANDLE;
def vs.GetStoryOfLayer(layer):
    return HANDLE

Parameters

Name Type Description
layer HANDLE The Layer for which the associated Story is returned.

Examples

VAR

story:HANDLE;

BEGIN

story:=GetStoryOfLayer(ActLayer);
BEGIN
	{ get current. }
	storyH         := GetStoryOfLayer( layerH );
import vs

# Returns the Story that the indicated Layer is associated with.
layer = vs.ActLayer()  # handle to the active design layer

objHandle = vs.GetStoryOfLayer(layer)
if objHandle is not None:
    vs.Message('Created object handle: ' + str(objHandle))

See Also

VS Functions: GetLayerForStory | GetNumStories | CreateStory | AssociateLayerWithStory

Version

Availability: from Vectorworks 2012

Category