Home

Castle Stronghold

•  
• Home
• Download
• API Doc
• Using
• Forum
• Jira/Issue tracker
• Builds

HtmlHelper API Document

Provides usefull common methods to generate HTML tags.

Constructors

HtmlHelper()

Initializes a new instance of the Castle.MonoRail.Framework.Helpers.HtmlHelper class.

Methods

FieldSet(String legend) : String

Creates a fieldset

tag with a legend.

<fieldset><legend>legendArg</legend>

Example

:

$HtmlHelper.FieldSet( "legendArg" )
...
$HtmlHelper.EndFieldSet()

<fieldset><legend>legendArg</legend>

EndFieldSet() : String

Creates a closing fieldset

tag.

</fieldset>

Example

:

$HtmlHelper.FieldSet( "legendArg" )
...
$HtmlHelper.EndFieldSet()

</fieldset>

Form(String action) : String

Creates a form tag with "post" method and specified action

.

<form method="post" action="actionArg">

Example

:

$HtmlHelper.Form( "actionArg" )
...
$HtmlHelper.EndForm()

<form method="post" action="actionArg">

Form(String action, String id, String method) : String

Creates a form tag with specified method, action and id

.

<form method="methodArg" action="actionArg" id="idArg">

Example

:

$HtmlHelper.Form( "actionArg", "idArg", "methodArg" )
...
$HtmlHelper.EndForm()

<form method="methodArg" action="actionArg" id="idArg">

Form(String action, String id, String method, String onSubmit) : String

Creates a form tag with specified method, action, id and onSubmit

event handler.

<form method="methodArg" action="actionArg" id="idArg" onsubmit="onSubmitArg">

Example

:

$HtmlHelper.Form( "actionArg", "idArg", "methodArg", "submitHandler()" )
...
$HtmlHelper.EndForm()

<form method="methodArg" action="actionArg" id="idArg" onsubmit="onSubmitArg">

Form(String action, IDictionary attributes) : String

Creates a form tag the specified action

.

<form action="actionArg">

EndForm() : String

Creates a closing form

tag.

</form>

Example

:

$HtmlHelper.Form( "actionArg", "idArg", "methodArg", "submitHandler()" )
...
$HtmlHelper.EndForm()

</form>

Link(String target, String linkText) : String

Creates an anchor (link) to the target

<a href="/sometarget.html">linkText</a>

Example

:

$HtmlHelper.Link( "mypage.html", "This is a link to my page" )

<a href="something.html">something</a>

Link(String target, String linkText, IDictionary attributes) : String

Creates an anchor (link) to the target

<a href="/sometarget.html">linkText</a>

Example

:

$HtmlHelper.Link( "mypage.html", "This is a link to my page", $DictHelper.CreateDict("class=mylinkclass") )

<a href="something.html" class="mylinkclass">something</a>

LinkTo(String name, String action) : String

Creates an anchor (link) to the action

on the current controller.

<a href="/website/currentController/actionArg.rails">nameArg</a>

Example

:

$HtmlHelper.LinkTo( "linkName", "requiredAction" )

<a href="/websiter/currentController/actionArg.rails">nameArg</a>

LinkTo(String name, String controller, String action) : String

Creates an anchor (link) to the action on the specified controller

.

<a href="/website/controllerArg/actionArg.rails">nameArg</a>

Example

:

$HtmlHelper.LinkTo( "linkName", "someController", "requiredAction" )

<a href="/website/controllerArg/actionArg.rails">nameArg</a>

LinkTo(String name, String controller, String action, Object id) : String

Creates an anchor (link) to the action on the specified controller passing provided id

.

<a href="/website/controllerArg/actionArg.rails?id=objectId">nameArg</a>

Example

:

$HtmlHelper.LinkTo( "linkName", "someController", "requiredAction", objectToRefByID )

<a href="/website/controllerArg/actionArg.rails?id=object">nameArg</a>

LinkToAttributed(String name, String controller, String action, IDictionary attributes) : String

Creates an anchor (link) to the action on the specified controller

<a href="/website/controllerArg/actionArg.rails">nameArg</a>

Example

:

$HtmlHelper.LinkToAttributed( "linkName", "someController", "requiredAction", $DictHelper.CreateDict("class=something") )

<a href="/website/controllerArg/actionArg.rails">nameArg</a>

LinkToAttributed(String name, String controller, String action, Object id, IDictionary attributes) : String

Creates an anchor (link) to the action on the specified controller

<a href="/website/controllerArg/actionArg.rails?id=x">nameArg</a>

Example

:

$HtmlHelper.LinkToAttributed( "linkName", "someController", "requiredAction", $DictHelper.CreateDict("class=something") )

<a href="/website/controllerArg/actionArg.rails">nameArg</a>

