Finish Button Control

Documentation home

Description. 1

Properties 1

Style Tab – Styling Assistant 1

Html Element Properties Tab. 3

Button tab. 3

Texts tab. 3

Right Click Menu Actions 4

Appearance in Outline View. 4

See also: Ebase Page Sequencing, Styling Assistants, Introduction to Styling, Controls, Page Navigation Panel Control

Description

This is one of the supplied Ebase page navigation buttons. When placed on a page, the button will be displayed when no next page has been configured; when a next page has been configured, the Next Page Button Control is displayed instead. Click here for further details on Ebase page sequencing and behaviour when the user clicks this button.

In the WYSIWYG View, the toggle hidden controls icon on the toolbar behaves as follows:

• On: the button is displayed when no next page has been configured (runtime behaviour)
• Off: the button is always displayed

The control can be displayed as a button or as a clickable image. When displayed as an image, each image is displayed with a language dependent alternate text taken from system text 30.

Note: A finish button is also included in the Page Navigation Panel Control.

Properties

See also control common properties and local/inherited control properties.

Style Tab – Styling Assistant

Property	Description	Name^1	Type^1	Get^1	Set^1	Get/Set Values^1
Text	Sets the text properties for the button: font, size, color, bold, italic etc. See text properties.
Background	Sets the background properties for the button. See background properties.
Border	Sets the border properties for the button. See border properties.
Padding & Margin	Padding is the space inside the border. Margin is the space beyond the border. See padding and margin properties.
Advanced Properties:
Style	CSS class and inline style for the button.	cssClass style	Character	Yes	Yes	As per HTML class parameter As per HTML style parameter
Display As Image	Indicates that the button is displayed as an image. The image URL is then configured using the Image URL property.	displayAsImage	Boolean	Yes	Yes
Image Url	Specifies the URL for the image when Display as image is selected.	imageURL	Character	Yes	Yes	See URL properties for more information.

Html Element Properties Tab

This allows you to add element properties to the root element of the Control – see Html Element Properties for more information.

Button tab

Property	Description	Name^1	Type^1	Get^1	Set^1	Get/Set Values^1
Display as image	Indicates that the button is displayed as an image. The image URL is then configured using the Image URL property.	displayAsImage	Boolean	Yes	Yes
Image URL	Specifies the URL for the image when Display as image is selected.	imageURL	Character	Yes	Yes	See URL properties for more information.

Texts tab

Property	Description	Name^1	Type^1	Get^1	Set^1	Get/Set Values^1
Finish	The finish button text. There is only one finish button text for each form and this is shared by all Finish Button Controls in the form.			No	No

¹ See accessing control properties from scripts

Examples of setting properties via API based language:

controls.FINISHBUTTON1.textColor = "black";

controls.FINISHBUTTON1.backgroundColor = "yellow";

Examples of setting properties via FPL:

set FINISHBUTTON1.textColor = 'black';

set FINISHBUTTON1.backgroundColor = 'yellow';

Right Click Menu Actions

Click here for right-click menu actions available to all controls.

There are no specific right click actions for this control.

Appearance in Outline View

A Finish Button Control is shown with the control name in brackets: