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. |
Method Summary | |
---|---|
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 |
Returns Number |
Samplevar 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 |
Returns Number |
Samplevar 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 |
Returns Number |
Samplevar 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 |
Returns Number |
Samplevar 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 |
Returns Number |
Samplevar leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160); |
TITLE_FOOTER |
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 |
Returns Number |
Samplevar 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 |
Returns Number |
Samplevar 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 |
Returns Number |
Samplevar 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 before the body part. There can be multiple Trailing Subsummaries |
Returns Number |
Samplevar 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 NOTE: Make sure to set this option when you are printing more than one page per record. |
Returns Boolean |
Samplevar 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 |
Returns String |
Samplevar 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. |
Returns Boolean |
Samplevar 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. |
Returns String |
Samplevar 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). |
Returns Number |
Samplevar 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. |
Returns Number |
Samplevar 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. |
Returns Boolean |
Samplevar 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. |
Returns Boolean |
Samplevar 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. |
Returns Boolean |
Samplevar trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400); trailingGrandSummary.sinkWhenLast = true; |
Method Details |
---|
getPartType |
Number getPartType () |
The type of this part. |
Returns Number – A number representing the type of the form part. |
Samplevar 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 |
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. |
Returns Number – A number holding the Y offset of the form part. |
Samplevar 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 |
UUID getUUID () |
Returns the UUID of this component. |
Returns UUID |
Samplevar button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID(); application.output(button_uuid.toString()); |