MapToVirtual(String target) : String

Maps target

to website virtual path.

/website/targetArg

Example

:

$HtmlHelper.MapToVirtual( "targetFolder/targetFile.html" )

/website/targetArg

LabelFor(String forId, String label) : String

Creates a label for the element indicated with forId

.

<label  for="forIdArg">labelArg</label>

Example

:

$HtmlHelper.LabelFor( "forIdArg", "labelArg" )

<label  for="forIdArg">labelArg</label>

LabelFor(String forId, String label, IDictionary attributes) : String

Creates a label for the element indicated with forId

.

<label key1="value1" key2="value2"  for="forIdArg">labelArg</label>

Example

:

$HtmlHelper.LabelFor( "forIdArg", "labelArg", IDictionary )

<label key5="value5" key4="value4" key1="value1" key3="value3" key2="value2"  for="forIdArg">labelArg</label>

DateTime(String name, DateTime value) : String

Creates three select

tags to input day, month and year.

<select name="nameArgday" id="nameArgday" > ... </select>
<select name="nameArgmonth" id="nameArgmonth" > ... </select>
<select name="nameArgyear" id="nameArgyear" > ... </select>

Example

:

$HtmlHelper.DateTime( "nameArg", new DateTime( 2005, 07, 15 ) )

<select name="nameArgday" id="nameArgday" >    <option>1</option>
    <option>2</option>
    ...
    <option>14</option>
       <option selected>15</option>
       <option>16</option>
       ...
       <option>30</option>
       <option>31</option>
    </select> <select name="nameArgmonth" id="nameArgmonth" >    <option>1</option>
       <option>2</option>
       ...
       <option>6</option>
       <option selected>7</option>
       <option>8</option>
       ...
       <option>11</option>
       <option>12</option>
    </select> <select name="nameArgyear" id="nameArgyear" >    <option>1930</option>
       <option>1931</option>
       ...
       <option>2004</option>
       <option selected>2005</option>
       <option>2006</option>
       ...
       <option>2029</option>
</select>

DateTime(String name, DateTime value, IDictionary attributes) : String

Creates three select

tags to input day, month and year.

<select name="nameArgday" id="nameArgday" key1="value1" key3="value3" key2="value2" > ... </select>
<select name="nameArgmonth" id="nameArgmonth" key1="value1" key3="value3" key2="value2" > ... </select>
<select name="nameArgyear" id="nameArgyear" key1="value1" key3="value3" key2="value2" > ... </select>

Example

:

$HtmlHelper.DateTime( "nameArg", new DateTime( 2005, 07, 15 ), IDictionary )

<select name="nameArgday" id="nameArgday" key1="value1" key2="value2" >    <option>1</option>
    <option>2</option>
    ...
    <option>14</option>
    <option selected>15</option>
    <option>16</option>
    ...
    <option>30</option>
    <option>31</option>
 </select> <select name="nameArgmonth" id="nameArgmonth" key1="value1" key2="value2" >    <option>1</option>
    <option>2</option>
    ...
    <option>6</option>
    <option selected>7</option>
    <option>8</option>
    ...
    <option>11</option>
    <option>12</option>
 </select> <select name="nameArgyear" id="nameArgyear" key1="value1" key2="value2" >    <option>1930</option>
    <option>1931</option>
    ...
    <option>2004</option>
    <option selected>2005</option>
    <option>2006</option>
    ...
    <option>2029</option>
</select>

TextArea(String name, Int32 cols, Int32 rows, String value) : String

Creates a text area element.

<textarea id="nameArg" name="nameArg" cols="10" rows="10">valueArg</textarea>

Example

:

$HtmlHelper.TextArea( "nameArg", 10, 20, "Text inside text area." )

<textarea id="nameArg" name="nameArg" cols="10" rows="10">valueArg</textarea>

InputButton(String value) : String

Creates an input element of the button type.

<input type="button" value="valueArg" />

Example

:

$HtmlHelper.InputButton( "valueArg" )

<input type="button" name="valueArg" value="valueArg" />

InputButton(String name, String value) : String

Creates an input element of the button type.

<input type="button" name="nameArg" id="nameArg" value="valueArg" />

InputButton(String name, String value, IDictionary attributes) : String

Creates an input element of the button type.

<input type="button" name="nameArg" id="nameArg" value="valueArg" />

InputCheckbox(String name, Object value) : String

Creates an input element of the checkbox type.

<input type="checkbox" name="nameArg" id="nameArg" value="valueArg" />

<input type="checkbox" name="name" id="name" value="1" />

InputCheckbox(String name, Object value, Boolean isChecked) : String

Creates an input element of the checkbox type.

<input type="checkbox" name="nameArg" id="nameArg" value="valueArg" />

