You are here: Reference Guides > Designer Form Controls (A-Z) > Ws.History

Ws.History

With the Ws.History control you can put a workflow history into your form. There are two options for how to render the history:

  • Graphic—an actual image of the workflow itself.
  • Table—a table similar to the one presented when Winshuttle History is viewed for the Task and/or Process.

Download example (.wssln file)

Note: In order for the Ws.History control to render workflow history, there has to be history established. This means that if you have a Ws.History control on your first View, it will not render anything and in some cases may result in an error.

Ws.History Properties

Property

Description

Graphic

Select this option to specify the creation of a graphic representing the current state of the workflow. Options for this setting are described below:

  • Highlight Active Task: select this option to make the graphic have an outline around the active task in the workflow graphic.
  • Show History in Tooltips: select this option to enable tooltips that show the entire history for the given task when the mouse pointer is hovered over the task node in the graphic.
  • Show History in Light Box: select this option to allow clicking on the task node to produce a light box effect that displays the history for the given task.
  • Inline Graphic: Select this option to show the graphic in the form itself. The graphic will be placed wherever you place the Ws.History control in the form. You can specify the dimensions as follows: Width: the width of the inline graphic, Height: the height of the inline graphic.
  • Launch New Window: select this option to launch a new window when the user clicks the History Control button in the form.
  • Image URL: enter the URL (http://) that points to the image that you would like to use in place of the standard History Control button.

Table

Select this option to place a tabular view in the form at whatever position you insert the Ws.History control.

Configuring the Ws.History Control

Back to top

The following section illustrates how to use the Ws.History control.

  1. Add the Ws.History Control to your form, right-click the control, and then select Properties.

  2. Select either the Table option or the Graphic option. If you select Table you don’t need to configure anything else, although you can specify height and width parameters. If you select Graphic, you have 3 different options that you can configure:
    • Highlight Active Task: This will highlight the current node/task that the user is on.
    • Show History in Tooltips: Select this option to enable tooltips that show the entire history for the given task when the mouse pointer is hovered over the task node in the graphic.
    • Show in Lightbox: Select this option to allow clicking on the task node to produce a light box effect that displays the history for the given task.