Difference between revisions of "VS:CreateStory"
From Vectorworks Developer
m (1 revision) |
m (fix typo) |
||
| Line 30: | Line 30: | ||
suffix | suffix | ||
STRING | STRING | ||
| − | The suffix to be used at the end of the name of a Layer | + | The suffix to be used at the end of the name of a Layer associated with the Story. |
</line> | </line> | ||
</lineList> | </lineList> | ||
Latest revision as of 03:15, 17 October 2018
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Creates a Story. Stories are used to group layers and are shown on the Story pane of the Organization dialog.FUNCTION CreateStory(
name :STRING;
suffix :STRING) : BOOLEAN;
def vs.CreateStory(name, suffix):
return BOOLEAN
Parameters
name STRING The name of the Story to create. suffix STRING The suffix to be used at the end of the name of a Layer associated with the Story.
Return Value
Whether the Story was successfully created.Example
VAR
success:BOOLEAN
BEGIN
success := CreateStory('4th Floor', '4');
Version
Availability: from Vectorworks 2012See Also
VS Functions:VS:GetNumStories | VS:GetStoryOfLayer | VS:AssociateLayerWithStory
VS Functions:
[[VS:GetNumStories]] | [[VS:GetStoryOfLayer]]
| [[VS:AssociateLayerWithStory]]