InputCheckbox(String name, Object value, IDictionary attributes) : String

Creates an input element of the checkbox type.

<input type="checkbox" name="nameArg" id="nameArg" value="valueArg" />

InputRadio(String name, Object value) : String

Creates an input element of the radio type.

<input type="radio" name="nameArg" value="valueArg" />

<input type="radio" name="name" value="1" />

InputRadio(String name, Object value, IDictionary attributes) : String

Creates an input element of the radio type.

<input type="radio" name="nameArg" value="valueArg" />

InputFile(String name) : String

Creates an input element of the file type.

<input type="file" name="nameArg" />

<input type="file" name="name" />

InputFile(String name, IDictionary attributes) : String

Creates an input element of the file type.

<input type="file" name="nameArg" />

InputText(String name, String value) : String

Creates an input element of the text type.

<input type="text" name="nameArg" id="nameArg" value="valueArg" />

Example

:

$HtmlHelper.InputText( "nameArg", "valueArg" )

<input type="text" name="nameArg" id="nameArg" value="valueArg" />

InputText(String name, String value, Int32 size, Int32 maxlength) : String

Creates an input element of the text type of specified size and maxlength

.

<input type="text" name="nameArg" id="nameArg" value="valueArg" size="10" maxlength="10" />

Example

:

$HtmlHelper.InputText( "nameArg", "valueArg", 10, 10 )

<input type="text" name="nameArg" id="nameArg" value="valueArg" size="10" maxlength="10" />

InputText(String name, String value, Int32 size, Int32 maxlength, IDictionary attributes) : String

Creates an input element of the text type with specified size, maxlength and attributes

.

<input type="text" name="nameArg" id="nameArg" value="valueArg" size="10" maxlength="10" />

Example

:

$HtmlHelper.InputText( "nameArg", "valueArg", 10, 10, IDictionary )

<input type="text" name="nameArg" id="nameArg" value="valueArg" size="10" maxlength="10" key1="value1" key2="value2" />

InputText(String name, String value, String id) : String

Creates an input element of the text type with custom name and id

.

<input type="text" name="nameArg" id="idArg" value="valueArg" />

Example

:

$HtmlHelper.InputText( "nameArg", "valueArg", "idArg" )

<input type="text" name="nameArg" id="idArg" value="valueArg" />

InputText(String name, String value, IDictionary attributes) : String

Creates a hidden type input element.

<input type="hidden" name="nameArg" id="nameArg" value="valueArg" />

InputPassword(String name) : String

Creates an input element of password type

InputPassword(String name, String value) : String

Creates an input element of password type

InputPassword(String name, String value, IDictionary attributes) : String

Creates an input element of password type

InputHidden(String name, String value) : String

Creates an input hidden element

Example

:

$HtmlHelper.InputHidden( "nameArg", "valueArg" )

<input type="hidden" name="nameArg" id="nameArg" value="valueArg" />

InputHidden(String name, Object value) : String

Creates a hidden type input element.

<input type="hidden" name="nameArg" id="nameArg" value="object" />

Example

:

$HtmlHelper.InputHidden( "nameArg", object  )

<input type="hidden" name="nameArg" id="nameArg" value="object" />

SubmitButton(String value) : String

Creates a submit button.

<input type="submit" value="valueArg"  />

Example

:

$HtmlHelper.SubmitButton( "valueArg" )

<input type="submit" value="valueArg"  />

SubmitButton(String value, IDictionary attributes) : String

Creates a submit button.

<input type="submit" value="valueArg" key1="value1" key2="value2"  />

Example

:

$HtmlHelper.SubmitButton( "valueArg", IDictionary )

<input type="submit" value="valueArg" key1="value1" key2="value2"  />

Select(String name) : String

Creates opening select

tag.

<select name="nameArg" id="nameArg">

Example

:

$HtmlHelper.Select( "nameArg" )
...
$HtmlHelper.EndSelect()

<select name="nameArg" id="nameArg">

Select(String name, IDictionary attributes) : String

Creates opening select

tag.

<select name="nameArg" id="nameArg" key1="value1" key2="value2" >

Example

:

$HtmlHelper.Select( "nameArg", IDictionary )
...
$HtmlHelper.EndSelect()

<select name="nameArg" id="nameArg" key1="value1" key2="value2" >

EndSelect() : String

Creates a closing select tag.

Example

:

$HtmlHelper.Select( "nameArg" )
...
$HtmlHelper.EndSelect()

</select>

OptionGroup(String label) : String

TODO: Document this!

EndOptionGroup() : String

Missing summary

CreateOption(String text, Object value) : String

TODO: Document this!

CreateOption(String text, Object value, IDictionary htmlAttributes) : String

TODO: Document this!

CreateOptionsFromPrimitiveArray(Array elems, String selected) : String

