Editions
Related Transactions
Example
The PlaceHotspotAndData transaction places a hotspot object, along with its data string, in the specified document window, on the current page's active edit layer (Full Edit or Hotspot type). The hotspot data is sent to the associated hotspot program on hotspot activation, and controls what action occurs.
Type XTYP_EXECUTE
Syntax [PlaceHotspotAndData(docwinID, objectType, "hotspotID", "hotspotData", units, p1, p2, p3, <p4>)]
|
Parameter |
Data type |
Values |
Meaning | ||
|
docwinID |
DWORD |
0 | docwinID |
active | specific | ||
|
objectType |
WORD |
|
shape of hotspot to place: | ||
|
|
|
4 |
line | ||
|
|
|
5 |
box | ||
|
|
|
6 |
circle | ||
|
|
|
7 |
ellipse | ||
|
|
|
30 |
icon | ||
|
hotspotID |
identifier of the hotspot, maximum 40 characters. See Remarks. | ||||
|
hotspotData |
string |
data to place in the hotspot, maximum 30,000 characters | |||
|
units |
WORD |
0 |
|||
|
p1, p2, p3, <p4> |
DWORDs |
placement coordinates, the meaning of which varies with the objectType. The fourth coordinate is not always required. See Remarks. | |||
|
objectType |
p coordinate values |
Meaning | |||
|
4 (line) |
x1, y1, x2, y2 |
end-point coordinates of line object | |||
|
5 (box) |
x1, y1, x2, y2 |
upper-left and bottom-right coordinates of corners of box object | |||
|
6 (circle) |
x, y, r |
center coordinates and radius of circle object | |||
|
7 (ellipse) |
x1, y1, xr, yr |
center coordinates and radii in both dimensions of ellipse object | |||
|
30 (icon) |
x, y, n |
icon drop point coordinates and index of icon to use (n = 1-130) | |||
Remarks
The hotspotID can be unique to each hotspot, but this is not required. For example, you can give three hotspots the ID of "MANY." Then any transaction you send to activate "MANY" hotspots will apply to all three.
The placement coordinates are relative to the MER (minimum enclosing rectangle) of the page.
You have to define the attributes (such as fill color, line style, and line width) of the hotspot object before you place it--you cannot set them using this transaction. To define attribute values, you must use the SetLayerToolAttribute (to set attributes for the active edit layer) or the SetSystemToolAttribute (to set attributes for future edit layers).
Release information
Added in Release 4.10x.
See also