AYUDA EN LÍNEA
 WINDEVWEBDEV Y WINDEV MOBILE

¡Nueva funcionalidad de WINDEV, WEBDEV y WINDEV Mobile 2024!
Ayuda / WLanguage / Funciones WLanguage / Funciones estándar / Funciones de visitas guiadas
  • Propiedades específicas de las variables de tipo GuidedTour
  • Funciones que utilizan variables de tipo GuidedTour
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReportes y ConsultasCódigo de Usuario (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Código Navegador
WINDEV Mobile
AndroidWidget Android iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Otros
Procedimientos almacenados
El tipo GuidedTour permite definir las características avanzadas de una visita guiada y de sus etapas. Puede definir y cambiar las características de la visita guiada utilizando diferentes propiedades WLanguage.
Las características de las etapas pueden configurarse mediante variables de tipo GuidedTourStep. Si no definen características específicas para una etapa determinada, se utilizarán las características definidas en la variable GuidedTour.
Observación: Para obtener más información sobre la declaración de este tipo de variable y el uso de propiedades WLanguage, consulte Declarar una variable.
Ejemplo
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
Propiedades

Propiedades específicas de las variables de tipo GuidedTour

Las siguientes propiedades utilizan variables de tipo GuidedTour:
Nombre de la propiedadTipo utilizadoEfecto
ActionOutsideTargetIntegerAcción realizada cuando el usuario hace clic en un control distinto al control destacado de la etapa actual. Las acciones disponibles son las siguientes:
  • gtaNone: Hacer clic en los controles no tiene ningún efecto.
  • gtaDefault (valor predeterminado): La acción depende del tipo de efecto:
    • si se utiliza el efecto de Oscurecimiento de Ventanas Inactivas (OVI), la acción corresponderá a la constante gtaNone.
    • si se utiliza el efecto de halo, la acción corresponderá a la constante gtaControl.
    • si no se utiliza ningún efecto, la acción corresponderá a la constante gtaControl.
  • gtaControl: El control tiene un comportamiento estándar. Los eventos asociados al control se ejecutan. La transición a la etapa siguiente debe realizarse mediante programación.
  • gtaControlThenNextStep: El control tiene un comportamiento estándar. Una vez ejecutado el código del control, la visita guiada pasa automáticamente a la etapa siguiente.
    Esta acción solo está disponible para los siguientes controles: Botón, Casilla de verificación, Botón de opción y Opción de menú. Para los otros controles, solo se ejecutará la transición a la etapa siguiente.
  • gtaNextStep: Al hacer clic en el control, el usuario pasa a la etapa siguiente.
  • gtaEnd: Al hacer clic en el control, finaliza la visita guiada.
Esta propiedad puede sobrescribirse en cada etapa.
ActionTargetIntegerAcción realizada cuando el usuario hace clic en el o los controles destacados de la etapa actual. Las acciones disponibles son las siguientes:
  • gtaNone: Hacer clic en los controles no tiene ningún efecto.
  • gtaDefault (valor predeterminado): La acción depende del tipo de efecto:
    • si se utiliza el efecto de Oscurecimiento de Ventanas Inactivas (OVI), la acción corresponderá a la constante gtaNone.
    • si se utiliza el efecto de halo, la acción corresponderá a la constante gtaControl.
    • si no se utiliza ningún efecto, la acción corresponderá a la constante gtaControl.
  • gtaControl: El control tiene un comportamiento estándar. Los eventos asociados al control se ejecutan. La transición a la etapa siguiente debe realizarse mediante programación.
  • gtaControlThenNextStep: El control tiene un comportamiento estándar. Una vez ejecutado el código del control, la visita guiada pasa automáticamente a la etapa siguiente.
    Esta acción solo está disponible para los siguientes controles: Botón, Casilla de verificación, Botón de opción y Opción de menú. Para los otros controles, solo se ejecutará la transición a la etapa siguiente.
  • gtaNextStep: Al hacer clic en el control, el usuario pasa a la etapa siguiente.
  • gtaEnd: Al hacer clic en el control, finaliza la visita guiada.
Esta propiedad puede sobrescribirse en cada etapa.
AutomaticValidationTimeoutDurationTiempo (expresado en segundos) antes de que se valide automáticamente la etapa de la visita guiada. Una vez transcurrido este tiempo, el usuario pasa automáticamente a la etapa siguiente.
Si el tiempo de espera es 0, no habrá validación automática.
De forma predeterminada, esta propiedad se establece en 0.
EffectEfecto utilizado para destacar el o los controles de todas las etapas de la visita guiada.
Todas las subpropiedades pueden sobrescribirse en cada etapa.
Effect.AnimationDurationIntegerDuración de la animación del efecto en milisegundos. De forma predeterminada:
  • si se utiliza el efecto OVI, la duración de la animación se establece en 300,
  • si se utiliza el efecto de halo, la duración de la animación se establece en 1000.
Effect.ColorIntegerColor del efecto OVI o del halo. De forma predeterminada:
  • si se utiliza el efecto OVI, el color se establece en 0x0C0C0C,
  • si se utiliza el efecto de halo, el color se establece en 0xCCBFE9.
Effect.GrowIntegerPorcentaje de crecimiento del halo. De forma predeterminada, esta propiedad se establece en 100%.
Esta propiedad se ignora para los otros efectos.
Effect.MarginIntegerMargen en pixeles entre la forma (propiedad Shape) y los bordes del control destacado.
De forma predeterminada, este margen se establece en 10 pixeles.
Effect.OpacityIntegerOpacidad del color del efecto (porcentaje).
De forma predeterminada, esta propiedad se establece en 70 % para el efecto OVI, y en 100 % para el efecto de halo.
Effect.RoundIntegerRadio en pixeles que se aplicará para redondear las esquinas del rectángulo cuando se utilice la constante gtsRectangle. De forma predeterminada, esta propiedad se establece en 5.
Effect.ShapeIntegerForma que se utilizará para el resaltar el control (efecto OVI) o para el halo (efecto Halo):
  • gtsCircle: círculo,
  • gtsRectangle: rectángulo (con esquinas redondeadas según el valor de la propiedad Effect.Round).
Effect.TypeConstante de tipo IntegerTipo de efecto:
  • gttNone: ningún efecto
  • gttDDW: oscurece el contenido de la ventana principal y deja un espacio con la forma definida por la propiedad Shape alrededor del o de los controles destacados.
  • gttHalo (predeterminado): muestra un halo de la forma definida por la propiedad Shape alrededor del o de los controles destacados.
IdentifierCharacter stringIdentificador de la visita guiada utilizado para la persistencia.
Esta propiedad debe especificarse y su contenido debe ser único para el proyecto/aplicación actual.
Este identificador se utiliza en particular con la función GuidedTourInfo. Por ejemplo, puede definir que no se vuelva a abrir una visita guiada si el usuario ya la ha visto.
Ejemplo:
IF GuidedTourInfo(GuidedTourGetStarted.Identifier, ...
gtInfoCount) = 0 THEN
GuidedTourStart(GuidedTourGetStarted)
END
InitializationProcedimiento WLanguageProcedimiento WLanguage ejecutado al iniciar la visita guiada. Si este procedimiento devuelve False, la visita guiada se detiene.
StepArray de GuidedTourStep
TerminationProcedimiento WLanguageProcedimiento WLanguage ejecutado al final de la visita guiada.
TooltipDefine las opciones de visualización del tooltip que se muestra en la etapa actual. Todas las subpropiedades pueden sobrescribirse en cada etapa.
Tooltip.ActionAllowedAcciones permitidas en el tooltip. La interfaz de la ventana interna predeterminada se adaptará en función de las opciones seleccionadas.
Esta propiedad y sus subpropiedades se ignoran si el modo del tooltip corresponde a la constante gtModeTransparent.
Tooltip.ActionAllowed.EndTourBoolean
  • True (predeterminado) para permitir a los usuarios finalizar la visita,
  • False en caso contrario.
Tooltip.ActionAllowed.NextStepBoolean
  • True (predeterminado) para permitir a los usuarios ir a la etapa siguiente,
  • False en caso contrario.
Tooltip.ActionAllowed.PreviousStepBoolean
  • True (predeterminado) para permitir a los usuarios volver a la etapa anterior,
  • False en caso contrario.
Tooltip.BackgroundColorIntegerColor de fondo del tooltip.
Esta propiedad se ignora si la propiedad Tooltip.Mode corresponde a gtModeTransparent.
Valor predeterminado: 0xFFFFFF
Tooltip.BorderColorIntegerColor del borde del tooltip.
Valor predeterminado: 0xFF3B85FA
Tooltip.ColorIntegerColor del texto del tooltip (título y descripción)
Valor predeterminado:
  • si la propiedad Tooltip.Mode corresponde a la constante gtModeOpaque, el color será 0x000000,
  • si la propiedad Tooltip.Mode corresponde a la constante gtModeTransparent, el color predeterminado será 0xFFFFFF,.
Tooltip.InternalPageCharacter stringNombre de la página interna que se utilizará para personalizar las opciones de visualización del tooltip.
Si esta propiedad corresponde a una cadena vacía (""), se utilizará la página predeterminada proporcionada por WEBDEV.
Tooltip.InternalWindowCharacter stringNombre de la ventana interna que se utilizará para personalizar las opciones de visualización del tooltip.
Si esta propiedad corresponde a una cadena vacía (""), se utilizará la ventana predeterminada proporcionada por WINDEV o WINDEV Mobile.
Tooltip.MarginIntegerMargen en pixeles entre los bordes del tooltip y su contenido (ventana interna).
Valor predeterminado: 15
Tooltip.MarkdownBoolean
  • True si los controles de la ventana interna se muestran con formato Markdown,
  • False en caso contrario.
Tooltip.ModeConstante de tipo IntegerModo de visualización del tooltip:
  • gtModeOpaque (predeterminado): el tooltip se muestra en una ventana emergente con una flecha que apunta a los controles destacados. La ventana interna predeterminada incluye dos botones para ir a la etapa siguiente/anterior o para finalizar la vista.
  • gtModeTransparent: el tooltip se muestra con un fondo transparente junto a los controles destacados. En este modo, el usuario no puede interactuar con los controles de la ventana interna. En este modo, se recomienda utilizar el efecto de Oscurecimiento de Ventanas Inactivas (constante gttDDW con la propiedad Effect.Type).
VersionIntegerNúmero de versión de la visita guiada. De forma predeterminada, esta propiedad se establece en 1.
Esta propiedad debe ser incrementada por el desarrollador en función de las novedades que se van a mostrar en la visita guiada.
Este número de versión puede utilizarse con la función GuidedTourInfo. Por ejemplo, es posible abrir la visita guiada si hay nuevas funcionalidades disponibles.
Ejemplo:
// 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
Observaciones

Funciones que utilizan variables de tipo GuidedTour

Novedad versión 2024
GuidedTourChangeStep
Cambia a otra etapa de la visita guiada.
Novedad versión 2024
GuidedTourInfo
Devuelve información sobre una visita guiada.
Novedad versión 2024
GuidedTourStart
Inicia la visita guiada y muestra la primera etapa.
Novedad versión 2024
GuidedTourStop
Detiene la visita guiada actual u otra visita guiada especificada.
Versión mínima requerida
  • Versión 2024
Esta página también está disponible para…
Comentarios
Haga clic en [Agregar] para publicar un comentario

Última modificación: 19/01/2024

Señalar un error o enviar una sugerencia | Ayuda local