SIMPOL Documentation

Chapter 61. printformlib

This library provides a number of types and functions for creating printouts and for converting a form to a printout.

pagesetupinfo

Description

Type Tags

None

Object Value

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

pagesetupinfo.new()

Description

Prototype

pagesetupinfo.new ( pagesetupinfo me, integer papertype, integer units, boolean isportrait, wxfont font )

Parameters

ParameterDefault valueType nameDescription
meNonepagesetupinfo
papertype4integer
units1integer
isportrait.trueboolean
fontNonewxfont

Properties

PropertyTypeDescription
ConvertFromUnitsToMicrometersfunction
ConvertToUnitsFromMicrometersfunction
FindPaperTypefunction
SetFontfunction
SetMarginsfunction
SetOrientationfunction
SetPaperTypefunction
SetUnitsfunction
bottommargininteger
fontwxfont
leftmargininteger
pageheightinteger
pagewidthinteger
papertypeinteger
papertypesarray
portraitboolean
rightmargininteger
topmargininteger
typetype
units_idinteger

Methods

ConvertFromUnitsToMicrometers()

Description

Prototype

pagesetupinfovar.ConvertFromUnitsToMicrometers ( pagesetupinfo me, number value, integer unitsid )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
valueNonenumber
unitsidNoneinteger

ConvertToUnitsFromMicrometers()

Description

Prototype

pagesetupinfovar.ConvertToUnitsFromMicrometers ( pagesetupinfo me, integer value, integer unitsid )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
valueNoneinteger
unitsidNoneinteger

FindPaperType()

Description

Prototype

pagesetupinfovar.FindPaperType ( pagesetupinfo me, integer width, integer height, string papername, boolean uselandscape )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
widthNoneinteger
heightNoneinteger
papernameNonestring
uselandscapeNoneboolean

SetFont()

Description

Prototype

pagesetupinfovar.SetFont ( pagesetupinfo me, wxfont font, integer error )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
fontNonewxfont
errorNoneinteger

SetMargins()

Description

Prototype

pagesetupinfovar.SetMargins ( pagesetupinfo me, number left, number top, number right, number bottom )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
leftNonenumber
topNonenumber
rightNonenumber
bottomNonenumber

SetOrientation()

Description

Prototype

pagesetupinfovar.SetOrientation ( pagesetupinfo me, boolean portrait, integer error )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
portrait.trueboolean
errorNoneinteger

SetPaperType()

Description

Prototype

pagesetupinfovar.SetPaperType ( pagesetupinfo me, integer papertype, integer pagewidth, integer pageheight, integer error )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
papertypeNoneinteger
pagewidthNoneinteger
pageheightNoneinteger
errorNoneinteger

SetUnits()

Description

Prototype

pagesetupinfovar.SetUnits ( pagesetupinfo me, integer units_id, integer error )

Parameters
ParameterDefault valueType nameDescription
meNonepagesetupinfo
units_idNoneinteger
errorNoneinteger