Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Hidden
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE


HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#BODY
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#FOOTER
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#HEADER
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#LEADING_GRAND_SUMMARY
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#LEADING_SUBSUMMARY
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TITLE_FOOTER
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TITLE_HEADER
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TRAILING_GRAND_SUMMARY
Constant use for specifying the type of form parts.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TRAILING_SUBSUMMARY
Constant use for specifying the type of form parts.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#allowBreakAcrossPageBounds
When set, the remainder of a selected part that does not fit on the page currently
being printed, will not be transported to the next page - it will break where the page
ends and continue on the next page.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#background
The background color of the form part.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#discardRemainderAfterBreak
When set, the remainder of a selected part that is broken due to the page
ending will not be printed on the next page - it will be discarded.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#groupbyDataProviderIDs
For Leading Subsummary or Trailing Subsummary parts, one or more
dataproviders can be added as Break (GroupBy) dataproviders.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#height
The height of a selected part; specified in pixels.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#pageBreakAfterOccurrence
A page break will be inserted after a specified number of occurences of a selected part.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#pageBreakBefore
When set, a page break will be inserted before each occurrence of a selected part.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#restartPageNumber
When set, page numbering will be restarted after each occurrence of a selected part.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#sinkWhenLast
When set, the last part on a page (such as a Trailing Grand Summary part) will
"sink" to the lowest part of the page when there is free space.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getPartType()
The type of this part.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getPartYOffset()
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
#getUUID()
Returns the UUID of this component.

HTML Table
idconstant
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Constants Details
Table Body (tbody)
idBODY
classnode
Table Row (tr)
idname
Table Cell (td)
BODY
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

This is the default part that is repeated for each record (being
displayed and/or printed).

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idFOOTER
classnode
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

A footer is displayed at the bottom of each page when printed ad can
contain summaries of the current selection of records. In List view, the
footer is displayed at the bottom of the list of records.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var footer = form.newPart(JSPart.FOOTER, 440);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idHEADER
classnode
Table Row (tr)
idname
Table Cell (td)
HEADER
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

A header is displayed at the top of each page when printed and can contain
summaries of the current selection of records. In List view the header is
displayed above the list of records.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var header = form.newPart(JSPart.HEADER, 80);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLEADING_GRAND_SUMMARY
classnode
Table Row (tr)
idname
Table Cell (td)
LEADING_GRAND_SUMMARY
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

A Leading Grand Summary can be placed before the body part. It can contain
summary fields that will generate summaries for the entire foundset.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var leadingGrandSummary = form.newPart(JSPart.LEADING_GRAND_SUMMARY, 120);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLEADING_SUBSUMMARY
classnode
Table Row (tr)
idname
Table Cell (td)
LEADING_SUBSUMMARY
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

A Leading Subsummary can be placed before the body part. There can be multiple Leading Subsummaries
per form. Each Subsummary part has a set of Group By fields which are used to group data together.
Each Subsummary part can contain summary fields, which will be printed once for each group of data.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTITLE_FOOTER
classnode
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

Appears once on the first page of a printed report. If a Footer is available, it is
replaced by the Title Footer on the first page.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var titleFooter = form.newPart(JSPart.TITLE_FOOTER, 500);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTITLE_HEADER
classnode
Table Row (tr)
idname
Table Cell (td)
TITLE_HEADER
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

Appears only once on the first page of a printed report or on top of the first screen
of a foundset. If a Header is available it is replace by the Title Header on the first
page.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var titleHeader = form.newPart(JSPart.TITLE_HEADER, 40);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTRAILING_GRAND_SUMMARY
classnode
Table Row (tr)
idname
Table Cell (td)
TRAILING_GRAND_SUMMARY
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

A Trailing Grand Summary can be placed after the body part. It can contain
summary fields that will generate summaries for the entire foundset.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTRAILING_SUBSUMMARY
classnode
Table Row (tr)
idname
Table Cell (td)
TRAILING_SUBSUMMARY
Table Row (tr)
iddes
Table Cell (td)

Constant use for specifying the type of form parts.

A Trailing Subsummary can be placed before the body part. There can be multiple Trailing Subsummaries
per form. Each Subsummary part has a set of Group By fields which are used to group data together.
Each Subsummary part can contain summary fields, which will be printed once for each group of data.

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idallowBreakAcrossPageBounds
classnode
Table Row (tr)
idname
Table Cell (td)
allowBreakAcrossPageBounds
Table Row (tr)
iddes
Table Cell (td)

