WP Get frame

Home

4D v20 R7

WP Get frame


WP Get frame ( {* ;} wpArea {; textBoxID} ) -> Function result

Parameter	Type	Description
*	Operator	If specified, wpArea is a form object name (string). If omitted, wpArea is an object field or variable.
wpArea	String	Form object name (if * is specified) or 4D Write Pro object variable or field (if * is omitted)
textBoxID	String	ID of the text box (only filled if a text box has the focus)
Function result	Longint	Frame where the cursor is currently set

Description

The WP Get frame command returns the frame where the cursor is currently set within the 4D Write Pro wpArea area.

If you pass the optional * parameter, you indicate that wpArea is a form object name (string). If you do not pass this parameter, you indicate that wpArea is a 4D Write Pro object variable or field.

Note: This command can only be used if the wpArea is associated with a form object (i.e. it is displayed in the current form/page).

The returned value can be compared to one of the following constants from the 4D Write Pro Constants theme:

Constant	Type	Value	Comment
wk body	Longint	0	Body frame of the section
wk current section default footer	Longint	10	Default footer of the section (available only if there is no active subsection footer)
wk current section default header	Longint	9	Default header of the section (available only if there is no active subsection header)
wk current section first footer	Longint	4	Footer of the first page of the section
wk current section first header	Longint	3	Header of the first page of the section
wk current section left footer	Longint	6	Footer of the left page(s) of the section
wk current section left header	Longint	5	Header of the left page(s) of the section
wk current section right footer	Longint	8	Footer of the right page(s) of the section
wk current section right header	Longint	7	Header of the right page(s) of the section
wk text box	Longint	11	Text box

If the cursor is currently set in a text box element, the element id of the text box is returned in the textBoxID parameter. In all other cases, this parameter is returned empty.

Example

You want to make sure the user has set the cursor in a header or a footer frame:

 var $frameGet : Integer

 $frameGet:=WP Get frame(*;"WParea")

 If($frameGet=wk body)|($frameGet=wk text box)

    ALERT("Please select a footer or a header.")

 End if