Adobe 65030089 - Robohelp - PC Manual
  1. Manuals
  2. Brands
  3. Adobe Manuals
  4. Software
  5. 65030089 - Robohelp - PC
  6. Manual

Adobe 65030089 - Robohelp - PC Manual

Scripting guide
Hide thumbs Also See for 65030089 - Robohelp - PC:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Using Manual
ADOBE
®
ROBOHELP 8
®
Scripting Guide

Advertisement

Table of Contents
loading

Related Manuals for Adobe 65030089 - Robohelp - PC

Summary of Contents for Adobe 65030089 - Robohelp - PC

  • Page 1 ADOBE ® ROBOHELP 8 ® Scripting Guide...
  • Page 2 8 Scripting Guide for Windows Adobe, the Adobe logo, Adobe AIR, AIR, FlashHelp, FrameMaker, and RoboHelp are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Windows is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

  • Page 3: Table Of Contents

    Contents Chapter 1: Scripting basics Scripting support in RoboHelp ..................1 RoboHelp object model .
  • Page 4 ROBOHELP 8 SCRIPTING GUIDE Contents Chapter 3: Constants Syntax for using constants ................... . 83 SSLLayoutType .

  • Page 5: Chapter 1: Scripting Basics

    Chapter 1: Scripting basics A script is a series of commands that instructs Adobe® RoboHelp® to perform a set of specified actions, such as counting the images used in a RoboHelp project or selecting multiple master pages and importing them. Scripts automate repetitive tasks and are often used as a creative tool to streamline tasks that are time-consuming.

  • Page 6: Robohelp Object Model

    To accomplish a task through scripting, you need to reference these objects following the parent-child relationship defined in the containment hierarchy. For example, if you want to specify Adobe® AIR® Help as the single-source layout for a RoboHelp application, the object reference in your script needs to be:...
  • Page 7 ROBOHELP 8 SCRIPTING GUIDE Scripting basics RoboHelp.SSLLayoutType.AIRHELP is a child class of the class, and is a property of the class. SSLLayout RoboHelp AIRHELP SSLLayout RoboHelp TokenManager Project SSLLayoutType Language Token TopicManager Topic ReportType MasterPageManager DeleteOption MasterPage Status SnippetManager SkinType Snippet FrameFileFormat UDVManager...

  • Page 8: Chapter 2: Classes

    Chapter 2: Classes RoboHelp Main class for interacting with a RoboHelp application. RoboHelp properties Property name Data type Description version String Read-only RoboHelp product version name String Read-only Product name path String Read-only Full path to the RoboHelp application executable Integer constant Read-only language...
  • Page 9 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description FileStatus Read-only FileStatus FileStatus constant SyncStatus Read-only SyncStatus SyncStatus constant ServerType Read-only ServerType ServerType constant WordFileFormat Read-only WordFileFormat WordFileFormat constant RoboHelp methods openProject Description Opens .mpj and .xpj projects in a RoboHelp application. Syntax openProject (projectPath, upgradeIfRequired) Parameters...
  • Page 10 ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description fullFilePath String Full path to the file that you want to open getCurrentProject Description Returns the active project object. Returns Project Syntax getCurrentProject () closeProject Description Closes the active project. Note: Unsaved topic files are not saved.
  • Page 11 ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description template String Name of the template or full path to the Template.hpr file. Specify an empty string to create a blank project. String Name of the project projectName projectPath String Full path to the location where the project will...
  • Page 12 ROBOHELP 8 SCRIPTING GUIDE Classes Parameter name Data type Optional Description String Full path to the file containing XHTML to place bodyFooter in the body running-footer area of the output file. xslFile String Full path to the XSL file that is used instead of the default XSL file to transform the topics to XHTML Boolean...

  • Page 13: Project

    ROBOHELP 8 SCRIPTING GUIDE Classes Syntax closeAllWindows () Project Main class for handling project-related activities. Project properties Property name Data type Description name String Read-only Project name title String Read-only Project title path String Read-only Full path to the project main folder typename String Read-only...
  • Page 14 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description CBTManager Read-only CBTManager CBTManager object SSLManager Read-only SSLManager SSLManager object FMFileManager Read-only FMFileManager FMFileManager object WorldFileManager Read-only WordFileManager WordFileManager object ReportManager Read-only ReportManager ReportManager object ServerManager Read-only ServerManager ServerManager object MapIdManager Read-only MapIdManager...
  • Page 15 ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax exportSettings (settingsFilePath, overwriteFile) Parameters Parameter name Data type Optional Description settingsFilePath String Full path to the .isf settings file Boolean Flag to overwrite the existing file overwriteFile The default value is true. outputMessage Description Displays the message on the Output View pod.
  • Page 16 ROBOHELP 8 SCRIPTING GUIDE Classes updateAll Description Updates all linked documents (FrameMaker documents and Word documents) in the project. Returns Boolean Syntax updateAll (flagForceUpdate) Parameters Parameter name Data type Optional Description flagForceUpdate Boolean Flag to force the update of all linked documents importDITAMap Description...
  • Page 17 ROBOHELP 8 SCRIPTING GUIDE Classes Parameter name Data type Optional Description String Full path to the file containing XHTML to place bodyFooter in the body running-footer area of the output file. xslFile String Full path to the XSL file that is used instead of the default XSL file to transform topics to XHTML Boolean...
  • Page 18 ROBOHELP 8 SCRIPTING GUIDE Classes importWordDoc Description Imports a Word document into the current project. Returns Boolean Syntax importWordDoc (filePath, folderName, TOCName, addIndexToTopic, indexName, glossaryName) Parameters Parameter name Data type Optional Description filePath String Absolute path of the Word document to import folderName String...

  • Page 19: Tokenmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description filePath String Absolute path of the FrameMaker document to import folderName String Relative path of the folder the in the current project in which the FrameMaker document is to be imported String Absolute path of the FrameMaker TOC file for...

  • Page 20: Token

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Token Syntax item (index) Parameters Parameter name Data type Optional Description index Integer Index for the token save Description Saves the specified token file. Returns Boolean Syntax save () Token Handles a specific token. Token properties Property name Data type...
  • Page 21 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Token Read-only next Returns the next object Integer constant Read-only tokenType Type of token Integer constant Read-only tagType Returns the type of tag if tokenType is TOKENTAG Token methods update Description Updates the text of the token if tokenType is TOKENTEXT.
  • Page 22 ROBOHELP 8 SCRIPTING GUIDE Classes setAttribute Description Sets the specific attribute value. Returns Boolean Syntax setAttribute (attributeName, attributeValue) Parameters Parameter name Data type Optional Description attributeName String Name of the attribute attributeValue String Value of the attribute removeAttribute Description Removes the specific attribute value. Returns Boolean Syntax...

  • Page 23: Topicmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description newText String New text to insert Boolean Inserts a new text token before a specified afterCurrentTag token By default, the new token is inserted after the current tag. delete Description Removes the token.
  • Page 24 ROBOHELP 8 SCRIPTING GUIDE Classes Syntax item (index) Parameters Parameter name Data type Optional Description index Integer Index for the topic newItem Description Creates a topic in the current project. Returns Topic Syntax newItem (topicTitle, fileName, language) Parameters Parameter name Data type Optional Description...

  • Page 25: Masterpagemanager

    ROBOHELP 8 SCRIPTING GUIDE Classes MasterPageManager Handles all master pages in the current project. MasterPageManager properties Property name Data type Description Project Read-only parent Project object String Read-only typename Class name of the reference object Integer Read-only count Number of master pages present in the project MasterPageManager methods item...

  • Page 26: Snippetmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description title String Title of the master page The filename for the master page is also same as the title. String CSS to attach The path of the CSS file must be relative to the project path.
  • Page 27 ROBOHELP 8 SCRIPTING GUIDE Classes SnippetManager methods item Description Returns the snippet specified by the index. Returns Snippet Syntax item (index) Parameters Parameter name Data type Optional Description Integer Index for the snippet index newItem Description Creates a snippet in the current project. Returns Snippet Syntax...

  • Page 28: Udvmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description snippetFilePath String Full path of the snippet file UDVManager Handles all user-defined variables (UDVs) in the current project. UDVManager properties Property name Data type Description Project Read-only parent Project object String Read-only...

  • Page 29: Filemanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Syntax newItem (UDVName, UDVValue) Parameter Parameter name Data type Optional Description UDVName String Name of the new UDV String Value of the new UDV UDVValue FileManager Handles all files in the current project. FileManager properties Property name Data type Description...

  • Page 30: Tocmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes checkoutAll Description Checks out all files in the current project from the version control system. Returns Boolean Syntax checkoutAll () checkinAll Description Checks in all files in the current project to the version control system. Returns Boolean Syntax...
  • Page 31 ROBOHELP 8 SCRIPTING GUIDE Classes TOCManager properties Property name Data type Description Project Read-only parent Project object String Read-only typename Class name of the reference object Integer Read-only count Number of TOC files present in the project TOCManager methods item Description Returns the TOC specified by the index.

  • Page 32: Indexmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes IndexManager Handles all index files in the current project. IndexManager properties Property name Data type Description Project Read-only parent Project object String Read-only typename Class name of the reference object Integer Read-only count Number of index files present in the project IndexManager methods item Description...

  • Page 33: Glossarymanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description newIndexName String Name of the new index String Path of an existing index file, which is copied existingIndexFilePath into the new index GlossaryManager Handles all glossary files in the current project. GlossaryManager properties Property name Data type...

  • Page 34: Skinmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Syntax newItem (newGlossaryName, existingGlossaryFilePath) Parameters Parameter name Data type Optional Description newGlossaryName String Name of new glossary String Path of an existing glossary file, which is existingGlossaryFilePath copied into the new glossary SkinManager Handles all skins in the current project. SkinManager properties Property name Data type...

  • Page 35: Cbtmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes CBTManager Handles all conditional build tags (CBTs) in the current project. CBTManager properties Property name Data type Description Project Read-only parent Project object String Read-only typename Class name of the reference object Integer Read-only count Number of CBTs present in the project CBTManager methods item...

  • Page 36: Sslmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description CBTName String Name of the new CBT Integer Specify the red color value for CBT, range (0- redColor 255) Integer Specify the green color value for CBT, range greenColor (0-255) Integer...

  • Page 37: Fmfilemanager

    ROBOHELP 8 SCRIPTING GUIDE Classes FMFileManager Handles all FrameMaker files in the current project. Note: You can implement the FMFileManager class if you have Technical Communication Suite installed. FMFileManager properties Property name Data type Description Project Read-only parent Project object String Read-only typename...

  • Page 38: Wordfilemanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description FrameMakerFilePath String Path to the existing FrameMaker file String Relative path of the folder in the current folderName project in which the FrameMaker file is to be linked WordFileManager Handles all Word files in the current project.

  • Page 39: Reportmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns WordFile Syntax newItem (WordFilePath, folderName) Parameters Parameter name Data type Optional Description WordFilePath String Path to the existing Word file String Relative path of the folder in the current folderName project in which the Word File is to be linked ReportManager Handles all types of reports in the current project.
  • Page 40 ROBOHELP 8 SCRIPTING GUIDE Classes print Description Prints a specified report type. Returns Boolean Syntax print (reportType) Parameters Parameter name Data type Optional Description reportType ReportType Report type copy Description Copies a specified report type to the Clipboard. Returns Boolean Syntax copy (reportType) Parameters...

  • Page 41: Servermanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description reportType ReportType Report type String E-mail addresses, in semicolon-separated emailIDs format ServerManager Handles all servers specified in the current project ServerManager properties Property name Data type Description Project Read-only parent Project object...

  • Page 42: Server

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Server Syntax newItem (serverDescription, serverType) Parameters Parameter name Data type Optional Description serverDescription String Description of the new server item ServerType Type of server that you want to create serverType Server Handles specific server items. Server properties Property name Data type...
  • Page 43 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Integer Read-write port Port number of the server This will apply only for FTP ServerType. serverDirectory String Read-write Server directory This will not apply for FILESYSTEM ServerType. destinationPath String Read-write Destination path This will apply only for FILESYSTEM ServerType.
  • Page 44 ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description hostName String Host name for the server String Server directory serverDirectory changeToFrontPage Description Changes the existing server to the FrontPage server type. Returns Boolean Syntax changeToFrontPage (hostName, serverDirectory, webname) Parameters Parameter name Data type...

  • Page 45: Mapidmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax delete () MapIdManager Handles map ID manipulation in the current project. MapIdManager properties Property name Data type Description parent Project Read-only Project object typename String Read-only Class name of the reference object MapIdManager methods newMapId Description...
  • Page 46 ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax assign (mapId, topicPath) Parameters Parameter name Data type Optional Description mapId String Topic ID String File name of the topic topicPath unassign Description Unassigns a map ID from a topic. Returns Boolean Syntax unassign (mapId) Parameters...
  • Page 47 ROBOHELP 8 SCRIPTING GUIDE Classes edit Description Edits a map ID. Returns Boolean Syntax edit (mapId, mapNumber) Parameters Parameter name Data type Optional Description mapId String Topic ID mapNumber Integer Map number newMapFile Description Creates a map file. Returns Boolean Syntax newMapFile (mapFilename) Parameters...

  • Page 48: Htmlhelpwindowmanager

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description mapFilename String Full path of the map file String Path of the folder where the map file is destinationFolderInProject imported. By default, the map file is imported in the project folder. setCurMapFile Description Sets the current map file.

  • Page 49: File

    ROBOHELP 8 SCRIPTING GUIDE Classes HTMLHelpWindowManager methods item Description Returns the HTMLHelp window specified by the index. Returns HTMLHelpWindow Syntax item (index) Parameters Parameter name Data type Optional Description Integer Index for the window index newItem Description Creates an HTMLHelp window. Returns HTMLHelpWindow Syntax...

  • Page 50: File Properties

    ROBOHELP 8 SCRIPTING GUIDE Classes File properties Property name Data type Description FileManager Read-only parent Parent FileManager object String Read-only name Name of the file String Read-only typename Class name of the reference object File Read-only previous Returns the previous file object File Read-only next...

  • Page 51: Skin

    ROBOHELP 8 SCRIPTING GUIDE Classes Syntax checkout () checkin Description Checks in the specified file to the version control system. Returns Boolean Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax...
  • Page 52 ROBOHELP 8 SCRIPTING GUIDE Classes Skin properties Property name Data type Description SkinManager Read-only parent Parent SkinManager object String Read-write name Name of the skin String Read-only typename Class name of the reference object Skin Read-only previous Returns the previous skin object Skin Read-only next...
  • Page 53 ROBOHELP 8 SCRIPTING GUIDE Classes Skin methods checkout Description Checks out the specified file from the version control system. Returns Boolean Syntax checkout () checkin Description Checks in the specified file to the version control system. Returns Boolean Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system.

  • Page 54: Cbt

    ROBOHELP 8 SCRIPTING GUIDE Classes delete Description Deletes the specified skin. Returns Boolean exportFile Description Exports the specified skin. Returns Boolean Syntax exportFile (newFileLocation) Parameters Parameter name Data type Optional Description String Full path to the new skin file newFileLocation Handles specific CBT functions in the project.

  • Page 55: Udv

    ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Integer Read-write Red color value Integer Read-write green Green color value Integer Read-write blue Blue color value CBT methods delete Description Deletes the specified CBT. Returns Boolean Syntax delete () Handles specific UDV functions in the project.

  • Page 56: Ssl

    ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Read-only next Returns the next UDV object String Read-only htmlText HTML Text tag, which can be inserted in any html file usedIn String Read-only Returns the list of topics in which the UDV is referenced UDV methods delete...
  • Page 57 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data Type Description SSLLayoutType Read-only layoutType Returns the layout type of the SSL object Boolean Read-only canPublish Returns true if you can publish the specific SSL Boolean Read-write defaultLayout Specifies whether the SSL is the default layout or not Section508 Boolean...
  • Page 58 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data Type Description String Read-write Specifies the CBT for SSL String Read-write server Specifies the server list in SSL, server names with \n separation serverProjectName String Read-write Allows read/write to the project name setting in the SSL.
  • Page 59 ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax generate () view Description Opens the output of the specified SSL for viewing. Returns Boolean Syntax view () publish Generates the specified SSL and publishes the output to the set server Returns: Boolean clearAllOverrides Description Clears overriden master pages or CSSs.

  • Page 60: Snippet

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description MasterPage String Name of the master page to apply. A master page object itself can also be passed. applyCSSToAllTopics Description Path of the CSS to appy. The path is relative to the project. Returns Boolean Syntax...
  • Page 61 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description FileStatus Read-only fileStatus Status of the file Boolean Read-only valid Returns true if the file is present physically String Read-only extension File extension String Read-only location Path to the folder in which the file is present String Read-only path...
  • Page 62 ROBOHELP 8 SCRIPTING GUIDE Classes Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax getLatestVersion () undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax...

  • Page 63: Topic

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax exportFile (newFileLocation) Parameters Parameter name Data type Optional Description newFileLocation String Full path to the new snippet file createDuplicate Description Creates a duplicate snippet from the specified snippet. Returns Snippet Syntax createDuplicate () Topic Handles specific topic functions in the project.
  • Page 64 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Language Read-only language Language of the specified topic Status Read-only status Returns the status of the topic file String Read-write List of CBTs applied on the topic FileStatus Read-only fileStatus Status of the file Boolean Read-only...
  • Page 65 ROBOHELP 8 SCRIPTING GUIDE Classes checkin Description Checks in the specified file to the version control system. Returns Boolean Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax getLatestVersion () undoCheckout Description...

  • Page 66: Masterpage

    ROBOHELP 8 SCRIPTING GUIDE Classes MasterPage Handles specific master page functions in the project. MasterPage properties Property name Data type Description MasterPageManager Read-only parent Parent MasterPageManager object String Read-only name Title of the master page String Read-only filename Master page file name typename String Read-only...
  • Page 67 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Integer Read-only size File size in bytes String Read-only creationDate Creation date of the file in (mm-dd-yyyy) format modifyDate String Read-only Last modified date of the file in (mm-dd-yyyy) format MasterPage methods checkout Description...
  • Page 68 ROBOHELP 8 SCRIPTING GUIDE Classes undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified master page. Returns Boolean Syntax delete () rename Description Renames a master page in the current project. Returns Boolean Syntax...

  • Page 69: Toc

    ROBOHELP 8 SCRIPTING GUIDE Classes Syntax applyMasterPageToTopics (arrayOfTopics) Parameters Parameter name Data type Optional Description arrayOfTopics Array A JavaScript array. Each element of this array must be a topic object. Handles specific TOC functions in the project. TOC properties Property name Data type Description parent...
  • Page 70 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Integer Read-only size File size in bytes String Read-only creationDate Creation date of the file in (mm-dd-yyyy) format modifyDate String Read-only Last modified date of the file in (mm-dd-yyyy) format TOC methods checkin Description...
  • Page 71 ROBOHELP 8 SCRIPTING GUIDE Classes undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified TOC. Returns Boolean Syntax delete () autoCreateTOC Description Auto-creates the TOC for the specified TOC object. Returns Boolean Syntax...

  • Page 72: Index

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax rename (newName) Parameters Parameter name Data type Optional Description newName String New name for the TOC setAsDefault Description Sets the TOC object as the default TOC of the project. Returns Boolean Syntax setAsDefault () Index Handles specific index functions in the project.
  • Page 73 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Boolean Read-only valid Returns true if the file is present physically String Read-only extension File extension String Read-only location Path to the folder in which the file is present String Read-only path Absolute file path...
  • Page 74 ROBOHELP 8 SCRIPTING GUIDE Classes getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax getLatestVersion () undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout ()

  • Page 75: Htmlhelpwindow

    ROBOHELP 8 SCRIPTING GUIDE Classes Parameters Parameter name Data type Optional Description newName String New name for the index setAsDefault Description Sets the index object as the default index for the project. Returns Boolean Syntax setAsDefault () HTMLHelpWindow Gets or configures HTMLHelp window settings. HTMLHelpWindow properties Property name Data type...
  • Page 76 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description HTMLHelpWindowDefaultTab Read-write defaultTab Tripane default Tab HTMLHelpWindowButtons Read-write buttons Flags to show different buttons in the HTMLHelp window windowProperties HTMLHelpWindowProperties Read-write Used to set properites of the HTMLHelp window Integer Read-write windowStyles Window styles...

  • Page 77: Glossary

    ROBOHELP 8 SCRIPTING GUIDE Classes Syntax setWindowPosition (top, left, width, height) Parameters Parameter name Data type Optional Description Integer Top position Integer Left position left width Integer Width of the window height Integer Height of the window Glossary Handles specific glossary functions in the project. Glossary properties Property name Data type...
  • Page 78 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description Integer Read-only size File size in bytes String Read-only creationDate Creation date of the file in (mm-dd-yyyy) format modifyDate String Read-only Last modified date of file in (mm-dd-yyyy) format Glossary methods checkout Description Checks out the specified file from the version control system.
  • Page 79 ROBOHELP 8 SCRIPTING GUIDE Classes undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified glossary. Returns Boolean Syntax delete () newItem Description Adds a new glossary term to the object. Returns Boolean Syntax...

  • Page 80: Fmfile

    ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax rename (newName) Parameters Parameter name Data type Optional Description newName String New name for the glossary setAsDefault Description Sets the glossary object as the default glossary for the project. Returns Boolean Syntax setAsDefault () FMFile Handles specific FrameMaker file functions in the project.
  • Page 81 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description String Read-write frameTocFilePath FrameMaker TOC file path (read/write) String Read-write associatedTocName RoboHelp associated TOC name (read/write) String Read-write associatedIndexName RoboHelp associated index name (read/write) String Read-write associatedGlossaryName RoboHelp associated glossary name (read/write) syncStatus SyncStatus...
  • Page 82 ROBOHELP 8 SCRIPTING GUIDE Classes Syntax checkout () checkin Description Checks in the specified file to the version control system. Returns Boolean Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax...

  • Page 83: Wordfile

    ROBOHELP 8 SCRIPTING GUIDE Classes update Description Updates the FrameMaker file and generates specific topics in the RoboHelp project. Returns Boolean Syntax update (flagForceUpdate) Parameters Parameter name Data type Optional Description flagForceUpdate Boolean Flag to force the update of the FrameMaker file WordFile Handles specific Word file functions in the project.
  • Page 84 ROBOHELP 8 SCRIPTING GUIDE Classes Property name Data type Description String Read-write associatedGlossaryName RoboHelp associated glossary name (read/write) syncStatus SyncStatus Read-only Synchronization status of the Word file fileStatus FileStatus Read-only Status of the file valid Boolean Read-only Returns true if the file is present physically extension String Read-only...
  • Page 85 ROBOHELP 8 SCRIPTING GUIDE Classes Returns Boolean Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax getLatestVersion () undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax...
  • Page 86 ROBOHELP 8 SCRIPTING GUIDE Classes Syntax update (flagForceUpdate) Parameters Parameter name Data type Optional Description flagForceUpdate Boolean Flag to force the update of the Word file...

  • Page 87: Chapter 3: Constants

    Chapter 3: Constants Syntax for using constants A constant is a class with predefined values. The syntax for specifying a constant is: RoboHelp.ConstantClass.constantname For example: RoboHelp.SSLLayoutType.AIRHELP SSLLayoutType Provides constants for different single-source layouts in RoboHelp. SSLLayoutType properties Property name Data type AIRHELP Integer FLASHHELP...
  • Page 88 ROBOHELP 8 SCRIPTING GUIDE Constants Language properties Property name Data type Integer NONE BRAZILLIAN Integer BULGARIAN Integer Integer CATALAN CORATIAN Integer CZECH Integer Integer DANISH DUTCH Integer ENGLISHUK Integer Integer ENGLISHUS ESTONIAN Integer FINNISH Integer Integer FRENCH FRENCH_CANADA Integer GERMAN Integer Integer GREEK...

  • Page 89: Reporttype

    ROBOHELP 8 SCRIPTING GUIDE Constants Property name Data type Integer THAI TRADITIONAL_CHINESE Integer TURKISH Integer Integer VIETNAMESE ReportType Provides constants for different report types in RoboHelp. ReportType properties Property name Data type BROKENLINKS Integer CONDITIONALBUILDTAGS Integer Integer DUPLICATEMAPIDS EXTERNALTOPICS Integer GLOSSARY Integer Integer...

  • Page 90: Deleteoption

    ROBOHELP 8 SCRIPTING GUIDE Constants DeleteOption Provides constants for different delete options in RoboHelp. DeleteOption properties Property name Data type Integer DELETEANDCLEARREFERENCE Integer DELETEONLY DELETEANDREPLACECONTENT Integer Status Provides constants for various topic status in RoboHelp. Status properties Property name Data type INPROGRESS Integer Integer...

  • Page 91: Tokentype

    ROBOHELP 8 SCRIPTING GUIDE Constants FrameFileFormat properties Property name Data type Integer FRAMEMIFFORMAT FRAMEFMFORMAT Integer FRAMEBOOKFORMAT Integer Integer FRAMETOCFORMAT FRAMEMIXEDFORMAT Integer TokenType Provides constants for different token types for token objects in RoboHelp. TokenType properties Property name Data type TOKENTEXT Integer Integer TOKENTAG...

  • Page 92: Filestatus

    ROBOHELP 8 SCRIPTING GUIDE Constants FileStatus Provides constants for different file statuses in RoboHelp. FileStatus properties Property name Data type Integer FILEUNKNOWN Integer FILECHECKEDIN FILECHECKEDOUT Integer Integer FILECHECKEDOUTEXCLUSIVE Integer FILECHECKOUTBYYOUANDOTHER FILECHECKEDOUTTOANOTHERFOLDER Integer Integer FILECHECKEDOUTBYANOTHER Integer FILEREMOVED FILENOTCONTROLLED Integer Integer FILEREADONLY Integer FILEWRITABLE FILENOTEXIST...

  • Page 93: Servertype

    ROBOHELP 8 SCRIPTING GUIDE Constants Property name Data type Integer STATUSOUTDATEDFILE STATUSMODIFIED Integer STATUSDELETED Integer ServerType Provides constants for different server items in RoboHelp. ServerType properties Property name Data type Integer HTTP Integer FRONTPAGE Integer Integer FILESYSTEM ROBOHELPSERVER Integer WordFileFormat Provides constants for different Word file formats in RoboHelp.

  • Page 94: Htmlhelpwindowdefaulttab

    ROBOHELP 8 SCRIPTING GUIDE Constants HTMLHelpWindowAlign properties Property name Data type Integer ALIGN_TOP ALIGN_LEFT Integer ALIGN_BOTTOM Integer HTMLHelpWindowDefaultTab Provides constants for the Window Tab position. HTMLHelpWindowDefaultTab properties Property name Data type Integer TAB_CONTENTS Integer TAB_INDEX TAB_SEARCH Integer Integer TAB_HISTORY TAB_FAVORITES Integer HTMLHelpWindowButtons Provides constants for the Window Tab position.

  • Page 95: Htmlhelpwindowproperties

    ROBOHELP 8 SCRIPTING GUIDE Constants Property name Data type Integer BTN_INDEX BTN_SEARCH Integer BTN_HISTORY Integer Integer BTN_FAVORITES BTN_BROWSE_FWD Integer BTN_BROWSE_BCK Integer Integer BTN_NOTES BTN_CONTENTS Integer HTMLHelpWindowProperties Provides constants for the Window Tab position. HTMLHelpWindowProperties properties Property name Data type PROP_ONTOP Integer Integer PROP_NOTITLEBAR...
  • Page 96 ROBOHELP 8 SCRIPTING GUIDE Constants Property name Data type Integer PROP_EHELP PROP_AVENUE Integer PROP_USER_POS Integer...

  • Page 97: Index

    Index newProject 6 applyCSSToAllTopics 56 generate 54 newProjectImport 7 applyMasterPageToAllTopics 55 getAttribute 17 applyMasterPageToTopics 64 getCurrentProject 6 assign 41 getLatestAll 26 openProject 5 autoCreateBrowseSequence 13 getTokenManager 5 outputMessage 11 autoCreateTOC 67 Glossary 73 GlossaryManager 29 print 36 bringToFront 8 Project 9 HTMLHelpWindow 71 publish 55 HTMLHelpWindowAlign 89...
  • Page 98 ROBOHELP 8 SCRIPTING GUIDE Index Token 16 TokenManager 15 TokenType 87 Topic 59 TopicManager 19 UDV 51 UDVManager 24 unassign 42 update 17, 79 updateAll 12 view 55 WordFile 79 WordFileFormat 89 WordFileManager 34...

This manual is also suitable for:

Robohelp 8

Table of Contents