Adobe 65030089 Scripting Guide - Page 69

TOC properties

Page 69 highlights

Syntax applyMasterPageToTopics (arrayOfTopics) Parameters Parameter name arrayOfTopics Data type Array Optional No TOC Handles specific TOC functions in the project. TOC properties Property name parent Data type TOCManager 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 TOCManager object Read-write Name of the TOC Read-only Class name of the reference object Read-only Returns the previous TOC object Read-only Returns the next TOC object Read-only Status of the file Read-only Returns true if the file is present physically Read-only File extension Read-only Path to the folder in which the file is present Read-only Absolute file path

  • 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

65
ROBOHELP 8 SCRIPTING GUIDE
Classes
Syntax
applyMasterPageToTopics (arrayOfTopics)
Parameters
TOC
Handles specific TOC functions in the project.
TOC properties
Parameter name
Data type
Optional
Description
arrayOfTopics
Array
No
A JavaScript array. Eac
h
element of t
h
is array
must be a topic object.
Property name
Data type
Description
parent
TOCManager
Read-only
Parent TOCManager object
name
String
Read-write
Name of t
h
e TOC
typename
String
Read-only
Class name of t
h
e reference object
previous
TOC
Read-only
Returns t
h
e previous TOC object
next
TOC
Read-only
Returns t
h
e next TOC object
fileStatus
FileStatus
Read-only
Status of t
h
e file
valid
Boolean
Read-only
Returns true if t
h
e file is present p
h
ysically
extension
String
Read-only
File extension
location
String
Read-only
Pat
h
to t
h
e folder in w
h
ic
h
t
h
e file is present
path
String
Read-only
Absolute file pat
h