Table of contents
- 1 Constructors
- 2 Properties
- 3 Methods
- 3.1 HasNextStep() : Boolean
- 3.2 HasPreviousStep() : Boolean
- 3.3 LinkToStep(String linkText, WizardStepPage step) : String
- 3.4 LinkToStep(String linkText, WizardStepPage step, Object id) : String
- 3.5 LinkToStep(String linkText, WizardStepPage step, Object id, IDictionary attributes) : String
- 3.6 LinkToNext(String linkText) : String
- 3.7 LinkToNext(String linkText, IDictionary attributes) : String
- 3.8 LinkToNext(String linkText, Object id) : String
- 3.9 LinkToNext(String linkText, Object id, IDictionary attributes) : String
- 3.10 LinkToPrevious(String linkText) : String
- 3.11 LinkToPrevious(String linkText, IDictionary attributes) : String
- 3.12 LinkToPrevious(String linkText, Object id) : String
- 3.13 LinkToPrevious(String linkText, Object id, IDictionary attributes) : String
WizardHelper API Document
Provide useful helpers to be used in a layout view or in the wizards steps views.
Constructors
WizardHelper()
Initializes a new instance of the Castle.MonoRail.Framework.Helpers.WizardHelper class.
Properties
| Name | Type | Description |
|---|---|---|
| PreviousStepName | String | Returns the name of the previous step |
| NextStepName | String | Returns the name of the next step |
Methods
HasNextStep() : Boolean
Returns true if the current wizard flow has a next step.
HasPreviousStep() : Boolean
Returns true if the current wizard flow has an accessible previous step.
This will only return true if not the first step
LinkToStep(String linkText, WizardStepPage step) : String
Creates an anchor tag (link) to the specified step.
<a href="/page2.rails">linkText</a>
| Parameter | Description |
|---|---|
| linkText | The label for the step |
| step | The WizardStepPage to link to |
LinkToStep(String linkText, WizardStepPage step, Object id) : String
Creates an anchor tag (link) to the specified step.
<a href="/page2.rails">linkText</a>
| Parameter | Description |
|---|---|
| linkText | The label for the step |
| step | The WizardStepPage to link to |
| id | Object to use for the action ID argument. |
LinkToStep(String linkText, WizardStepPage step, Object id, IDictionary attributes) : String
Creates an anchor tag (link) to the specified step.
<a href="/page2.rails">linkText</a>
| Parameter | Description |
|---|---|
| linkText | The label for the step |
| step | The WizardStepPage to link to |
| id | Object to use for the action ID argument. |
| attributes | Additional attributes for the a tag. |
LinkToNext(String linkText) : String
Creates an anchor tag (link) to the next step.
<a href="/page2.rails">linkText</a>
This helper assumes there is a next step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasNextStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
LinkToNext(String linkText, IDictionary attributes) : String
Creates an anchor tag (link) to the next step.
<a href="/page2.rails">linkText</a>
This helper assumes there is a next step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasNextStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
| attributes | Additional attributes for the a tag. |
LinkToNext(String linkText, Object id) : String
Creates an anchor tag (link) with an id attribute to the next step.
<a href="/page2.rails?Id=id">linkText</a>
This helper assumes there is a next step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasNextStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
| id | Object to use for the action ID argument. |
LinkToNext(String linkText, Object id, IDictionary attributes) : String
Creates an anchor tag (link) with an id attribute to the next step.
<a href="/page2.rails?Id=id">linkText</a>
This helper assumes there is a previous step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasNextStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
| id | Object to use for the action ID argument. |
| attributes | Additional attributes for the a tag. |
LinkToPrevious(String linkText) : String
Creates an anchor tag (link) to the previous step.
<a href="/page2.rails">linkText</a>
This helper assumes there is a previous step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasPreviousStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
LinkToPrevious(String linkText, IDictionary attributes) : String
Creates an anchor tag (link) to the previous step.
<a href="/page2.rails">linkText</a>
This helper assumes there is a previous step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasPreviousStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
| attributes | Additional attributes for the a tag. |
LinkToPrevious(String linkText, Object id) : String
Creates an anchor tag (link) with an id attribute to the previous step.
<a href="/page2.rails?Id=id">linkText</a>
This helper assumes there is a previous step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasPreviousStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
| id | Object to use for the action ID argument. |
LinkToPrevious(String linkText, Object id, IDictionary attributes) : String
Creates an anchor tag (link) with an id attribute to the previous step.
<a href="/page2.rails?Id=id">linkText</a>
This helper assumes there is a previous step. It's advised that you use Castle.MonoRail.Framework.Helpers.WizardHelper.HasPreviousStep before calling this
| Parameter | Description |
|---|---|
| linkText | The label for the link |
| id | Object to use for the action ID argument. |
| attributes | Additional attributes for the a tag. |