When set, the remainder of a selected part that does not fit on the page currently
being printed, will not be transported to the next page - it will break where the page
ends and continue on the next page.

NOTE: Make sure to set this option when you are printing more than one page per record.

Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idbackground
classnode
Table Row (tr)
idname
Table Cell (td)
background
Table Row (tr)
iddes
Table Cell (td)

The background color of the form part.

NOTE: When no background color has been set, the default background
color will be determined by the Look and Feel (LAF) that has been selected
in Application Preferences.

Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.background = 'green';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddiscardRemainderAfterBreak
classnode
Table Row (tr)
idname
Table Cell (td)
discardRemainderAfterBreak
Table Row (tr)
iddes
Table Cell (td)
When set, the remainder of a selected part that is broken due to the page
ending will not be printed on the next page - it will be discarded.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgroupbyDataProviderIDs
classnode
Table Row (tr)
idname
Table Cell (td)
groupbyDataProviderIDs
Table Row (tr)
iddes
Table Cell (td)
For Leading Subsummary or Trailing Subsummary parts, one or more
dataproviders can be added as Break (GroupBy) dataproviders. The
Leading/Trailing Subsummary parts will be displayed once for each
resulted group of data.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idheight
classnode
Table Row (tr)
idname
Table Cell (td)
height
Table Row (tr)
iddes
Table Cell (td)

The height of a selected part; specified in pixels.

This height property is the lowerbound as its ending Y value (0 == top of the form).

Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var part = form.newPart(JSPart.HEADER, 100);
part.height = 200;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idpageBreakAfterOccurrence
classnode
Table Row (tr)
idname
Table Cell (td)
pageBreakAfterOccurrence
Table Row (tr)
iddes
Table Cell (td)
A page break will be inserted after a specified number of occurences of a selected part.
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.pageBreakAfterOccurrence = 2;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idpageBreakBefore
classnode
Table Row (tr)
idname
Table Cell (td)
pageBreakBefore
Table Row (tr)
iddes
Table Cell (td)
When set, a page break will be inserted before each occurrence of a selected part.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
leadingSubsummary.pageBreakBefore = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrestartPageNumber
classnode
Table Row (tr)
idname
Table Cell (td)
restartPageNumber
Table Row (tr)
iddes
Table Cell (td)
When set, page numbering will be restarted after each occurrence of a selected part.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
trailingSubsummary.groupbyDataProviderIDs = 'my_table_text';
trailingSubsummary.restartPageNumber = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsinkWhenLast
classnode
Table Row (tr)
idname
Table Cell (td)
sinkWhenLast
Table Row (tr)
iddes
Table Cell (td)
When set, the last part on a page (such as a Trailing Grand Summary part) will
"sink" to the lowest part of the page when there is free space.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
trailingGrandSummary.sinkWhenLast = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetPartType
classnode
Table Row (tr)
idname
Table Cell (td)
getPartType
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getPartType
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
The type of this part.
Table Row (tr)
idret
Table Cell (td)
Returns
Number – A number representing the type of the form part.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var allParts = form.getParts()
for (var i=0; i<allParts.length; i++) {
	if (allParts[i].getPartType() == JSPart.BODY)
		application.output('body Y offset: ' + allParts[i].getPartYOffset());
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetPartYOffset
classnode
Table Row (tr)
idname
Table Cell (td)
getPartYOffset
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getPartYOffset
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.
Table Row (tr)
idret
Table Cell (td)
Returns
Number – A number holding the Y offset of the form part.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var allParts = form.getParts()
for (var i=0; i<allParts.length; i++) {
	if (allParts[i].getPartType() == JSPart.BODY)
		application.output('body Y offset: ' + allParts[i].getPartYOffset());
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetUUID
classnode
Table Row (tr)
idname
Table Cell (td)
getUUID
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
UUID
Span
stylefloat: left; font-weight: bold;
idiets
getUUID
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns the UUID of this component.
Table Row (tr)
idret
Table Cell (td)
Returns
UUID
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString());
Table Row (tr)
classlastDetailRow
Table Cell (td)