linkedTextFrames(item, [cb])

Returns an array of all linked text frames or text paths in relation to a given Text Frame, Text Path, Story or Text Object. If a callback function is given, textFrames() calls this callback function on each text frame of the given container. When the callback function returns false, the loop stops and the textFrames() function returns an array of all text frames up to this point.

Type: function

Parameter(s):

  • item {TextFrame | TextPath | Story | TextObject}:

    The text frame, text path, story or text object of the text frame chain.

  • cb {Function} Optional:

    The callback function to call with each text frame or text path. When this function returns false the loop stops. Passed arguments: textFrame, loopCount.

Returns:

  • {Array}:

    The array of linked text frames or text paths.