:acviewport. (Application-Controlled Window)

Enables an application to dynamically control what is displayed in an IPF window.

Syntax

┌───────────────┬───────────────┬───────────────┬───────────────┐
│Tag            │Element        │Attributes     │End            │
├───────────────┼───────────────┼───────────────┼───────────────┤
│:acviewport.   │Have IPF call a│dll=' '        │               │
│               │function in a  │objectname=' ' │               │
│               │dynamic-link   │objectinfo=' ' │               │
│               │module.        │objectid=' '   │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │Define the     │vpx=           │               │
│               │window in which│vpy=           │               │
│               │the function   │vpcx=          │               │
│               │runs.          │vpcy=          │               │
└───────────────┴───────────────┴───────────────┴───────────────┘

Attributes

dll=' '

Specifies a dynamic-link module for IPF to load so that a communication object (a function) in the module can be run in a window (an application-controlled window).
objectname=' '
Identifies the entry point of the communication object in the dynamic-link module. The value specified for this attribute is case sensitive.
objectinfo=' '
Identifies parameters to be passed to the object.
objectid=' '
Specifies an identifier that will associate the window with the object. The application or communication object can get this value from the Object ID field in the ACVP data structure and use it to determine the panel that activated the viewport.
vpx=
vpy=
vpcx=
vpcy=

Define the location and size of the window. vpx= and vpy= are positions along the x (horizontal) and y (vertical) axes. The point where the values intersect represents the origin of the window. vpcx= and vpcy= represent changes along the x and y axes with respect to the origin.

These attributes can be expressed as absolute values, relative values, or dynamic values:

Absolute value:

A number followed by a letter, which indicates the unit of measure:

c

(Characters): Average character width of the default system font.
x
(Pixels): Dependent on the display adapter in use.
p
(Points): Typesetting measure; equal to approximately 1/72 inch.
Relative value:
A number followed by the percent sign (%), indicating a percentage of the parent-window width or height.
Dynamic value:
A term indicating a window coordinate location that is dependent on the current size and position of the parent window:

left | center | right

For x values, flush left with, in the center of, or flush right with the parent window.
top | center | bottom
For y values, at the top, center, or bottom of the parent window.

Description

:acviewport. is used in either a help file or an online document file to specify that a window will be under the control of a routine that was written and compiled as part of a dynamic-link module. When an IPF window is selected for display at run time, and :acviewport. is encountered, IPF passes control to the entry point (objectname=) in the dynamic-link module. At this point, the routine in the module takes control. For more information, see Customizing IPF with Communication Objects.

The definition for :acviewport. must follow a primary heading; for example:

:h2 res=2000    x=left y=top width=100% height=100%
    scroll=none titlebar=both clear group=1.Information Windows
:acviewport dll='My_DLL' objectname='My_Routine' objectid='1'
    vpx=right vpy=top vpcx=50% vpcy=100%

In the example, a window is displayed within the primary window indicated by the heading tag (:h2.) and its attributes. The contents of the window are controlled by the communication object, My_Routine, in the dynamic-link module, My_DLL.

When the user selects the primary window and :acviewport. tag is encountered, IPF calls the communication object in the dynamic-link module and sizes the child window.

---

[Back: .nameit (Nameit)]
[Next: :artlink. (Art Link)]