HTML Help
ActiveX Control Syntax
All
of the code required for an instance of the HTML Help ActiveX control is
contained within the HTML
<OBJECT>
start and end tags. Use the
<OBJECT>
tag to specify a command,
such as Splash or Contents, and to call a
method,
such as Click or TextPopup.
Using the HTML Help ActiveX Control
Wizard in HTML Help Workshop, you can
insert
the basic syntax automatically.
Coding
the HTML <OBJECT> tag
The <OBJECT> tag enables
you to embed the HTML Help ActiveX control directly in a file. The
attributes in the following table are required by the control.
|
Attribute
|
Description
|
|
ID
|
Specifies the name by
which the HTML Help ActiveX control will be known to the HTML file.
The default ID is HHCTRL, but you can specify any name you
want.
For example, if you
entered Test as the ID, you would use that same ID to refer to
the control from a script.
If you use multiple instances of the HTML Help ActiveX control in a
file, each instance must have a unique ID.
|
|
TYPE
|
Specifies the MIME type for the object. The HTML Help ActiveX control
TYPE is application/x-oleobject.
|
|
CLASSID
|
Uniquely identifies
the HTML Help ActiveX control from other ActiveX controls. The HTML
Help ActiveX control identifier is the registry key number and is the
same for every instance of the control that you use.
The HTML Help ActiveX control CLASSID is
clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11.
|
|
CODEBASE
|
Specifies the version number of the HTML Help ActiveX control. Enables
the automatic download mechanism of ActiveX controls and full version
checking.
|
|
PARAM
|
The PARAM attribute, which is also an HTML tag with attributes
specific to it, lists a sequence of NAME and VALUE attribute pairs
that are passed to the HTML Help ActiveX control to specify which HTML
Help feature to provide and how to provide it.
|
Notes
-
Several standard
<OBJECT>
tag attributes, such as
ALIGN,
BORDER,
CODETYPE,
DECLARE,
HEIGHT,
HSPACE,
NAME,
SHAPES,
STANDBY,
USEMAP,
VSPACE,
and
WIDTH,
can also be used to define the appearance and position of the HTML Help
ActiveX control.
- WIDTH
and
HEIGHT
values can be expressed in percentage, followed by a percent sign, or in
pixels (numeric value only).
-
The HTML Help ActiveX control does not support the
<OBJECT>
tag
DATA
attribute.
Coding the
<PARAM> tag
The
<PARAM>
tag is used to pass a sequence of
parameters to the HTML Help
ActiveX control to specify a feature and any additional information that
the feature may require.
The
<PARAM>
tag is valid only within an
<OBJECT>
tag. The end tag is optional.
|
Attribute
|
Description
|
|
NAME
|
Specifies a parameter. The first parameter in the sequence must be
Command.
|
|
VALUE
|
Specifies a valid value for the parameter specified in the NAME
attribute.
|
|
