| | |
| Property name | Type used | Effect |
|---|
| ActionTarget | Integer | Action 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.
If this property is specified, it overrides the value defined for the Guided Tour. |
| ActionOutsideTarget | Integer | Action 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.
If this property is specified, it overrides the value defined for the Guided Tour. |
| AutomaticValidationTimeout | Duration | Time (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. |
| Description | Character string | Description of the step, displayed in the tooltip.
Default value: empty string |
| Effect | | Effect used to highlight the target control(s) of the step. All the sub-properties can be overridden in each step. |
| Effect.AnimationDuration | Integer | Effect 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.Color | Integer | Color 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.Grow | Integer | Halo growth percentage. By default, this property is set to 100%. This property is ignored for other effects. |
| Effect.Margin | Integer | Margin 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.Opacity | Integer | Effect color opacity (percentage). By default, this property is set to 70 % for the DDW effect, and to 100 % for the halo effect. |
| Effect.Round | Integer | Radius (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.Shape | Integer | Shape 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.Type | Integer constant | Type 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).
|
| Index | Integer | - Index of the step in the Guided Tour,
- 0 if the step does not belong to a Guided Tour.
This property is read-only. |
| Initialization | WLanguage procedure | WLanguage procedure executed before the step is displayed. This procedure takes a GuidedTourStep variable as a parameter, corresponding to the current step.
If this procedure returns False, the step will be ignored. |
| Target | Character string | Name of the control or group of controls to be highlighted in the given step. |
| Termination | WLanguage procedure | WLanguage procedure executed when the user goes to the next or previous step, or at the end of the Guided Tour.
This procedure takes a GuidedTourStep variable as a parameter, corresponding to the current step. |
| Title | Character string | Title of the step, displayed in the tooltip. By default, this property is set to "" (empty string). |
| Tooltip | | Tooltip display settings for the current step. If this property is specified, it overrides the value defined for the Guided Tour. |
| Tooltip.ActionAllowed | | Actions 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.EndTour | Boolean | - (default) to allow users to end the tour,
- False otherwise.
|
| Tooltip.ActionAllowed.NextStep | Boolean | - (default) to allow users to go the next step,
- False otherwise.
|
| Tooltip.ActionAllowed.PreviousStep | Boolean | - (default) to allow users to go the previous step,
- False otherwise.
|
| Tooltip.BackgroundColor | Integer | Tooltip background color. This property is ignored if the Tooltip.Mode property is set to gtModeTransparent. Default value: 0xFFFFFF |
| Tooltip.BorderColor | Integer | Tooltip border color. Default value: 0xFF3B85FA |
| Tooltip.Color | Integer | Tooltip 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.InternalPage | Character string | Name 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.InternalWindow | Character string | Name 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.Margin | Integer | Margin in pixels between the borders of the tooltip and its contents (internal window). Default value: 15 |
| Tooltip.Markdown | Boolean | - if the controls of the internal window are displayed using Markdown formatting,
- False otherwise.
|
| Tooltip.Mode | Integer constant | Tooltip 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).
|