PageBreakControl

A Page Break control represents a page break and is applicable only when a page is included in a PDF. Page Break Controls are ignored when the page is displayed in a web browser. When a Page Break Control is hidden, the page break is suppressed.

Further documentation

Control Functions

addCssClass	PageBreakControl.addCssClass( cssClass )	Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll	PageBreakControl.getAll( )	Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.
isContainer	PageBreakControl.isContainer( )	Returns true if this control is a container control i.e.
getCssClass	PageBreakControl.getCssClass( )	Returns the list of CSS classes configured for the control.
setCssClass	PageBreakControl.setCssClass( cssClass )	Sets one or more CSS classes to be applied to the control.
isDisplayOnly	PageBreakControl.isDisplayOnly( )	Returns `true` if the control is marked as display only, otherwise returns `false`.
setDisplayOnly	PageBreakControl.setDisplayOnly( displayOnly )	Marks the control and all its children as display only (when `displayOnly` is `true`) or enterable (when `displayOnly` is `false`).
isDisplayOnlyIncludingParents	PageBreakControl.isDisplayOnlyIncludingParents( )	Returns `true` if the control or any of its parents is marked as display only, otherwise returns `false`.
getErrorMsgClass	PageBreakControl.getErrorMsgClass( )	Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass	PageBreakControl.setErrorMsgClass( errorMsgClass )	Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle	PageBreakControl.getErrorMsgStyle( )	Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle	PageBreakControl.setErrorMsgStyle( errorMsgStyle )	Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField	PageBreakControl.isEventField( )	Returns `true` if the control is an event field i.e.
hasModifier	PageBreakControl.hasModifier( modifier )	Returns true if the control has the specified modifier, otherwise returns false.
isHidden	PageBreakControl.isHidden( )	Returns `true` if the control is marked as hidden, otherwise returns `false`.
setHidden	PageBreakControl.setHidden( hidden )	Hides or shows the control and all its children.
hide	PageBreakControl.hide( )	Hides the control, this is equivalent to setting property `hidden` to `true`.
getInfoMsgClass	PageBreakControl.getInfoMsgClass( )	Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass	PageBreakControl.setInfoMsgClass( infoMsgClass )	Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle	PageBreakControl.getInfoMsgStyle( )	Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle	PageBreakControl.setInfoMsgStyle( infoMsgStyle )	Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg	PageBreakControl.isInheritMsg( )	Returns `true` if Use parent control setting is checked in the Message Options properties for the control, otherwise returns `false`.
getLayoutCell	PageBreakControl.getLayoutCell( )	Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg	PageBreakControl.isLocalMsg( )	Returns `true` if Local Message is checked in the Message Options properties for the control, otherwise returns `false`.
isNewLine	PageBreakControl.isNewLine( )	Returns the new line property.
setNewLine	PageBreakControl.setNewLine( newLine )	Sets or unsets the control's new line property.
getNextSiblingControl	PageBreakControl.getNextSiblingControl( )	Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage	PageBreakControl.getPage( )	Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl	PageBreakControl.getParentControl( )	Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl	PageBreakControl.getPreviousSiblingControl( )	Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh	PageBreakControl.refresh( )	Refreshes this control in the user's browser when the page is next displayed.
removeCssClass	PageBreakControl.removeCssClass( cssClass )	Removes one or more CSS classes from the control.
requestFocus	PageBreakControl.requestFocus( )	Sets the browser focus to the control.
getRootHtmlElementProperties	PageBreakControl.getRootHtmlElementProperties( )	Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show	PageBreakControl.show( )	Shows the control, this is equivalent to setting property `hidden` to `false`.
isShowing	PageBreakControl.isShowing( )	Returns `true` if the control will be included in the web page when it's next displayed to the user, otherwise returns `false`.
getStyle	PageBreakControl.getStyle( )	Returns the inline CSS style configured for the control.
setStyle	PageBreakControl.setStyle( style )	Sets inline CSS style to be applied to the control.
getWarningMsgClass	PageBreakControl.getWarningMsgClass( )	Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass	PageBreakControl.setWarningMsgClass( warningMsgClass )	Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle	PageBreakControl.getWarningMsgStyle( )	Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle	PageBreakControl.setWarningMsgStyle( warningMsgStyle )	Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MessageContainer Functions

addErrorMessage	PageBreakControl.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	PageBreakControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	PageBreakControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	PageBreakControl.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	PageBreakControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	PageBreakControl.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	PageBreakControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	PageBreakControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	PageBreakControl.existErrorMessages( )	Returns `true` if undisplayed error messages exist for this element, otherwise returns `false`.
existInfoMessages	PageBreakControl.existInfoMessages( )	Returns `true` if undisplayed info messages exist for this element, otherwise returns `false`.
existMessages	PageBreakControl.existMessages( )	Returns `true` if undisplayed info, warning or error messages exist for this element, otherwise returns `false`.
existWarningMessages	PageBreakControl.existWarningMessages( )	Returns `true` if undisplayed warning messages exist for this element, otherwise returns `false`.

Element Functions

getElementName	PageBreakControl.getElementName( )	Returns the element name
getElementType	PageBreakControl.getElementType( )	Returns the element type