TourPanel

Namespace: Wisej.Web.Ext.TourPanel

Assembly: Wisej.Web.Ext.TourPanel (3.2.0.0)

• Control

  • ScrollableControl

    • ContainerControl

      • TourPanel

Provides a tour panel template that can be used to create a guided tour of an application.

public class TourPanel : ContainerControl

Public Class TourPanel
    Inherits ContainerControl

Constructors

TourPanel()

Default constructor.

TourPanel(parent)

Initializes a new instance of the TourPanel control and assigns it to the specified parent.

Throws:

• ArgumentNullException The value of parent is null.

Properties

Boolean: Determines whether the TourPanel will close automatically when the user clicks outside of the control. (Default: False)

Boolean: Determines whether the TourPanel will start showing the steps automatically. (Default: True)

Boolean: Determines whether the TourPanel automatically adjusts its dimension when the step changes. (Default: True)

ContainerControl: Returns the ContainerControl that this TourPanel is attached to.

TourStep: Returns or sets the current TourStep.

Placement: Returns or sets the default Placement of the TourPanel. (Default: BottomCenter)

Each TourStep can override the DefaultAlignment and change the placement of the TourStep.

Int32: Returns or sets the default number of seconds before showing the next step when the AutoPlay property is set to true. (Default: 5)

Each TourStep can override the DefaultAutoPlayTime and change the AutoPlayTime of the TourStep. Throws:

• ArgumentException When the value is less than 1.

Padding: Returns or sets the default offset from the target, in pixels.

Each TourStep can override the DefaultOffset and change the offset of the TourStep.

Boolean: Determines whether the TourPanel shows the CloseButton and ExitButton buttons. (Default: True)

The ExitButton is always shown on the last step.

Color: Returns or sets the color index for the highlight mask. Uses the highlightColor set in the theme when this property is Empty. (Default: Color [Empty])

Boolean: Returns or sets a value indicating whether the current target is highlighted. (Default: True)

Boolean: Returns whether the TourPanel is currently playing the steps.

Int32: Returns or sets the index of the current TourStep in the Steps collection. (Default: 0)

TourStep[]: Collection of the steps to show in this TourPanel.

Methods

Shows the previous step.

Closes the TourPanel.

Shows the first step.

Shows the next step

Fires the AfterStep event.

Fires the BeforeStep event.

Pauses auto-advancing the steps.

Starts auto-advancing the steps.

Shows the TourPanel without a container.

Shows the TourPanel for the specified container control.

Events

TourPanelEventHandler Fired when the current step is replaced by a new step. This event is not cancelable.

TourPanelEventHandler Fired when the TourPanel shows a new step. This event is cancelable.

EventHandler Fired when the TourPanel control is closed.

EventHandler Fires when the TourPanel has finished showing the steps.

HandledEventHandler Fires when the TourPanel cannot find the target widget specified in the TargetName property of the CurrentStep.

If this event is not handled, the default behavior is to throw an exception.

EventHandler Fired when the TourPanel has been paused.

EventHandler Fires when the TourPanel is playing the steps automatically.