TourPanel
Namespace: Wisej.Web.Ext.TourPanel
Assembly: Wisej.Web.Ext.TourPanel
Provides a tour panel template that can be used to create a guided tour of an application.
- C#
- VB.NET
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.
| Name | Type | Description |
|---|---|---|
| parent | Control | The parent control that owns this tour panel. |
Throws:
- ArgumentNullException The value of parent is null.
Properties
AutoClose
Boolean: Determines whether the TourPanel will close automatically when the user clicks outside of the control. (Default: False)
AutoPlay
Boolean: Determines whether the TourPanel will start showing the steps automatically. (Default: True)
AutoSize
Boolean: Determines whether the TourPanel automatically adjusts its dimension when the step changes. (Default: True)
Container
ContainerControl: Returns the ContainerControl that this TourPanel is attached to.
CurrentStep
TourStep: Returns or sets the current TourStep.
DefaultAlignment
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.
DefaultAutoPlayTime
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.
DefaultOffset
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.
DefaultShowClose
Boolean: Determines whether the TourPanel shows the CloseButton and ExitButton buttons. (Default: True)
The ExitButton is always shown on the last step.
HighlightColor
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])
HighlightTarget
Boolean: Returns or sets a value indicating whether the current target is highlighted. (Default: True)
IsPlaying
Boolean: Returns whether the TourPanel is currently playing the steps.
SelectedIndex
Int32: Returns or sets the index of the current TourStep in the Steps collection. (Default: 0)
Steps
TourStep[]: Collection of the steps to show in this TourPanel.
Methods
Back()
Shows the previous step.
Close()
Closes the TourPanel.
First()
Shows the first step.
Next()
Shows the next step
OnAfterStep(e)
Fires the AfterStep event.
| Parameter | Type | Description |
|---|---|---|
| e | TourPanelEventArgs | A TourPanelEventArgs that contains the event data. |
OnBeforeStep(e)
Fires the BeforeStep event.
| Parameter | Type | Description |
|---|---|---|
| e | TourPanelEventArgs | A TourPanelEventArgs that contains the event data. |
Pause()
Pauses auto-advancing the steps.
Play()
Starts auto-advancing the steps.
Show()
Shows the TourPanel without a container.
Show(container)
Shows the TourPanel for the specified container control.
| Parameter | Type | Description |
|---|---|---|
| container | ContainerControl | The ContainerControl that hosts the controls that are the target for this TourPanel. |
Events
AfterStep
TourPanelEventHandler Fired when the current step is replaced by a new step. This event is not cancelable.
BeforeStep
TourPanelEventHandler Fired when the TourPanel shows a new step. This event is cancelable.
Closed
EventHandler Fired when the TourPanel control is closed.
Ended
EventHandler Fires when the TourPanel has finished showing the steps.
NotFound
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.
Paused
EventHandler Fired when the TourPanel has been paused.
Playing
EventHandler Fires when the TourPanel is playing the steps automatically.