Adobe 65030089 Scripting Guide

Adobe 65030089 - Robohelp - PC Manual

Get Adobe 65030089 - Robohelp - PC PDF manuals and user guides
UPC - 883919170626
View all Adobe 65030089 manuals
Add to My Manuals
Save this manual to your list of manuals

Adobe 65030089 manual content summary:

  • Adobe 65030089 | Scripting Guide - Page 1
    ADOBE® ROBOHELP® 8 Scripting Guide
  • Adobe 65030089 | Scripting Guide - Page 2
    Systems Incorporated. All rights reserved. Adobe® RoboHelp® 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
  • Adobe 65030089 | Scripting Guide - Page 3
    iii Contents Chapter 1: Scripting basics Scripting support in RoboHelp 1 RoboHelp object model 2 Chapter 2: Classes RoboHelp ...4 Project ...9 TokenManager ...15 Token ...16 TopicManager ...19 MasterPageManager 21 SnippetManager ...22 UDVManager ...24 FileManager ...25 TOCManager ...26
  • Adobe 65030089 | Scripting Guide - Page 4
    ROBOHELP 8 SCRIPTING GUIDE iv Contents Chapter 3: Constants Syntax for using constants 83 SSLLayoutType ...83 Language ...83 ReportType ...85 DeleteOption ...86 Status ...86 SkinType ...86 FrameFileFormat ...86 TokenType ...87
  • Adobe 65030089 | Scripting Guide - Page 5
    a series of commands that instructs Adobe® RoboHelp® to perform a Introduction to Scripting manual. Scripting support in RoboHelp RoboHelp supports ExtendScript, which is editor, including a built-in syntax checker that identifies where the problems are in your script and tries to explain how to fix
  • Adobe 65030089 | Scripting Guide - Page 6
    ROBOHELP 8 SCRIPTING GUIDE 2 Scripting basics Running scripts project. For example, define a link to convert www.adobe.com to www.adobe.com/support/ across all the Help files in a project. See hierarchy. For example, if you want to specify Adobe® AIR® Help as the single-source layout for a RoboHelp application,
  • Adobe 65030089 | Scripting Guide - Page 7
    ROBOHELP 8 SCRIPTING GUIDE 3 Scripting basics RoboHelp.SSLLayoutType.AIRHELP SSLLayout is a child class of the RoboHelp class, and AIRHELP is a property of the SSLLayout class. RoboHelp TokenManager Token RoboHelp
  • Adobe 65030089 | Scripting Guide - Page 8
    Chapter 2: Classes RoboHelp Main class for interacting with a RoboHelp application. RoboHelp properties Property name version Data type String name String path String language project SSLLayoutType Language ReportType DeleteOption Status SkinType FrameFileFormat TokenType TagType Integer
  • Adobe 65030089 | Scripting Guide - Page 9
    getTokenManager Description Returns Token Manager for the specified file. Returns TokenManager Syntax getTokenManager (fullFilePath) ROBOHELP 8 SCRIPTING GUIDE 5 Classes Description Read-only FileStatus constant Read-only SyncStatus constant Read-only ServerType constant Read-only WordFileFormat
  • Adobe 65030089 | Scripting Guide - Page 10
    ROBOHELP 8 SCRIPTING GUIDE 6 Classes Parameters Parameter name fullFilePath Data type String Optional No Description Full path to the file that you want to open getCurrentProject Description Returns the
  • Adobe 65030089 | Scripting Guide - Page 11
    ROBOHELP 8 SCRIPTING GUIDE 7 Classes Parameters Parameter name template projectName projectPath title firstTopic language saveSettings Data type String Optional No String No String No String Yes String Yes Integer
  • Adobe 65030089 | Scripting Guide - Page 12
    name scriptFilePath Data type String Optional No closeAllWindows Description Closes all active document windows in the RoboHelp application. ROBOHELP 8 SCRIPTING GUIDE 8 Classes Description Full path to the file containing XHTML to place in the body running-footer area of the output file
  • Adobe 65030089 | Scripting Guide - Page 13
    SnippetManager UDVManager UDVManager FileManager FileManager TOCManager TOCManager IndexManager IndexManager GlossaryManager GlossaryManager SkinManager SkinManager ROBOHELP 8 SCRIPTING GUIDE 9 Classes Description Read-only Project name Read-only Project title Read-only Full path to
  • Adobe 65030089 | Scripting Guide - Page 14
    Data type String Optional No exportSettings Description Exports the settings file (*.isf) from the current project. ROBOHELP 8 SCRIPTING GUIDE 10 Classes Description Read-only CBTManager object Read-only SSLManager object Read-only FMFileManager object Read-only WordFileManager object Read-only
  • Adobe 65030089 | Scripting Guide - Page 15
    Renames the current project. Returns Boolean Syntax rename (newName) Parameters Parameter name newName Data type String Optional No Optional No ROBOHELP 8 SCRIPTING GUIDE 11 Classes Description Full path to the .isf settings file Flag to overwrite the existing file The default value is true
  • Adobe 65030089 | Scripting Guide - Page 16
    ROBOHELP 8 SCRIPTING GUIDE 12 Classes updateAll Description Updates all linked documents (FrameMaker documents and Word documents) in the project. Returns Boolean Syntax updateAll (flagForceUpdate) Parameters Parameter name flagForceUpdate
  • Adobe 65030089 | Scripting Guide - Page 17
    Returns Boolean Syntax importHtmlFile (filePath,folderName) Parameters Parameter name filePath folderName Data type String String Optional No No ROBOHELP 8 SCRIPTING GUIDE 13 Classes Description Full path to the file containing XHTML to place in the body running-footer area of the output file
  • Adobe 65030089 | Scripting Guide - Page 18
    ROBOHELP 8 SCRIPTING GUIDE 14 Classes importWordDoc Description Imports a Word document into the current project. Returns Boolean Syntax importWordDoc (filePath, folderName, TOCName, addIndexToTopic, indexName, glossaryName) Parameters Parameter name filePath
  • Adobe 65030089 | Scripting Guide - Page 19
    RoboHelp typename String count Integer valid Boolean TokenManager methods item Description Returns the token specified by the index. ROBOHELP 8 SCRIPTING GUIDE 15 Classes Description Absolute path of the FrameMaker document to import Relative path of the folder the in the current project in
  • Adobe 65030089 | Scripting Guide - Page 20
    . Token properties Property name parent name typename previous Data type Integer Optional No Data type TokenManager String String Token ROBOHELP 8 SCRIPTING GUIDE 16 Classes Description Index for the token Description Read-only Parent TokenManager object Read-only Text from the token object Read
  • Adobe 65030089 | Scripting Guide - Page 21
    the specific attribute value. Returns String Syntax getAttribute (attributeName) Parameters Parameter name attributeName Data type String Optional No ROBOHELP 8 SCRIPTING GUIDE 17 Classes Description Read-only Returns the next object Read-only Type of token Read-only Returns the type of tag if
  • Adobe 65030089 | Scripting Guide - Page 22
    String Optional No insertText Description Inserts a new text token before or after the specified token. Returns Boolean Syntax insertText (newText, afterCurrentTag) ROBOHELP 8 SCRIPTING GUIDE 18 Classes Description Name of the attribute Value of the attribute Description Name of the attribute
  • Adobe 65030089 | Scripting Guide - Page 23
    type Project typename String count Integer TopicManager methods item Description Returns the topic specified by the index. Returns Topic ROBOHELP 8 SCRIPTING GUIDE 19 Classes Description New text to insert Inserts a new text token before a specified token By default, the new token is inserted
  • Adobe 65030089 | Scripting Guide - Page 24
    , folderName) Parameters Parameter name filePath folderName Data type String String Optional No Optional No No No Optional No No ROBOHELP 8 SCRIPTING GUIDE 20 Classes Description Index for the topic Description Title of the topic Filename of the topic Language of topic Description Absolute path
  • Adobe 65030089 | Scripting Guide - Page 25
    Integer newItem Description Creates a master page in the current project. Returns MasterPage Syntax newItem (title, css, desc) Optional No ROBOHELP 8 SCRIPTING GUIDE 21 Classes Description Read-only Project object Read-only Class name of the reference object Read-only Number of master pages
  • Adobe 65030089 | Scripting Guide - Page 26
    all snippets in the current project. SnippetManager properties Property name parent Data type Project typename String count Integer Yes Optional No ROBOHELP 8 SCRIPTING GUIDE 22 Classes Description Title of the master page The filename for the master page is also same as the title. CSS to
  • Adobe 65030089 | Scripting Guide - Page 27
    snippetName Data type String importFile Description Imports an existing snippet into the current project. Returns Snippet Syntax importFile (snippetFilePath) Optional No Optional No ROBOHELP 8 SCRIPTING GUIDE 23 Classes Description Index for the snippet Description Name of the snippet
  • Adobe 65030089 | Scripting Guide - Page 28
    item (index) Parameters Parameter name index Data type Integer newItem Description Creates a UDV in the current project. Optional No ROBOHELP 8 SCRIPTING GUIDE 24 Classes Description Full path of the snippet file Description Read-only Project object Read-only Class name of the reference object
  • Adobe 65030089 | Scripting Guide - Page 29
    file specified by the index. Returns File Syntax item (index) Parameters Parameter name index Data type Integer Optional No No Optional No ROBOHELP 8 SCRIPTING GUIDE 25 Classes Description Name of the new UDV Value of the new UDV Description Read-only Project object Read-only Class name of the
  • Adobe 65030089 | Scripting Guide - Page 30
    ROBOHELP 8 SCRIPTING GUIDE 26 Classes checkoutAll Description Checks out all files in the current project from the version control system. Returns Boolean Syntax checkoutAll () checkinAll Description Checks in
  • Adobe 65030089 | Scripting Guide - Page 31
    newItem (newTOCName, existingTOCFilePath) Parameters Parameter name newTOCName existingTOCFilePath Data type String String Optional No Optional No Yes ROBOHELP 8 SCRIPTING GUIDE 27 Classes Description Read-only Project object Read-only Class name of the reference object Read-only Number of TOC
  • Adobe 65030089 | Scripting Guide - Page 32
    Integer Optional No newItem Description Creates an index in the current project. Returns Index Syntax newItem (newIndexName, existingIndexFilePath) ROBOHELP 8 SCRIPTING GUIDE 28 Classes Description Read-only Project object Read-only Class name of the reference object Read-only Number of index
  • Adobe 65030089 | Scripting Guide - Page 33
    Parameter name index Data type Integer newItem Description Creates a glossary file in the current project. Returns Glossary Optional No ROBOHELP 8 SCRIPTING GUIDE 29 Classes Description Name of the new index Path of an existing index file, which is copied into the new index Description Read
  • Adobe 65030089 | Scripting Guide - Page 34
    the skin specified by the index. Returns Skin Syntax item (index) Parameters Parameter name index Data type Integer Optional No ROBOHELP 8 SCRIPTING GUIDE 30 Classes Description Name of new glossary Path of an existing glossary file, which is copied into the new glossary Description Read-only
  • Adobe 65030089 | Scripting Guide - Page 35
    Optional No newItem Description Creates a CBT in the current project. Returns CBT Syntax newItem (CBTName, redColor, greenColor, blueColor) ROBOHELP 8 SCRIPTING GUIDE 31 Classes Description Read-only Project object Read-only Class name of the reference object Read-only Number of CBTs present in
  • Adobe 65030089 | Scripting Guide - Page 36
    the SSL object specified by the index. Returns SSL Syntax item (index) Parameters Parameter name index Data type Integer Optional No ROBOHELP 8 SCRIPTING GUIDE 32 Classes Description Name of the new CBT Specify the red color value for CBT, range (0255) Specify the green color value for CBT
  • Adobe 65030089 | Scripting Guide - Page 37
    ROBOHELP 8 SCRIPTING GUIDE 33 Classes FMFileManager Handles all FrameMaker files in the current project. Note: You can implement the FMFileManager class if you have Technical Communication Suite installed.
  • Adobe 65030089 | Scripting Guide - Page 38
    Parameter name index Data type Integer Optional No newItem Description Adds a new Word file, WordFile, in the current project. ROBOHELP 8 SCRIPTING GUIDE 34 Classes Description Path to the existing FrameMaker file Relative path of the folder in the current project in which the FrameMaker file is
  • Adobe 65030089 | Scripting Guide - Page 39
    . Returns Boolean Syntax save (reportType, fileNamePath) Parameters Parameter name reportType fileNamePath Data type ReportType String Optional No No ROBOHELP 8 SCRIPTING GUIDE 35 Classes Description Path to the existing Word file Relative path of the folder in the current project in which the
  • Adobe 65030089 | Scripting Guide - Page 40
    name reportType Data type ReportType Optional No mail Description Sends a specified report type to specified e-mail addresses. Returns Boolean Syntax mail (reportType, emailIDs) ROBOHELP 8 SCRIPTING GUIDE 36 Classes Description Report type Description Report type
  • Adobe 65030089 | Scripting Guide - Page 41
    Parameters Parameter name index Data type Integer newItem Description Creates a server item in the current project. Optional No ROBOHELP 8 SCRIPTING GUIDE 37 Classes Description Report type E-mail addresses, in semicolon-separated format Description Read-only Project object Read-only Class name
  • Adobe 65030089 | Scripting Guide - Page 42
    Property name parent name typename previous next serverType hostName Data type ServerManager String String Server Server ServerType String ROBOHELP 8 SCRIPTING GUIDE 38 Classes Description Description of the new server item Type of server that you want to create Description Read-only Parent
  • Adobe 65030089 | Scripting Guide - Page 43
    ROBOHELP 8 SCRIPTING GUIDE 39 Classes Property name port serverDirectory destinationPath Data type Integer String String Description Read-write Port number of the server This will apply only for
  • Adobe 65030089 | Scripting Guide - Page 44
    changeToFileSystem (destinationPath) Parameters Parameter name destinationPath Data type String Optional No delete Description Deletes the server. ROBOHELP 8 SCRIPTING GUIDE 40 Classes Description Host name for the server Server directory Description Host name for the server Server directory
  • Adobe 65030089 | Scripting Guide - Page 45
    , mapNumber) Parameters Parameter name mapId mapNumber Data type String Integer assign Description Assigns a map ID to a topic Optional No No ROBOHELP 8 SCRIPTING GUIDE 41 Classes Description Read-only Project object Read-only Class name of the reference object Description Topic ID Map number
  • Adobe 65030089 | Scripting Guide - Page 46
    delete (mapId) Parameters Parameter name mapId Data type String String Data type String Data type String Optional No No Optional No Optional No ROBOHELP 8 SCRIPTING GUIDE 42 Classes Description Topic ID File name of the topic Description Topic ID Description Topic ID
  • Adobe 65030089 | Scripting Guide - Page 47
    Data type String Optional No importMapFile Description Imports an existing map file (*.h, *.hh, *.hm). Returns Boolean Syntax importMapFile (mapFilename, destinationFolderInProject) ROBOHELP 8 SCRIPTING GUIDE 43 Classes Description Topic ID Map number Description Name of the map file
  • Adobe 65030089 | Scripting Guide - Page 48
    ROBOHELP 8 SCRIPTING GUIDE 44 Classes Parameters Parameter name mapFilename destinationFolderInProject Data type String String Optional No Yes Description Full path of the map file Path of the folder
  • Adobe 65030089 | Scripting Guide - Page 49
    window. Returns HTMLHelpWindow Syntax newItem (windowName) Parameters Parameter name windowName Data type String Optional No File Specifies basic file functions in the project. ROBOHELP 8 SCRIPTING GUIDE 45 Classes Description Index for the window Description Name of the window
  • Adobe 65030089 | Scripting Guide - Page 50
    Integer String String File methods checkout Description Checks out the specified file from the version control system. Returns Boolean ROBOHELP 8 SCRIPTING GUIDE 46 Classes Description Read-only Parent FileManager object Read-only Name of the file Read-only Class name of the reference object Read
  • Adobe 65030089 | Scripting Guide - Page 51
    the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () Skin Handles specific skin functions in the project. ROBOHELP 8 SCRIPTING GUIDE 47 Classes
  • Adobe 65030089 | Scripting Guide - Page 52
    modifyDate Data type SkinManager String String Skin Skin SkinType Boolean FileStatus Boolean String String String Integer String String ROBOHELP 8 SCRIPTING GUIDE 48 Classes Description Read-only Parent SkinManager object Read-write Name of the skin Read-only Class name of the reference
  • Adobe 65030089 | Scripting Guide - Page 53
    system. Returns Boolean Syntax getLatestVersion () undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () ROBOHELP 8 SCRIPTING GUIDE 49 Classes
  • Adobe 65030089 | Scripting Guide - Page 54
    functions in the project. CBT properties Property name parent Data type CBTManager name String typename String previous CBT next CBT ROBOHELP 8 SCRIPTING GUIDE 50 Classes Description Full path to the new skin file Description Read-only Parent CBTManager object Read-write Name of the CBT
  • Adobe 65030089 | Scripting Guide - Page 55
    in the project. UDV properties Property name parent Data type UDVManager name String value String typename String previous UDV ROBOHELP 8 SCRIPTING GUIDE 51 Classes Description Read-write Red color value Read-write Green color value Read-write Blue color value Description Read-only Parent
  • Adobe 65030089 | Scripting Guide - Page 56
    SSL functions in the project. SSL properties Property name parent Data Type SSLManager name String typename String previous SSL next SSL ROBOHELP 8 SCRIPTING GUIDE 52 Classes Description Read-only Returns the next UDV object Read-only HTML Text tag, which can be inserted in any html file
  • Adobe 65030089 | Scripting Guide - Page 57
    window skin Data Type SSLLayoutType Boolean Boolean Boolean Boolean Boolean Boolean Boolean Boolean String Topic String String String String Skin ROBOHELP 8 SCRIPTING GUIDE 53 Classes Description Read-only Returns the layout type of the SSL object Read-only Returns true if you can publish the
  • Adobe 65030089 | Scripting Guide - Page 58
    Syntax createDuplicate (newName) Parameters Parameter name newName Data type String generate Description Generates the specified SSL. Optional No ROBOHELP 8 SCRIPTING GUIDE 54 Classes Description Read-write Specifies the CBT for SSL Read-write Specifies the server list in SSL, server names with
  • Adobe 65030089 | Scripting Guide - Page 59
    CSSs. Returns Boolean Syntax clearAllOverrides () applyMasterPageToAllTopics Description Applies the specified master page to all topics during SSL generation. Returns Boolean Syntax applyMasterPageToAllTopics (MasterPage) ROBOHELP 8 SCRIPTING GUIDE 55 Classes
  • Adobe 65030089 | Scripting Guide - Page 60
    . Snippet properties Property name parent Data type SnippetManager name String typename String previous Snippet next Snippet htmlText String ROBOHELP 8 SCRIPTING GUIDE 56 Classes Description Name of the master page to apply. A master page object itself can also be passed. Description
  • Adobe 65030089 | Scripting Guide - Page 61
    control system. Returns Boolean Syntax checkout () checkin Description Checks in the specified file to the version control system. Returns Boolean ROBOHELP 8 SCRIPTING GUIDE 57 Classes Description Read-only Status of the file Read-only Returns true if the file is present physically Read-only File
  • Adobe 65030089 | Scripting Guide - Page 62
    ROBOHELP 8 SCRIPTING GUIDE 58 Classes Syntax checkin () getLatestVersion Description Gets the latest version of the specified file from the version control system. Returns Boolean Syntax getLatestVersion () undoCheckout Description
  • Adobe 65030089 | Scripting Guide - Page 63
    Topic properties Property name parent Data type TopicManager name String filename String typename String previous Topic next Topic ROBOHELP 8 SCRIPTING GUIDE 59 Classes Description Full path to the new snippet file Description Read-only Parent TopicManager object Read-write Title of the
  • Adobe 65030089 | Scripting Guide - Page 64
    String Topic methods checkout Description Checks out the specified file from the version control system. Returns Boolean Syntax checkout () ROBOHELP 8 SCRIPTING GUIDE 60 Classes Description Read-only Language of the specified topic Read-only Returns the status of the topic file Read-write List of
  • Adobe 65030089 | Scripting Guide - Page 65
    of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified topic. Returns Boolean Syntax delete () ROBOHELP 8 SCRIPTING GUIDE 61 Classes
  • Adobe 65030089 | Scripting Guide - Page 66
    MasterPage language Language status Status CBT String fileStatus FileStatus valid Boolean extension String location String path String ROBOHELP 8 SCRIPTING GUIDE 62 Classes Description Read-only Parent MasterPageManager object Read-only Title of the master page Read-only Master page
  • Adobe 65030089 | Scripting Guide - Page 67
    ROBOHELP 8 SCRIPTING GUIDE 63 Classes Property name size creationDate modifyDate Data type Integer String String Description Read-only File size in bytes Read-only Creation date of the
  • Adobe 65030089 | Scripting Guide - Page 68
    ROBOHELP 8 SCRIPTING GUIDE 64 Classes undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified
  • Adobe 65030089 | Scripting Guide - Page 69
    name String typename String previous TOC next TOC fileStatus FileStatus valid Boolean extension String location String path String ROBOHELP 8 SCRIPTING GUIDE 65 Classes Description A JavaScript array. Each element of this array must be a topic object. Description Read-only Parent
  • Adobe 65030089 | Scripting Guide - Page 70
    ROBOHELP 8 SCRIPTING GUIDE 66 Classes Property name size creationDate modifyDate Data type Integer String String Description Read-only File size in bytes Read-only Creation date of the
  • Adobe 65030089 | Scripting Guide - Page 71
    ROBOHELP 8 SCRIPTING GUIDE 67 Classes undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified
  • Adobe 65030089 | Scripting Guide - Page 72
    . Index properties Property name parent Data type IndexManager name String typename String previous Index next Index fileStatus FileStatus ROBOHELP 8 SCRIPTING GUIDE 68 Classes Description New name for the TOC Description Read-only Parent IndexManager object Read-write Name of the index
  • Adobe 65030089 | Scripting Guide - Page 73
    Boolean Syntax checkout () checkin Description Checks in the specified file to the version control system. Returns Boolean Syntax checkin () ROBOHELP 8 SCRIPTING GUIDE 69 Classes Description Read-only Returns true if the file is present physically Read-only File extension Read-only Path to the
  • Adobe 65030089 | Scripting Guide - Page 74
    Boolean Syntax undoCheckout () delete Description Deletes the specified index. Returns Boolean Syntax delete () rename Description Renames the index. Returns Boolean Syntax rename (newName) ROBOHELP 8 SCRIPTING GUIDE 70 Classes
  • Adobe 65030089 | Scripting Guide - Page 75
    name String typename String previous HTMLHelpWindow next windowCaption navPaneWidth tabPosition HTMLHelpWindow String Integer HTMLHelpWindowAlign ROBOHELP 8 SCRIPTING GUIDE 71 Classes Description New name for the index Description Read-only Parent HTMLHelpWindowManager object Read-write Name
  • Adobe 65030089 | Scripting Guide - Page 76
    String String String String String String String HTMLHelpWindow methods setWindowPosition Description Sets window placement properties. Returns Boolean ROBOHELP 8 SCRIPTING GUIDE 72 Classes Description Read-write Tripane default Tab Read-write Flags to show different buttons in the HTMLHelp window
  • Adobe 65030089 | Scripting Guide - Page 77
    String typename String previous Glossary next Glossary fileStatus FileStatus valid Boolean extension String location String path String ROBOHELP 8 SCRIPTING GUIDE 73 Classes Description Top position Left position Width of the window Height of the window Description Read-only Parent
  • Adobe 65030089 | Scripting Guide - Page 78
    ROBOHELP 8 SCRIPTING GUIDE 74 Classes Property name size creationDate modifyDate Data type Integer String String Description Read-only File size in bytes Read-only Creation date of the
  • Adobe 65030089 | Scripting Guide - Page 79
    ROBOHELP 8 SCRIPTING GUIDE 75 Classes undoCheckout Description Cancels the checkout of the specified file from the version control system. Returns Boolean Syntax undoCheckout () delete Description Deletes the specified
  • Adobe 65030089 | Scripting Guide - Page 80
    Property name parent Data type FMFileManager name String typename String previous FMFile next FMFile frameFileFormat FrameFileFormat ROBOHELP 8 SCRIPTING GUIDE 76 Classes Description New name for the glossary Description Read-only Parent FMFileManager object Read-only Name of the
  • Adobe 65030089 | Scripting Guide - Page 81
    Integer String String FMFile methods checkout Description Checks out the specified file from the version control system. Returns Boolean ROBOHELP 8 SCRIPTING GUIDE 77 Classes Description Read-write FrameMaker TOC file path (read/write) Read-write RoboHelp associated TOC name (read/write) Read
  • Adobe 65030089 | Scripting Guide - Page 82
    from the version control system. Returns Boolean Syntax undoCheckout () delete Description Removes the specified FrameMaker file from the project. Returns Boolean Syntax delete () ROBOHELP 8 SCRIPTING GUIDE 78 Classes
  • Adobe 65030089 | Scripting Guide - Page 83
    ROBOHELP 8 SCRIPTING GUIDE 79 Classes update Description Updates the FrameMaker file and generates specific topics in the RoboHelp project. Returns Boolean Syntax update (flagForceUpdate) Parameters Parameter name flagForceUpdate
  • Adobe 65030089 | Scripting Guide - Page 84
    control system. Returns Boolean Syntax checkout () checkin Description Checks in the specified file to the version control system. ROBOHELP 8 SCRIPTING GUIDE 80 Classes Description Read-write RoboHelp associated glossary name (read/write) Read-only Synchronization status of the Word file Read-only
  • Adobe 65030089 | Scripting Guide - Page 85
    from the project. Returns Boolean Syntax delete () update Description Updates the Word file and generates specific topics in the RoboHelp project. Returns Boolean ROBOHELP 8 SCRIPTING GUIDE 81 Classes
  • Adobe 65030089 | Scripting Guide - Page 86
    Syntax update (flagForceUpdate) Parameters Parameter name flagForceUpdate Data type Boolean Optional No ROBOHELP 8 SCRIPTING GUIDE 82 Classes Description Flag to force the update of the Word file
  • Adobe 65030089 | Scripting Guide - Page 87
    83 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
  • Adobe 65030089 | Scripting Guide - Page 88
    Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 84 Constants
  • Adobe 65030089 | Scripting Guide - Page 89
    Data type Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 85 Constants
  • Adobe 65030089 | Scripting Guide - Page 90
    properties Property name SKINUNKNOWN SKINWEBHELP SKINFLASHHEP SKINWEBFLASHHELP Data type Integer Integer Integer Integer FrameFileFormat Provides constants for different FrameMaker file formats in RoboHelp. ROBOHELP 8 SCRIPTING GUIDE 86 Constants
  • Adobe 65030089 | Scripting Guide - Page 91
    TAGIMAGE TAGHTML TAGHEAD TAGBODY TAGTITLE TAGMETA TAGLINK TAGANCHOR TAGPARAGRAPH TAGTABLE Data type Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 87 Constants
  • Adobe 65030089 | Scripting Guide - Page 92
    Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 88 Constants SyncStatus Provides constants for different synchronization statuses in the case of FrameMaker or Word files in RoboHelp
  • Adobe 65030089 | Scripting Guide - Page 93
    properties Property name FORMATDOCNONE FORMATDOC FORMATDOCX FORMATDOCM FORMATRTF Data type Integer Integer Integer Integer Integer HTMLHelpWindowAlign Provides constants for the Window Tab position. ROBOHELP 8 SCRIPTING GUIDE 89 Constants
  • Adobe 65030089 | Scripting Guide - Page 94
    BTN_BACK BTN_FORWARD BTN_STOP BTN_REFRESH BTN_HOME BTN_SYNC BTN_OPTIONS BTN_PRINT BTN_JUMP1 BTN_JUMP2 Data type Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 90 Constants
  • Adobe 65030089 | Scripting Guide - Page 95
    PROP_TAB_ADVSEARCH PROP_TAB_AUTOHIDEDSHOW PROP_TAB_GLOSSARY Data type Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 91 Constants
  • Adobe 65030089 | Scripting Guide - Page 96
    Property name PROP_EHELP PROP_AVENUE PROP_USER_POS Data type Integer Integer Integer ROBOHELP 8 SCRIPTING GUIDE 92 Constants
  • Adobe 65030089 | Scripting Guide - Page 97
    42 DeleteOption 86 E edit 43 executeScript 8 exportFile 50, 58 exportSettings 10 F File 45 FileManager 25 FileStatus 88 FMFile 76 FMFileManager 33 FrameFileFormat 14 importHtmlFile 13 importItem 20, 22 importMapFile 43 importSettings 10 importWordDoc 14 Index 68 IndexManager 28 insertText 18 item 15
  • Adobe 65030089 | Scripting Guide - Page 98
    Token 16 TokenManager 15 TokenType 87 Topic 59 TopicManager 19 U UDV 51 UDVManager 24 unassign 42 update 17, 79 updateAll 12 V view 55 W WordFile 79 WordFileFormat 89 WordFileManager 34 ROBOHELP 8 SCRIPTING GUIDE 94 Index
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
Scripting Guide
ADOBE
®
ROBOHELP 8
®