printform1

printform1
	Chapter 26. databaseforms

printform1

Description

Type Tags

printform1, dataform1, dataform1linkcontainer

Object Value

Objects of type printform1 have no value, and it is an error to try to get or set this value.

printform1.new()

Description

Prototype

printform1.new ( printform1 me, integer defpagewidth, integer defpageheight, integer defpagebackcolor, string defbooleanformat, string defintegerformat, string defnumberformat, string defdateformat, string deftimeformat, string defdatetimeformat, SBLlocaledateinfo defdatelocale, SBLNumSettings defnumericlocale, wxfont deffont, boolean createdisplayform, string printpreviewtitle, string currentworkingdirectory, boolean loading, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
defpagewidth	`210000`	integer
defpageheight	`297000`	integer
defpagebackcolor	`16777215`	integer
defbooleanformat	`T\|F`	string
defintegerformat	`.`	string
defnumberformat	`999999.00`	string
defdateformat	`yyyy.0m.0d`	string
deftimeformat	`hh:mm:ss`	string
defdatetimeformat	None	string
defdatelocale	None	SBLlocaledateinfo
defnumericlocale	None	SBLNumSettings
deffont	None	wxfont
createdisplayform	`.false`	boolean
printpreviewtitle	`Superbase NG Print Form`	string
currentworkingdirectory	None	string
loading	`.false`	boolean
error	None	integer

Properties

Property	Type	Description
_	type(*)
__	type(*)
_private	printform1private
addbitmap	function
addcontrol	function
adddatasource	function
addgraphic	function
addpage	function
addsiblinglink	function
addtable	function
assignfilterobject	function
bitmaps	dring
blank	function
builddisplayform	function
centeroverdisplay	boolean
clearsiblinglinks	function
container	type(wxcontainer)
controls	dring
createdisplayform	boolean
currentpage	printform1page
currentworkingdirectory	string
datasources	dring
defbooleanformat	string
defdateformat	string
defdatelocale	SBLlocaledateinfo
defdatetimeformat	string
deffont	wxfont
defintegerformat	string
defnumberformat	string
defnumericlocale	SBLNumSettings
defpagebackcolor	integer
defpageheight	integer
defpagewidth	integer
deftimeformat	string
designmode	boolean
dirty	boolean
filename	string
filter	dataform1filter
findbitmapsource	function
findcontrol	function
finddatasource	function
findgraphic	function
findsiblinglink	function
findtable	function
fonts	array
getfieldandtable	function
getfont	function
graphics	dring
lastusedrecord	dataform1record
loading	boolean
lock	function
locked	boolean
masterrecord	dataform1record
mastertable	dataform1table
name	string
nameinuse	function
onsave	event
onselect	event
pages	dring
print	function
printpreviewtitle	string
refresh	function
removedisplayform	function
saverecord	function
selectcurrent	function
selectfirst	function
selectkey	function
selectlast	function
selectnext	function
selectprevious	function
setcontainer	function
setdirtystate	function
setfilter	function
setlastusedrecord	function
setmasterrecord	function
setmastertable	function
showpage	function
siblinglinks	dring
startat100percent	boolean
tables	dring
type	type
unlock	function
valid	boolean

Methods

!()

Description

Prototype

printform1var.! ( printform1 me, string controlname )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
controlname	None	string

addbitmap()

Description

Prototype

printform1var.addbitmap ( printform1 me, string filename, string format, blob rgb, integer width, integer height, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
filename	None	string
format	`xpm`	string
rgb	None	blob
width	None	integer
height	None	integer
error	None	integer

addcontrol()

Description

Prototype

printform1var.addcontrol ( printform1 me, type controltype, integer printleft, integer printtop, integer printwidth, integer printheight, string text, boolean visible, wxbitmap bitmap, string scaling, integer backgroundrgb, integer textrgb, string printalignment, wxfont font, string printname, boolean backgroundvisible, boolean undergraphics, boolean underbitmaps, type(printform1control) next, printform1page page, type(db1field) field, dataform1table table, string displayformat, boolean skipbitmapcheck, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
controltype	None	type
printleft	None	integer
printtop	None	integer
printwidth	None	integer
printheight	None	integer
text	None	string
visible	`.true`	boolean
bitmap	None	wxbitmap
scaling	None	string
backgroundrgb	None	integer
textrgb	`0`	integer
printalignment	None	string
font	None	wxfont
printname	None	string
backgroundvisible	`.true`	boolean
undergraphics	`.false`	boolean
underbitmaps	`.false`	boolean
next	None	type(printform1control)
page	None	printform1page
field	None	type(db1field)
table	None	dataform1table
displayformat	None	string
skipbitmapcheck	`.false`	boolean
error	None	integer

adddatasource()

Description

Prototype

printform1var.adddatasource ( printform1 me, type(*) datasource, string source, string username, string password, integer codepage, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
datasource	None	type(*)
source	None	string
username	None	string
password	None	string
codepage	None	integer
error	None	integer

addgraphic()

Description

Prototype

printform1var.addgraphic ( printform1 me, type graphictype, point printpoint1, point printpoint2, point printpoint3, point printmidpoint, integer rgb, integer borderrgb, integer width, integer borderwidth, boolean visible, boolean bordervisible, string printname, type(printform1graphic) next, printform1page page, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
graphictype	None	type
printpoint1	None	point
printpoint2	None	point
printpoint3	None	point
printmidpoint	None	point
rgb	None	integer
borderrgb	None	integer
width	None	integer
borderwidth	None	integer
visible	None	boolean
bordervisible	None	boolean
printname	None	string
next	None	type(printform1graphic)
page	None	printform1page
error	None	integer

addpage()

Description

Prototype

printform1var.addpage ( printform1 me, integer width, integer height, integer backgroundrgb, printform1page after, string name, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
width	None	integer
height	None	integer
backgroundrgb	None	integer
after	None	printform1page
name	None	string
error	None	integer

addsiblinglink()

Description

Prototype

printform1var.addsiblinglink ( printform1 me, type(db1field) srcfield, dataform1table srctable, type(db1field) destfield, dataform1table desttable, type(dataform1linkcontainer) container, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
srcfield	None	type(db1field)
srctable	None	dataform1table
destfield	None	type(db1field)
desttable	None	dataform1table
container	None	type(dataform1linkcontainer)
error	None	integer

addtable()

Description

Prototype

printform1var.addtable ( printform1 me, type(db1table) table, dataform1datasource source, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
table	None	type(db1table)
source	None	dataform1datasource
error	None	integer

assignfilterobject()

Description

Prototype

printform1var.assignfilterobject ( printform1 me, dataform1filter dffilter )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
dffilter	None	dataform1filter

blank()

Description

Prototype

printform1var.blank ( printform1 me, boolean datacontrolsonly )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
datacontrolsonly	`.true`	boolean

builddisplayform()

Description

Prototype

printform1var.builddisplayform ( printform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
error	None	integer

clearsiblinglinks()

Description

Prototype

printform1var.clearsiblinglinks ( printform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1

findbitmapsource()

Description

Prototype

printform1var.findbitmapsource ( printform1 me, string sourcename )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
sourcename	None	string

findcontrol()

Description

Prototype

printform1var.findcontrol ( printform1 me, string controlname )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
controlname	None	string

finddatasource()

Description

Prototype

printform1var.finddatasource ( printform1 me, string sourcename )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
sourcename	None	string

findgraphic()

Description

Prototype

printform1var.findgraphic ( printform1 me, string graphicname )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
graphicname	None	string

findsiblinglink()

Description

Prototype

printform1var.findsiblinglink ( printform1 me, dataform1table desttable )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
desttable	None	dataform1table

findtable()

Description

Prototype

printform1var.findtable ( printform1 me, string tablename )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
tablename	None	string

getfieldandtable()

Description

Prototype

printform1var.getfieldandtable ( printform1 me, string fieldname, string tablename )

Parameters

Parameter	Default value	Type name
me	None	printform1
fieldname	None	string
tablename	None	string

getfont()

Description

Prototype

printform1var.getfont ( printform1 me, string facename, integer size, string style, string weight, string decoration )

Parameters

Parameter	Default value	Type name
me	None	printform1
facename	None	string
size	None	integer
style	None	string
weight	None	string
decoration	None	string

lock()

Description

Prototype

printform1var.lock ( printform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
error	None	integer

nameinuse()

Description

Prototype

printform1var.nameinuse ( printform1 me, string controlname )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
controlname	None	string

print()

Description

Prototype

printform1var.print ( printform1 me, boolean showprintpreview, string dialogdata, wxprintout printout, integer formno, boolean closeprintout, boolean skipcontent, pagesetupinfo psinfo, boolean showprinterdialog, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
showprintpreview	`.true`	boolean
dialogdata	None	string
printout	None	wxprintout
formno	`1`	integer
closeprintout	`.true`	boolean
skipcontent	`.false`	boolean
psinfo	None	pagesetupinfo
showprinterdialog	`.false`	boolean
error	None	integer

refresh()

Description

Prototype

printform1var.refresh ( printform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1

removedisplayform()

Description

Prototype

printform1var.removedisplayform ( printform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1

saverecord()

Description

Prototype

printform1var.saverecord ( printform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
lock	`.false`	boolean
error	None	integer

selectcurrent()

Description

Prototype

printform1var.selectcurrent ( printform1 me, type(db1index) index, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
index	None	type(db1index)
lock	`.false`	boolean
error	None	integer

selectfirst()

Description

Prototype

printform1var.selectfirst ( printform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
lock	`.false`	boolean
error	None	integer

selectkey()

Description

Prototype

printform1var.selectkey ( printform1 me, anyvalue value, type(db1index) index, boolean lock, boolean found, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
value	None	anyvalue
index	None	type(db1index)
lock	`.false`	boolean
found	None	boolean
error	None	integer

selectlast()

Description

Prototype

printform1var.selectlast ( printform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
lock	`.false`	boolean
error	None	integer

selectnext()

Description

Prototype

printform1var.selectnext ( printform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
lock	`.false`	boolean
error	None	integer

selectprevious()

Description

Prototype

printform1var.selectprevious ( printform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
lock	`.false`	boolean
error	None	integer

setcontainer()

Description

Prototype

printform1var.setcontainer ( printform1 me, type(wxcontainer) container )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
container	None	type(wxcontainer)

setdirtystate()

Description

Prototype

printform1var.setdirtystate ( printform1 me, boolean dirty )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
dirty	`.true`	boolean

setfilter()

Description

Prototype

printform1var.setfilter ( printform1 me, string filter, string errtext, integer errindex )

Parameters

Parameter	Default value	Type name
me	None	printform1
filter	None	string
errtext	None	string
errindex	None	integer

setlastusedrecord()

Description

Prototype

printform1var.setlastusedrecord ( printform1 me, dataform1record record )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
record	None	dataform1record

setmasterrecord()

Description

Prototype

printform1var.setmasterrecord ( printform1 me, type(db1record) r, boolean dorefresh, integer error )

Parameters

Parameter	Default value	Type name
me	None	printform1
r	None	type(db1record)
dorefresh	`.true`	boolean
error	None	integer

setmastertable()

Description

Prototype

printform1var.setmastertable ( printform1 me, dataform1table table )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
table	None	dataform1table

showpage()

Description

Prototype

printform1var.showpage ( printform1 me, integer pagenum )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1
pagenum	None	integer

unlock()

Description

Prototype

printform1var.unlock ( printform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	printform1