Child pages
  • JSHeader

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListMobileClientSmartClientsWordListWebClient

servoy sSummary12%30%58%height: 30px;3Property SummaryWhen 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.The background color of the form part.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.For Leading Subsummary or Trailing Subsummary parts, one or more dataproviders can be added as Break (GroupBy) dataproviders.The height of a selected part; specified in pixels.A page break will be inserted after a specified number of occurences of a selected part.When set, a page break will be inserted before each occurrence of a selected part.When set, page numbering will be restarted after each occurrence of a selected part.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.Flag to set a set the header sticky so it will not scroll out of view.The Cascading Style Sheet (CSS) class name applied to the part.

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns the header text label on the form header if present.Returns the left-button on the form header if present.The type of this part.The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.Returns the right-button on the form header if present.Returns the UUID of this component.Creates a new header text label on the form header.Creates a new left-button on the form header.Creates a new right-button on the form header.Remove the header text label on the form header if present.Remove the left-button on the form header if present.Remove the right-button on the form header if present.

propertyservoy sDetail2100%height:30px2Property DetailsallowBreakAcrossPageBoundsname

allowBreakAcrossPageBounds

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRowbackgroundname

background

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
discardRemainderAfterBreakname

discardRemainderAfterBreak

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
groupbyDataProviderIDsname

groupbyDataProviderIDs

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
heightname

height

dessIndent
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).
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
pageBreakAfterOccurrencename

pageBreakAfterOccurrence

dessIndent
A page break will be inserted after a specified number of occurences of a selected part.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
pageBreakBeforename

pageBreakBefore

dessIndent
When set, a page break will be inserted before each occurrence of a selected part.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
restartPageNumbername

restartPageNumber

dessIndent
When set, page numbering will be restarted after each occurrence of a selected part.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
sinkWhenLastname

sinkWhenLast

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stickyname

sticky

dessIndent
Flag to set a set the header sticky so it will not scroll out of view.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
styleClassname

styleClass

dessIndent
The Cascading Style Sheet (CSS) class name applied to the part.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetHeaderTextname

getHeaderText()

dessIndent
Returns the header text label on the form header if present.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetLeftButtonname

getLeftButton()

dessIndent
Returns the left-button on the form header if present.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getPartTypename

getPartType()

dessIndent
The type of this part.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
,MobileClientsam

Sample

sIdentjavascript
lastDetailRow
getPartYOffsetname

getPartYOffset()

dessIndent
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRightButtonname

getRightButton()

dessIndent
Returns the right-button on the form header if present.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getUUIDname

getUUID()

dessIndent
Returns the UUID of this component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newHeaderTextname

newHeaderText(text)

dessIndent
Creates a new header text label on the form header.
prs

Parameters

sIndenttextthe text on the header
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newLeftButtonname

newLeftButton(text, jsmethod)

dessIndent
Creates a new left-button on the form header.
prs

Parameters

sIndenttextthe text on the buttonjsmethodthe method assigned to handle an onAction event
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newRightButtonname

newRightButton(text, jsmethod)

dessIndent
Creates a new right-button on the form header.
prs

Parameters

sIndenttextthe text on the buttonjsmethodthe method assigned to handle an onAction event
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeHeaderTextname

removeHeaderText()

dessIndent
Remove the header text label on the form header if present.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeLeftButtonname

removeLeftButton()

dessIndent
Remove the left-button on the form header if present.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeRightButtonname

removeRightButton()

dessIndent
Remove the right-button on the form header if present.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow