Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample
Dec 03, 2023 22:10
Supported Clients
SmartClient
WebClient
NGClient
Constants Summary
Number
BODY
Constant use for specifying the type of form parts.
Number
FOOTER
Constant use for specifying the type of form parts.
Number
HEADER
Constant use for specifying the type of form parts.
Number
LEADING_GRAND_SUMMARY
Constant use for specifying the type of form parts.
Number
LEADING_SUBSUMMARY
Constant use for specifying the type of form parts.
Number
TITLE_FOOTER
Constant use for specifying the type of form parts.
Number
TITLE_HEADER
Constant use for specifying the type of form parts.
Number
TRAILING_GRAND_SUMMARY
Constant use for specifying the type of form parts.
Number
TRAILING_SUBSUMMARY
Constant use for specifying the type of form parts.
Property Summary
Boolean
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.
String
background
The background color of the form part.
Boolean
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.
String
groupbyDataProviderIDs
For Leading Subsummary or Trailing Subsummary parts, one or more
dataproviders can be added as Break (GroupBy) dataproviders.
Number
height
The height of a selected part; specified in pixels.
Number
pageBreakAfterOccurrence
A page break will be inserted after a specified number of occurences of a selected part.
Boolean
pageBreakBefore
When set, a page break will be inserted before each occurrence of a selected part.
Boolean
restartPageNumber
When set, page numbering will be restarted after each occurrence of a selected part.
Boolean
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.
String
styleClass
The Cascading Style Sheet (CSS) class name applied to the part.
Methods Summary
String
getComment()
Returns the comment of this component.
Number
getPartType()
The type of this part.
Number
getPartYOffset()
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.
UUID
getUUID()
Returns the UUID of this component.
Constants Details
BODY
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).
var body = form.newPart(JSPart.BODY, 320);
FOOTER
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.
var footer = form.newPart(JSPart.FOOTER, 440);
HEADER
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. In tableview the default column headers will
not be there if this is specified.
var header = form.newPart(JSPart.HEADER, 80);
LEADING_GRAND_SUMMARY
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.
In tableview the default column headers will not be there if this is specified.
var leadingGrandSummary = form.newPart(JSPart.LEADING_GRAND_SUMMARY, 120);
LEADING_SUBSUMMARY
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.
This part is only shown in printing
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
TITLE_FOOTER
Constant use for specifying the type of form parts.
Appears only 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.
var titleFooter = form.newPart(JSPart.TITLE_FOOTER, 500);
TITLE_HEADER
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.
This part is also shown in a normal none printing form, because it can be used to place components
in a tableview form and keep the default table header columns. Other parts as the HEADER will remove
the default header columns.
var titleHeader = form.newPart(JSPart.TITLE_HEADER, 40);
TRAILING_GRAND_SUMMARY
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.
var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
TRAILING_SUBSUMMARY
Constant use for specifying the type of form parts.
A Trailing Subsummary can be placed after 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.
This part is only shown in printing
var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
Property Details
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.
NOTE: Make sure to set this option when you are printing more than one page per record.
var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;
background
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.
var body = form.newPart(JSPart.BODY, 320);
body.background = 'green';
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.
var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;
groupbyDataProviderIDs
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.
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
height
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).
var part = form.newPart(JSPart.HEADER, 100);
part.height = 200;
pageBreakAfterOccurrence
A page break will be inserted after a specified number of occurences of a selected part.
var body = form.newPart(JSPart.BODY, 320);
body.pageBreakAfterOccurrence = 2;
pageBreakBefore
When set, a page break will be inserted before each occurrence of a selected part.
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
leadingSubsummary.pageBreakBefore = true;
restartPageNumber
When set, page numbering will be restarted after each occurrence of a selected part.
var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
trailingSubsummary.groupbyDataProviderIDs = 'my_table_text';
trailingSubsummary.restartPageNumber = true;
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.
var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
trailingGrandSummary.sinkWhenLast = true;
styleClass
The Cascading Style Sheet (CSS) class name applied to the part.
var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';
Methods Details
getComment()
Returns the comment of this component.
var comment = solutionModel.getForm("my_form").getButton("my_button").getComment();
application.output(comment);
getPartType()
The type of this part.
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());
}
getPartYOffset()
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.
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());
}
getUUID()
Returns the UUID of this component.
var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString());