ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

New WINDEV, WEBDEV and WINDEV Mobile 2024 feature!
Help / WLanguage / WLanguage functions / Standard functions / Guided Tour functions
  • Properties specific to GuidedTour variables
  • Functions that use GuidedTour variables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
GuidedTour (Variable type)
In french: VisiteGuidée
AjaxNot available
The GuidedTour type is used to define the advanced characteristics of a Guided Tour and its steps. You can define and change the characteristics of this Guided Tour using different WLanguage properties.
The characteristics of each step can be configured using variables of type GuidedTourStep. If no specific characteristics have been defined for a given step, the characteristics defined in the GuidedTour variable will be used.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Example
gt is GuidedTour
gt.Step[1].Title = "Step 1"
gt.Step[2].Title = "Step 2"
gt.Step[3].Title = "Step 3"
gt.Effect.Color = LightGreen   
gt.Step[2].Effect.Color = LightOrange
// Steps 1 and 3 will have a green background, step 2 will have an orange background
Properties

Properties specific to GuidedTour variables

The following properties can be used to handle GuidedTour variables:
Property nameType usedEffect
ActionOutsideTargetIntegerAction performed when the user clicks a control other than the target control(s) of the current step. The following actions are available:
  • gtaNone: Clicking the target control(s) has no effect.
  • gtaDefault (default value): The action depends on the type of effect:
    • if the Dim Disabled Windows (DDW) effect is used, the action will be set to gtaNone.
    • if the halo effect is used, the action will be set to gtaControl.
    • if no effect is used, the action will be set to gtaControl.
  • gtaControl: The control has a standard behavior. The events associated with the control are executed. The transition to the next step must be programmed.
  • gtaControlThenNextStep: The control has a standard behavior. Once the code of the control is executed, the Guided Tour automatically moves on to the next step.
    This action is available only for the following controls: Button, Check Box, Radio Button and Menu option. For other controls, only the transition to the next step will be run.
  • gtaNextStep: Clicking the control only takes the user to the next step.
  • gtaEnd: Clicking the control ends the Guided Tour.
This property can be overridden in each step.
ActionTargetIntegerAction performed when the user clicks the target control(s) of the current step. The following actions are available:
  • gtaNone: Clicking the target control(s) has no effect.
  • gtaDefault (default value): The action depends on the type of effect:
    • if the Dim Disabled Windows (DDW) effect is used, the action will be set to gtaNone.
    • if the halo effect is used, the action will be set to gtaControl.
    • if no effect is used, the action will be set to gtaControl.
  • gtaControl: The control has a standard behavior. The events associated with the control are executed. The transition to the next step must be programmed.
  • gtaControlThenNextStep: The control has a standard behavior. Once the code of the control is executed, the Guided Tour automatically moves on to the next step.
    This action is available only for the following controls: Button, Check Box, Radio Button and Menu option. For other controls, only the transition to the next step will be run.
  • gtaNextStep: Clicking the control only takes the user to the next step.
  • gtaEnd: Clicking the control ends the Guided Tour.
This property can be overridden in each step.
AutomaticValidationTimeoutDurationTime (expressed in seconds) before a step of the Guided Tour is automatically validated. Once this time has elapsed, the user is automatically taken to the next step.
If the timeout is set to 0, there will be no automatic validation.
By default, this property is set to 0.
EffectEffect used to highlight the target control(s) of all the steps of the Guided Tour.
All the sub-properties can be overridden in each step.
Effect.AnimationDurationIntegerEffect animation duration in milliseconds. By default:
  • if the DDW effect is used, the animation duration is set to 300,
  • if the halo effect is used, the animation duration is set to 1000.
Effect.ColorIntegerColor of the DDW or halo effect. By default:
  • if the DDW effect is used, the color is set to 0x0C0C0C,
  • if the halo effect is used, the color is set to 0xCCBFE9.
Effect.GrowIntegerHalo growth percentage. By default, this property is set to 100%.
This property is ignored for other effects.
Effect.MarginIntegerMargin expressed in pixels between the shape (Shape property) and the borders of the target control(s).
By default, this margin is set to 10 pixels.
Effect.OpacityIntegerEffect color opacity (percentage).
By default, this property is set to 70 % for the DDW effect, and to 100 % for the halo effect.
Effect.RoundIntegerRadius (expressed in pixels) to be applied to round the corners of the rectangle when the gtsRectangle constant is used. By default, this property is set to 5.
Effect.ShapeIntegerShape to be used for the "hole" (DDW effect) or for the halo (Halo effect):
  • gtsCircle: circle,
  • gtsRectangle: rectangle (with rounded corners according to the value of the Effect.Round property).