Creates option elements from System.Array. Marks the option that matches the selected

argument (if provided).

<option>0</option>
<option>1</option>
...
<option>5</option>
<option selected>selectedArg</option>
<option>object</option>

Example

:

$HtmlHelper.CreateOptionsFromPrimitiveArray( Array, "selectedArg" )

<option>0</option>
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
<option selected>selectedArg</option>
<option>object</option>

CreateOptionsFromArray(Array elems, String textProperty, String valueProperty) : String

Creates options elements from an System.Array

.

<option value="valueProp">textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

Example

:

$HtmlHelper.CreateOptionsFromArray( ICollection, "textPropertyArg", "valuePropertyArg" )

<option value="valueProp">textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

<option>0</option>
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
<option>object</option>
<option>MR.Logic.Controllers.HtmlHelperController+SampleClass</option>

CreateOptionsFromArray(Array elems, String textProperty, String valueProperty, Object selectedValue) : String

Creates options elements from an System.Array

.

<option value="valueProp" selected>textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

Example

:

$HtmlHelper.CreateOptionsFromArray( ICollection, "textPropertyArg", "valuePropertyArg", object )

<option value="valueProp" selected>textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

<option>0</option>
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
<option selected>object</option>
<option>MR.Logic.Controllers.HtmlHelperController+SampleClass</option>

CreateOptions(ICollection elems, String textProperty, String valueProperty) : String

Creates options elements from an System.Collections.ICollection

.

<option value="valueProp">textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

Example

:

$HtmlHelper.CreateOptions( ICollection, "textPropertyArg", "valuePropertyArg" )

<option value="valueProp">textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

<option>0</option>
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
<option>object</option>
<option>MR.Logic.Controllers.HtmlHelperController+SampleClass</option>

CreateOptions(ICollection elems, String textProperty, String valueProperty, Object selectedValue) : String

Creates options elements from an System.Collections.ICollection

.

<option value="valueProp" selected>textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

Example

:

$HtmlHelper.CreateOptions( ICollection, "textPropertyArg", "valuePropertyArg", object )

<option value="valueProp" selected>textProp</option>
<option value="0">textProp2</option>
<option value="5">textProp3</option>

<option>0</option>
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
<option selected>object</option>
<option>MR.Logic.Controllers.HtmlHelperController+SampleClass</option>

BuildUnorderedList(ICollection elements) : String

Builds an unordered ul list from supplied System.Collections.ICollection

.

<ul>
<li>0</li>
...
<li>object</li>
</ul>

Example

:

$HtmlHelper.BuildUnorderedList( ICollection )

<ul>
<li>0</li>
<li>1</li>
<li>2</li>
<li>3</li>
<li>4</li>
<li>5</li>
<li>object</li>
</ul>

BuildUnorderedList(ICollection elements, String styleClass, String itemClass) : String

Builds an unordered ul list from supplied System.Collections.ICollection with ul and li

tags CSS class set to supplied attributes.

<ol class="styleClassArg">
<li class="itemClassArg">0</li>
...
<li class="itemClassArg">object</li>
</ol>

Example

:

$HtmlHelper.BuildUnorderedList( ICollection, "styleClassArg", "itemClassArg" )

<ol class="styleClassArg">
<li class="itemClassArg">0</li>
<li class="itemClassArg">1</li>
<li class="itemClassArg">2</li>
<li class="itemClassArg">3</li>
<li class="itemClassArg">4</li>
<li class="itemClassArg">5</li>
<li class="itemClassArg">object</li>
</ol>

BuildOrderedList(ICollection elements) : String

Builds an ordered ol list from supplied System.Collections.ICollection

.

<ol>
<li>0</li>
...
<li>object</li>
</ol>

Example

:

$HtmlHelper.BuildOrderedList( ICollection )

<ol>
<li>0</li>
<li>1</li>
<li>2</li>
<li>3</li>
<li>4</li>
<li>5</li>
<li>object</li>
</ol>

BuildOrderedList(ICollection elements, String styleClass, String itemClass) : String

Builds an ordered ol list from supplied System.Collections.ICollection with ol and li

tags CSS class set to supplied attributes.

<ol class="styleClassArg">
<li class="itemClassArg">0</li>
...
<li class="itemClassArg">object</li>
</ol>

Example

:

$HtmlHelper.BuildOrderedList( ICollection, "styleClassArg", "itemClassArg" )

<ol class="styleClassArg">
<li class="itemClassArg">0</li>
<li class="itemClassArg">1</li>
<li class="itemClassArg">2</li>
<li class="itemClassArg">3</li>
<li class="itemClassArg">4</li>
<li class="itemClassArg">5</li>
<li class="itemClassArg">object</li>
</ol>

Search WWW Search castleproject.org