form methods and properties

 

properties

Name

Read

Write

Description

actualprocess

x
S

 

return the actual process

authorization.set
authorization.overload
<authorization>

 

 

x

x

x

 

You can set form authorization with

form.authorization.set=full/read/no

 

You can overload the form autorization with

form.authorization.overload=full/read/no

(we use this with open form with extented rights)

 

You can read the current authorization with

<form.authorization>

 

Follow settings available

Property

Description

alternative

full

full access

1

read

read access

2

no

no access

-1

 

Compatiblity

 

Overload

form.authorization.overload=1
setvar=sysrechtvoll=1
zugriff=full

 

Set

form.authorization.set=1
setvar=zugriff=1

 

Read

<form.authorization>
zugriff
if <czugriff> = 1 then
  //..
end if

 

iws.is_authorization

authorization.load=id

 

x

 

beas use this form in the master script while opening the form

close form automatically after red message "beaszugr054^no access", if user don't have access

blockupdate=true/false

x

x

 

Button don't go to update

Example

 

form.blockupdate=true

 

ib_blockupdate, sys_keineaktualisierung J/N

border=yes/no

 

x

avtivate/deactivate the border (only beas)

bringtotop=yes/no

 

x

bring the form allways to top (only beas)

cancel

 

x

Cancel current form without update

beas execute follow events

if form in mode UPDATE or ADD: formevent syscancel

Example: Cancel form after executing all open processes

wait
form.cancel

Example: Question, if any data is changed

formevent close:ok
question=you changed data. Do you want to close the form without update?==cancel
end event

 

 

syntax: close:cancel

Variable: syscancel ja=check update, close=close process is running

 

center=yes/no

 

x

center form

checksql

x

x

3 = check all (Standard)

2 = check SQL Syntax, but not GetWhere/GetOrder

     (browser list/sort/filter not working)

1 = don't read SQL Statement

     (browser list/sort/filter not working, SQL Event not executed, templates not working)

il_checksql beas 9.3 PL 2

click.[property]

x

 

 

Property

Description

form.click.dw

Click on dw (dw_1....7) is_clickdw

form.click.y

Mouse click position y il_clicky

form.click.x

Mouse click position x il_clickx

form.click.object

Name of clicked object is_clickobject

form.click.objecttype

Object type, example: dataform, column, text, compute ... is_clickobjecttype

form.click.row

Click on row il_clickrow

client.x,y,width,height

 

x

Return the position of the client inside the current form

Example <form.client.x>

clickmode

x

 

 

Example:

if <form.clickmode> = right then
  // right mouse click
end if

clicking

x

 

 

return "true" in rowchange or focus change, if reason a mouse click

it's false after rowchange/focus change before beas execute the click scripts

Have only effect in rowchange/focuschange event

close

 

x

 

if update / add process is running, beas don't close the form and make only an update

 

Example:

form.close

 

If beas only close the form, beas callse follow userevents

 

Before update
formevent close:ok

After update, before closing form
formevent close:ok:cancel

 

 

 

syntax: close:ok

Variable: syscancel, close=close process is running

 

closesetfocus=parent/no

 

x

 

form.closesetfocus=parent   parent form becomse the focus (default)

form.closesetfocus=no         don't set focus. Next form becomse focus

 

if you want open a new form from child form and you want to close your child form, the new form must have the focus. In this situation set form.closesetfocus=no

 

Example:

Preview form (Preview Icon)

1. beas open form "current form", "Report...."
2. beas close this form and open the report self

 
In this situation the form must loose the focus

 

is_closesetfocus=parent/no

closewindowmessage

 

x

 

if you change anything and you click on "X", beas ask

 
Do you want save the changes YES/NO

 

with this property you can change this message

 

Id

Message

0

Do you want save the changes? (only in update/add mode)

1

Do you want close the window (always)

2

Do you want close the window (only in update/add mode)

-1

No message

 

beas 9.3 PL 2

controlmenu=yes/no

 

x

activate the control-Menu of the current form (only baes)

enabled=yes/no

 

x

enable-propertie from form

