Software Customisation Reference Manual
Summary of Objects, Members and Methods : Object Type Details : VIEW Gadget: AREA View
VIEW Gadget: AREA View
Members
 
Name
Type
Purpose
Limits
REAL ARRAY[4] Get/Set
Get or set limits box [x1,y1,x2,y2].
Borders
BOOLEAN Get/Set
Get or set borders ON (TRUE) or OFF (FALSE).
Background
REAL Get/Set
Get or set background Colour Number
Background
STRING Set Only
Set background Colour Name.
Contents
REAL ARRAY[2] Get/Set
Get or set User contents ID.
Defcall
STRING Get/Set
Get or set default interaction callback.
Height
REAL Get Only
Get view height.
Highlight
REAL Get/Set
Get or set highlight Colour Number.
Highlight
STRING Set Only
Set highlight Colour Name
Prompt
GADGET Get/Set
Get or set User Prompt PARAGRAPH gadget.
Subtype
STRING Get Only
Get subtype of graphic view.
Width
REAL Get Only
Get view width.
Table 2: 135.
VIEW AREA Object Methods
Methods
 
Name
Result
Purpose
Background()
STRING
Returns the highlight colour as a name string.
Clear()
NO RESULT
Clear VIEW contents
Highlight()
STRING
Returns the highlight colour as a name string.
Refresh()
NO RESULT
Refreshes the display of the gadget
RestoreView(REAL storeNumber)
NO RESULT
Restores the saved VIEW with the given store number.
SaveView(REAL storeNumber)
NO RESULT
Saves the current VIEW. The number must be in the range 1 to 4.
SetSize(REAL width, REAL height)
NO RESULT
Set VIEW size.
Table 2: 136.
VIEW AREA Object Methods
Command
The VIEW ... AREA command puts you into View Setup mode. You remain in View Setup mode until you use the EXIT command.
           .-------------------------<------------------------.
          /                                                   |
(AREa) --+- <vshap> -----------------------------------.      |
         +- PUT - <sgid> ------------------------------|      |
         +- LIMits <uval> <uval> - TO - <uval> <uval> -|      |
         +- SETColour - <colno> -----------------------|      |
         +- SETHighlight - <colno> --------------------‘- NL -|
         +- <cursor> -----------------------------------------|
         +- <border> -----------------------------------------|
         +-- <pml> -------------------------------------------*
         ‘-- EXIT -->
 
Figure 2:69.
Syntax Graph -: Setting Up an AREA VIEW Object
DRAW where <sgid> is either CE (current element) or the name of a 2D graphical element (e.g., a DRAW SHEET, VIEW, LIBRARY, etc.) and <colno> is any valid DRAW colour definition.
And <cursor> is the syntax for selecting the cursor type, as follows:
>-- CURSortype ---+-- POINTER ----.
                  +-- NOCURSOR ---|
                  +-- PICK -------|
                  +-- PICKPLUS ---|
                  ‘-- CROSSHAIR ‑-‘-->
Figure 2:70.
Syntax Graph -: Setting Up the Cursor Type
<border> allows control of zooming and panning:
>--- BORDers --+-- ON --.
               ‘-- OFF ‑‘--->
Figure 2:71.
Syntax Graph -: Setting Up the Border
1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA Logo