Site Tools


New release available: 2020-07-29 "Hogfather". upgrade now! [51.3] (what's this?)
New release candidate 3 available: 2020-06-09 "Hogfather". upgrade now! [51.2] (what's this?)
New release candidate 2 available: 2020-06-01 "Hogfather". upgrade now! [51.1] (what's this?)
New release candidate available: 2020-06-01 "Hogfather". upgrade now! [51] (what's this?)
Hotfix release available: 2018-04-22c "Greebo". upgrade now! [50.3] (what's this?)
linkedfiles:getlinkedfilesfromworddocument

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
linkedfiles:getlinkedfilesfromworddocument [2018/04/02 11:06]
willam
linkedfiles:getlinkedfilesfromworddocument [2020/02/26 17:10] (current)
Line 1: Line 1:
 +====== getLinkedFilesFromWordDocument() ======
 +Function to get a list of all topic files created for a linked Word document. This function only works for Word documents, not for FrameMaker documents.
 +
 +===== Usage =====
 +To get the list of topics from a Word File:
 +<code javascript>​
 +var WordDocuments = RoboHelp.project.WordFileManager;​
 +  for(var i=1;​i<​=WordDocuments.count;​i++) {
 +    var topics = getLinkedFilesFromWordDocument(WordDocuments.item(i));​
 +  }
 +</​code>​
 +
 +===== Parameters =====
 +^ Parameter ^ Data type ^ Required ^ Description ^
 +| WordFile | WordFile object | True | The linked Word File to get all topics for |
 +
 +===== Return Values =====
 +^ Value ^ Meaning ^
 +| null | The specified resource is not a WordFile object |
 +| array | List of paths to topics that are part of the WordFile (relative from project root) |