Home » Adobe Manuals » Computer Software » Adobe 65030089 » Manual Viewer

Adobe 65030089 Scripting Guide - Page 9

RoboHelp methods

UPC - 883919170626

Add to My Manuals
Save this manual to your list of manuals

Page 9 highlights

Property name FileStatus SyncStatus ServerType WordFileFormat Data type FileStatus SyncStatus ServerType WordFileFormat RoboHelp methods openProject Description Opens .mpj and .xpj projects in a RoboHelp application. Syntax openProject (projectPath, upgradeIfRequired) Parameters Parameter name projectPath Data type String Optional No upgradeIfRequired Boolean Yes 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 constant Description Full path to the project file that you want to open Upgrade the project if created in an older version of RoboHelp. The default value is false. If the project does not require an upgrade, this parameter is ignored.

Section	Page
Contents	3
Chapter 1: Scripting basics	5
Scripting support in RoboHelp	5
Creating scripts	5
Debug scripts	5
Edit scripts	5
Managing scripts from within RoboHelp	5
Running scripts	6
RoboHelp sample scripts	6
RoboHelp object model	6
Chapter 2: Classes	8
RoboHelp	8
RoboHelp properties	8
RoboHelp methods	9
openProject	9
getTokenManager	9
getCurrentProject	10
closeProject	10
newProject	10
newProjectImport	11
bringToFront	12
quit	12
executeScript	12
closeAllWindows	12
Project	13
Project properties	13
Project methods	14
importSettings	14
exportSettings	14
outputMessage	15
rename	15
updateAll	16
importDITAMap	16
autoCreateBrowseSequence	17
importHtmlFile	17
importWordDoc	18
importFrameMakerDoc	18
TokenManager	19
TokenManager properties	19
TokenManager methods	19
item	19
save	20
Token	20
Token properties	20
Token methods	21
update	21
getAttribute	21
setAttribute	22
removeAttribute	22
insertText	22
delete	23
TopicManager	23
TopicManager properties	23
TopicManager methods	23
item	23
newItem	24
importItem	24
MasterPageManager	25
MasterPageManager properties	25
MasterPageManager methods	25
item	25
newItem	25
importItem	26
SnippetManager	26
SnippetManager properties	26
SnippetManager methods	27
item	27
newItem	27
importFile	27
UDVManager	28
UDVManager properties	28
UDVManager methods	28
item	28
newItem	28
FileManager	29
FileManager properties	29
FileManager methods	29
item	29
checkoutAll	30
checkinAll	30
getLatestAll	30
TOCManager	30
TOCManager properties	31
TOCManager methods	31
item	31
newItem	31
IndexManager	32
IndexManager properties	32
IndexManager methods	32
item	32
newItem	32
GlossaryManager	33
GlossaryManager properties	33
GlossaryManager methods	33
item	33
newItem	33
SkinManager	34
SkinManager properties	34
SkinManager methods	34
item	34
CBTManager	35
CBTManager properties	35
CBTManager methods	35
item	35
newItem	35
SSLManager	36
SSLManager properties	36
SSLManager methods	36
item	36
FMFileManager	37
FMFileManager properties	37
FMFileManager methods	37
item	37
newItem	37
WordFileManager	38
WordFileManager properties	38
WordFileManager methods	38
item	38
newItem	38
ReportManager	39
ReportManager properties	39
ReportManager methods	39
save	39
print	40
copy	40
mail	40
ServerManager	41
ServerManager properties	41
ServerManager methods	41
item	41
newItem	41
Server	42
Server properties	42
Server methods	43
changeToFTP	43
changeToHTTP	43
changeToFrontPage	44
changeToFileSystem	44
delete	44
MapIdManager	45
MapIdManager properties	45
MapIdManager methods	45
newMapId	45
assign	45
unassign	46
delete	46
edit	47
newMapFile	47
importMapFile	47
setCurMapFile	48
HTMLHelpWindowManager	48
HTMLHelpWindowManager properties	48
HTMLHelpWindowManager methods	49
item	49
newItem	49
File	49
File properties	50
File methods	50
checkout	50
checkin	51
getLatestVersion	51
undoCheckout	51
Skin	51
Skin properties	52
Skin methods	53
checkout	53
checkin	53
getLatestVersion	53
undoCheckout	53
delete	54
exportFile	54
CBT	54
CBT properties	54
CBT methods	55
delete	55
UDV	55
UDV properties	55
UDV methods	56
delete	56
SSL	56
SSL properties	56
SSL methods	58
delete	58
createDuplicate	58
generate	58
view	59
publish	59
clearAllOverrides	59
applyMasterPageToAllTopics	59
applyCSSToAllTopics	60
Snippet	60
Snippet properties	60
Snippet methods	61
checkout	61
checkin	61
getLatestVersion	62
undoCheckout	62
delete	62
exportFile	62
createDuplicate	63
Topic	63
Topic properties	63
Topic methods	64
checkout	64
checkin	65
getLatestVersion	65
undoCheckout	65
delete	65
MasterPage	66
MasterPage properties	66
MasterPage methods	67
checkout	67
checkin	67
getLatestVersion	67
undoCheckout	68
delete	68
rename	68
applyMasterPageToTopics	68
TOC	69
TOC properties	69
TOC methods	70
checkin	70
checkout	70
getLatestVersion	70
undoCheckout	71
delete	71
autoCreateTOC	71
rename	71
setAsDefault	72
Index	72
Index properties	72
Index methods	73
checkout	73
checkin	73
getLatestVersion	74
undoCheckout	74
delete	74
rename	74
setAsDefault	75
HTMLHelpWindow	75
HTMLHelpWindow properties	75
HTMLHelpWindow methods	76
setWindowPosition	76
Glossary	77
Glossary properties	77
Glossary methods	78
checkout	78
checkin	78
getLatestVersion	78
undoCheckout	79
delete	79
newItem	79
rename	79
setAsDefault	80
FMFile	80
FMFile properties	80
FMFile methods	81
checkout	81
checkin	82
getLatestVersion	82
undoCheckout	82
delete	82
update	83
WordFile	83
WordFile properties	83
WordFile methods	84
checkout	84
checkin	84
getLatestVersion	85
undoCheckout	85
delete	85
update	85
Chapter 3: Constants	87
Syntax for using constants	87
SSLLayoutType	87
SSLLayoutType properties	87
Language	87
Language properties	88
ReportType	89
ReportType properties	89
DeleteOption	90
DeleteOption properties	90
Status	90
Status properties	90
SkinType	90
SkinType properties	90
FrameFileFormat	90
FrameFileFormat properties	91
TokenType	91
TokenType properties	91
TagType	91
TagType properties	91
FileStatus	92
FileStatus properties	92
SyncStatus	92
SyncStatus properties	92
ServerType	93
ServerType properties	93
WordFileFormat	93
WordFileFormat properties	93
HTMLHelpWindowAlign	93
HTMLHelpWindowAlign properties	94
HTMLHelpWindowDefaultTab	94
HTMLHelpWindowDefaultTab properties	94
HTMLHelpWindowButtons	94
HTMLHelpWindowButtons properties	94
HTMLHelpWindowProperties	95
HTMLHelpWindowProperties properties	95
Index	97
A	97
B	97
C	97
D	97
E	97
F	97
G	97
H	97
I	97
L	97
M	97
N	97
O	97
P	97
Q	97
R	97
S	97
T	97
U	98
V	98