Adobe 65030089 Scripting Guide - Page 19

TokenManager

Page 19 highlights

Parameters Parameter name filePath folderName frameMakerTOCFilePath TOCName addIndexToTopic indexName glossaryName Data type String String String String Boolean String String Optional No No No No No No No TokenManager Handles tokens for a specific file. TokenManager properties Property name parent Data type 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 which the FrameMaker document is to be imported Absolute path of the FrameMaker TOC file for the FrameMaker document to import Name of the existing or new TOC for the imported FrameMaker document Whether the index from the FrameMaker document is added to the imported topics or not If addIndexToTopic is false, this is the name of the existing or new index for the imported FrameMaker document. Name of the existing or new glossary for the imported FrameMaker document Description Read-only RoboHelp application object Read-only Class name of the reference object Read-only Number of tokens in the file Read-only Checks if the token file is valid or not

  • 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

15
ROBOHELP 8 SCRIPTING GUIDE
Classes
Parameters
TokenManager
Handles tokens for a specific file.
TokenManager properties
TokenManager methods
item
Description
Returns the token specified by the index.
Parameter name
Data type
Optional
Description
filePath
String
No
Absolute pat
h
of t
h
e FrameMaker document
to import
folderName
String
No
Relative pat
h
of t
h
e folder t
h
e in t
h
e current
project in w
h
ic
h
t
h
e FrameMaker document is
to be imported
frameMakerTOCFilePath
String
No
Absolute pat
h
of t
h
e FrameMaker TOC file for
t
h
e FrameMaker document to import
TOCName
String
No
Name of t
h
e existing or new TOC for t
h
e
imported FrameMaker document
addIndexToTopic
Boolean
No
W
h
et
h
er t
h
e index from t
h
e FrameMaker
document is added to t
h
e imported topics or
not
indexName
String
No
If
addIndexToTopic
is false, t
h
is is t
h
e name
of t
h
e existing or new index for t
h
e imported
FrameMaker document.
glossaryName
String
No
Name of t
h
e existing or new glossary for t
h
e
imported FrameMaker document
Property name
Data type
Description
parent
RoboHelp
Read-only
RoboHelp application object
typename
String
Read-only
Class name of t
h
e reference object
count
Integer
Read-only
Number of tokens in t
h
e file
valid
Boolean
Read-only
C
h
ecks if t
h
e token file is valid or not