Handling a Sliding Banner control through programming

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Sliding Banner control

Handling a Sliding Banner control through programming

Overview

Sliding and browsing planes

Handling the planes of a Sliding Banner control

Properties available for a Sliding Banner control

See also

Handling a Sliding Banner control through programming

Overview

A Sliding Banner control can be handled through programming. To do so, use the variable of Sliding Banner control in the code.

The variable of Sliding Banner control corresponds to the number of the active pane. This variable is an integer.

To handle a Sliding Banner control through programming, WEBDEV proposes the Sliding Banner control management functions.

This help page explains how to handle a Sliding Banner control through programming.

Sliding and browsing planes

Automatic sequence of slides in a Sliding Banner control

To use an automatic sequence in a Sliding Banner control, you can:

check "Start sliding automatically" in the "Details" tab of the control description window.
use the WLanguage BannerStartSliding function.

In this case, the different visible planes of Sliding Banner control will be automatically displayed in the control:

according to the order defined in the "General" tab of the Sliding Banner control.
with the display duration defined in the "General" tab of the Sliding Banner control.

To stop the automatic slide, use BannerStopSliding.

Changing slides using bullets, and the left and right buttons

If you are using the left and right buttons as well as the bullets proposed in the Sliding Banner control, no specific programming is required. Going from a plane to another one is automatically managed.

Remarks:

The order of planes is the one defined in the description window of the Sliding Banner control.
The invisible planes are ignored.

Customizing transitions between slides

If you are using specific controls to go from a plane to another one (specific buttons for example, positioned outside control), you have the ability to manage the move from a plane to another one:

by using the following WLanguage functions:


Versions 22 and later BannerLast New in version 22 BannerLast BannerLast	Displays the last plane of a Sliding Banner control.
Versions 22 and later BannerPrevious New in version 22 BannerPrevious BannerPrevious	Displays the previous plane of a Sliding Banner control.
Versions 22 and later BannerFirst New in version 22 BannerFirst BannerFirst	Displays the first plane of a Sliding Banner control.
Versions 22 and later BannerNext New in version 22 BannerNext BannerNext	Displays the next plane of a Sliding Banner control.

Remark: The invisible planes are ignored.

by using Value to display the desired plane.
For example:

// Displays plane 3 in the Sliding Banner control
BAN_Banner.Value = 3
by assigning the value of the desired plane to the Sliding Banner control.
For example:

NameSlidingBannerControl = PlaneNumber

Remark: The plane numbers and their order are defined in the description window of the Sliding Banner control.

Handling the planes of a Sliding Banner control

Making a plane invisible

You can use Visible to make a plane visible (and conversely). The visibility of planes is taken into account when browsing the different planes used by the Sliding Banner control (automatic or programmed iteration).

For example, the following code is used to make invisible the plane 5 found in the BAN_Ad control in August:

TodayDate is Date
IF TodayDate.Month = 8 THEN
BAN_Ad[5].Visible = False
END

Tip: You can prepare a plane (for a promotion for example) and to make it visible at a given date, for a given period.

Retrieving the current plane

To retrieve the number of the current plane:

perform a simple assignment. For example:

ActivePlaneNum = NameSlidingBannerControl
use the Value property.

Properties available for a Sliding Banner control

Several WLanguage properties can be used to handle:

the Sliding Banner control.
the planes associated with the Sliding Banner control.

To know the entire list of WLanguage properties that can be used with a Sliding Banner control, see Properties associated with the Sliding Banner control.