focus.[property]

x

 

 

command

Description

form.focus.dw

Click on dw (dw_1....7) is_clickdw

form.focus.y

Mouse click position y il_clicky

form.focus.x

Mouse click position x il_clickx

form.focus.object

Name of clicked object is_clickobject

form.focus.objecttype

Object type, example: dataform, column, text, compute ... is_clickobjecttype

form.focus.row

Click on row il_clickrow

getvaliddw

x

 

 

return result in return object in field value

dw_1 <tab> dw_1.dataobject <cr_lf> ...

 

example:
setvar=ls_datawindows=<system.window.artikel_browse.getvaliddw>

 

handle

x

S

 

return the handle number of this form.

You can send information to this form with follow script

send=<handleid>=<eventid>=command

inserttype

x

x

 

0 (Default): at the end

1 = next line

 

example: form.inserttype=1 beas 9.2 PL: 01

last.[property]

x

 

 

Property

Description

form.last.dw

Dataform (dw_x) who lost focus  is_lastdw (old: <sys_lastdwfocus>)

form.last.object

Object who last focus   ls_lastobject (old: <dwo-changed>) <dwo> <dw_x_lastdwo> (dw_x.is_last_object)

form.last.row

Last row   il_lastrow (old: <dwo-row>)

maxbox=yes/no

 

x

activate the maxbox-Control of the current form (only beas)

maximized

 

x

maximized the form (only beas)

mode

x

S

x

Define and read current formmode (OK/UPDATE/READ)

move=x=y

 

x

move Form
also works within beasgui

modify

 

x

 

This is the interface to the ue_formsetup object, with which you can modify a form

See formsetup

 

form.modify.[property].value

 

Property

Read

Write

Description

transfervalidfields

 

x

Transfer current column information in the modify form (used by right mouse click)

form.modify=transferfields

name

x

 

Name of first dataform dw_1 without folder and ".psr" is_name

openscript

x

x

Set and return the command description to open this form

printdw

x

x

Example: if you click on print icon and you want, that beas print dw_2:

 

form.printdw=dw_2

pint

 

See print

is_printdw (old: <sys_printdw>)

redraw=yes/no

 

x

redraw=yes    redraw the form

redraw=no      freeze the form

redrawallcolumns

 

 

if you defined additional columns with dw_x.item.columnname.formatstring outside open/new event or if you change this type of properties, you must send a redraw. You can use this command to redraw all columns

dw_1.item.itemcode.background.ok=23000

form.redrawallcolumns

Beas 2020.02

reload

 

 

x

 

Execute the Reloading process

1. execute event "retrieve".

2. update form. if any data changed, beas run the complete update process

3. start resize process

 

if you set the parameter "retrieve", beas don't reload the dataform definition and make only the retrieve process

 

Example:

 

form.reload

 

form.reload=retrieve

 

Old syntax: retrieve, reload

 

return.[property]=value

x

x

 

You can write information back to preview window, if you work with ue_form object

 

declare=myform=ue_form
myform.psr=mypsrfile.psr
myform.showdialog
if <myform.ret_code> = 1 then
   messagebox=return value: <myform.ret_value>
end if

 

in myform.psr

 

if <form.return.valid> = true then
  form.return.ret_code=1
  form.return.ret_value=...
  form.return.ret_text=...
  form.return.ret_s_parm1=...
end if

 

you can write all str_parm values

 

the placeholder <form.return.valid> return true, if the parent window is existing

 

resize

 

x

start manual the resizing of the form

resizable=<yes/no>

 

x

set the form to resizable / not resizable

resizemode=u/f/c

x

x

Set or read the resize mode

resized

x

 

return true, if user resized window, false if not

ret_code

x

 

Return return code from last function call in this object

ret_value

x

 

Return text value information from last function call in this object

ret_text

x

 

Return text information from last function call in this object

save

 

x

Save / Update all Data

setconvert

x

 

form.setconvert.property=value

 

Property

Read

Write

Description

inlinesql

 

x

convert <select ...> commands? true/false

(Standard=true)

 

example

 

form.setconvert.inlinesql=true
setvar=ls_test=<select 'Hello World' from "BEAS_DUMMY">
// return Hello world
 
form.setconvert.inlinesql=false
setvar=ls_test=<select 'Hello World' from "BEAS_DUMMY">
// return select 'Hello World' from "BEAS_DUMMY"

 

 

systemborder

 

x

 

if you deactivate the border, beas make "dw_master" unvisible

This dataform display the tab sheets and buttons.

 

Disable buttons row

form.systemborder=false

 

Enable buttons row

form.systemborder=true

 

Old syntax: rahmen=0/1

template

x

x

Control templates

beas 9.2 PL: 06

 

form.template.[property]

 

Name

Read

Write


form.template.dw=dw_x

x

x

define or return the dataform which will save in the template (default = dw_1)

form.template.dw=dw_2

is_templatedw

form.template.choose

 

x

set this template as current template
form.template.choose=myTemplate

form.template.sql.x

x

 

SQL Value from current Template. x=1 to 6

messagebox=<form.template.sql.1>

form.template.sql.sqlwehre

x

 

return the current template sql where

form.template.sql.sqlorder

x

 

return the current template sql order

form.template.template_id

x

 

return the current template id

form.template.zoom

x

 

return the current zoom factor

tabsheet

 

 

 

Work with buttom tab's

With every tab you can define a new window (PSR File) inside the current form (master window)

 

Part of object window

 

form -> tabsheet

 

tab00001

 

 

Name

Read

Write

Description

height

x

x

 

form.tabsheet.height=88

 

if you need the position of dw_1 (first formular), use

<window.client.y>

choose=page

 

x

 

You can choose to another tab

 

form.tabsheet.choose=2

title=<text>

x

x

if you set the title, work with "title"

// set title
title=<translate:My form>
// display title
title

 

To set only the beas-Title and not the sap-form-Title

form=title=hello world

 

return current tilte

messagebox=<form.title>

topic

x

x

Define the topic of beas help: form.topic=itemmasterdat.htm is_topic <sys_topic>

Alias: topicid

torightdown

 

 

set form to right down of MDI-form (only beas)

type

x

x

 

Follow return values

report = Report form (Print preciew)
browse = browse form

structure = Structure form

edit = Edit form (1 line)
editbrowse = Editable browser form

choose = choose form

 

beas set this with command menu.typ=<property>

This command define the default buttons
Is a part of settings in crtl+N+B

 

You can overwrite this with

form.type=...

This command don't change the default buttons.
But other functions, example check B1UP functions, check the property

 

Example

// set buttons for browse form
menu.typ=browse
// but form is a structure view
form.type=structure

 

Alias for write: form.typ

beas 9.2 PL 06, iws.is_type

udf

x

x

Define the UDF fields for main window

form.udf=<variablename>=[<datawindow>]=[<fieldname>]

 

Example:

Variable=routing (routing1...4)

DataWindow = dw_1

Fieldname = srouting

 

form.udf=routing=dw_1=srouting

 

Definition must be in settings or form.load event

is_setudf beas 9.3 PL 2

visible=yes/no

 

x

visible from the form

formstate=<state>

 

x

 

form=formstate=minimized
form=formstate=maximized
form=formstate=normal

x,y,width,height

x

x

 

if you set x, y and beas runs in SAP-Area, then you the the position in the SAP-Form, not in the MDI-Form.

if you start beas without SAP, then you set the position in the MDI-Form

if you set the form unvisible, then you set only the beas-form, but not the SAP-Form to unvisible

 

xcenter,ycenter

x

 

return the middle point of form, example: If form have a width from 1000, <form.xcenter> return 500

zoom

x

x

return current zoom percent factor from actual form ii_zoom

if you set this: only for follow components. beas don't redraw the form

form

x

x

 

system.form.current.x // return x position from current form
system.form.parent.x // return x position from parent form
system.form.artikel_browse.x // return x position from first instance of the form with same name
system.form.editing.x // return x position of this form
<system.form.editing.dw_1.item.itemcode.value> // return the value of this item