GuidedTourInfo (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Guided Tour functions

Resetting the Guided Tour counter to 0 (information provided by the gtInfoCount constant)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GuidedTourInfo (Function)

In french: VisiteGuidéeInfo

Not available

Returns information about a Guided Tour.

Example

// Opens the Guided Tour only at first launch
IF GuidedTourInfo(GuidedTourGetStarted, gtInfoCount) = 0 THEN
	GuidedTourStart(GuidedTourGetStarted)
END

// Opens the Guided Tour no more than once per day, and a maximum of 5 times overall
IF GuidedTourInfo(GuidedTourGetStarted, gtInfoDate) < DateSys() 
		_AND_ GuidedTourInfo(GuidedTourGetStarted, gtInfoCount) < 5 THEN
	GuidedTourStart(GuidedTourGetStarted)
END

// Shows what's new in a version 
WhatsNewTour is GuidedTour
WhatsNewTour.Identifier = "What's new in this version"
WhatsNewTour.Version = 29
IF GuidedTourInfo(WhatsNewTour, gtInfoVersion) < 29 THEN
	WhatsNewTour.Step[1].Target = EDT_FirstName
	WhatsNewTour.Step[1].Title = "New!"
	WhatsNewTour.Step[1].Description = "Now, you can enter your first name"
	GuidedTourStart(WhatsNewTour)
END

Syntax

<Result> = GuidedTourInfo(<Guided Tour> , <Information>)

<Result>: Type of information

Requested information.

<Guided Tour>: String or variable of type GuidedTour

Guided Tour used. This parameter can correspond to:
the identifier of the Guided Tour.
the name of the GuidedTour variable.

<Information>: Integer constant

Desired information:
gtInfoDate Date the Guided Tour was last viewed on the current computer.
gtInfoCount Number of times the user has seen the Guided Tour.
gtInfoVersion Version number of the last Guided Tour viewed by the user.

Remarks

Resetting the Guided Tour counter to 0 (information provided by the gtInfoCount constant)

In WINDEV applications, the Guided Tour counter can be reset to zero using the following code:

SaveParameter("GuidedTour\<tour_ID>\count",0)

where <tour_ID> corresponds to the identifier of the Guided Tour. For example:

Tour is GuidedTour
Tour.Identifier = "Tour_20240503_1119"
SaveParameter("GuidedTour\Tour_20240503_1119\count",0)

Business / UI classification: UI Code

Component: wd300mdl.dll