Effect.TypeInteger constantType of effect:
  • gttNone: no effect
  • gttDDW: dims the contents of the host window, and leaves a hole of the shape defined by the Shape property around the target control(s).
  • gttHalo (default): shows a halo of the shape defined by the Shape property around the target control(s).
IdentifierCharacter stringIdentifier of the Guided Tour, used for persistence.
This property must be specified and its content must be unique for the current project/application.
This identifier is used in particular with GuidedTourInfo. For example, it is possible to no longer open the Guided Tour if the user has already seen it.
Example:
IF GuidedTourInfo(GuidedTourGetStarted.Identifier, ...
gtInfoCount) = 0 THEN
GuidedTourStart(GuidedTourGetStarted)
END
InitializationWLanguage procedureWLanguage procedure executed when the Guided Tour is started. If this procedure returns False, the Guided Tour is stopped.
StepArray of GuidedTourStep
TerminationWLanguage procedureWLanguage procedure executed at the end of the Guided Tour.
TooltipTooltip display settings for the current step. All the sub-properties can be overridden in each step.
Tooltip.ActionAllowedActions allowed in the tooltip. The interface of the default internal window will be adapted according to the selected options.
This property and its sub-properties are ignored if the tooltip mode is set to gtModeTransparent.
Tooltip.ActionAllowed.EndTourBoolean
  • (default) to allow users to end the tour,
  • False otherwise.
Tooltip.ActionAllowed.NextStepBoolean
  • (default) to allow users to go the next step,
  • False otherwise.
Tooltip.ActionAllowed.PreviousStepBoolean
  • (default) to allow users to go the previous step,
  • False otherwise.
Tooltip.BackgroundColorIntegerTooltip background color.
This property is ignored if the Tooltip.Mode property is set to gtModeTransparent.
Default value: 0xFFFFFF
Tooltip.BorderColorIntegerTooltip border color.
Default value: 0xFF3B85FA
Tooltip.ColorIntegerTooltip text color (title and description)
Default value:
  • if the Tooltip.Mode property is set to gtModeOpaque, the color will be 0x000000,
  • if the Tooltip.Mode property is set to gtModeTransparent, the default color will be 0xFFFFFF,.
Tooltip.InternalPageCharacter stringName of the internal page to be used to customize the tooltip display options.
If this property corresponds to an empty string (""), the default page provided by WEBDEV will be used.
Tooltip.InternalWindowCharacter stringName of the internal window to be used to customize the tooltip display options.
If this property corresponds to an empty string (""), the default window provided by WINDEV / WINDEV Mobile will be used.
Tooltip.MarginIntegerMargin in pixels between the borders of the tooltip and its contents (internal window).
Default value: 15
Tooltip.MarkdownBoolean
  • if the controls of the internal window are displayed using Markdown formatting,
  • False otherwise.
Tooltip.ModeInteger constantTooltip display mode:
  • gtModeOpaque (default): the tooltip is displayed in a popup window with an arrow pointing to the target controls(s). The default internal window includes two buttons to go to the next/previous step or to end the tour.
  • gtModeTransparent: the tooltip is displayed with a transparent background next to the target control(s). In this mode, the user cannot interact with the controls in the internal window. In this mode, it is recommended to use the Dim Disabled Windows effect (gttDDW constant with the Effect.Type property).
VersionIntegerVersion number of the Guided Tour. By default, this property is set to 1.
This property must be incremented by the developer according to the new features to be highlighted in the Guided Tour.
In particular, this version number can be used with GuidedTourInfo. For example, it is possible to open the Guided Tour if new features are available.
Example:
// 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
Remarks

Functions that use GuidedTour variables

New in version 2024
GuidedTourChangeStep
Moves to another step of the Guided Tour.
New in version 2024
GuidedTourInfo
Returns information about a Guided Tour.
New in version 2024
GuidedTourStart
Starts the Guided Tour and displays the first step.
New in version 2024
GuidedTourStop
Stops the current Guided Tour or another specified Guided Tour.
Minimum version required
  • Version 2024
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 01/19/2024

Send a report | Local help