Table of contents
MonoRail Helpers
Helpers are associated with a controller and made available to be used on the view. They are usually used to reuse some generation code.
Creating a custom helper
A helper is just an ordinary class. It might optionally extend AbstractHelper in order to have access to the controller instance and some utility methods. For example:
public class MyHelper { public String BuildUserLink(User user) { return String.Format("<a href='/users/showuser.rails?id={0}'>{1}</a>", user.Id, user.Name); } }
The helper must be associate with the controller whose views might use it. This is done using the HelperAttribute:
using Castle.MonoRail.Framework; [Helper(typeof(MyHelper))] public class MemberController : Controller { public void List() { PropertyBag.Add("users", ObtainUsers()); } }
Now it is just a matter of using the helper by its name:
Builtin Helpers documentation
-
MonoRail Helpers
- Creating a custom helper
- Builtin Helpers documentation
-
AjaxHelper
- Common parameters
- Using it
- Examples
- API documentation
-
AjaxHelper API Document
- Constructors
-
Methods
- Service(IServiceProvider provider)
- InstallScripts() : String
- GetBehaviourFunctions() : String
- ReApply() : String
- AddLoadEvent(String loadFunctionName) : String
- StartBehaviourRegister() : String
- Register(String selector, String eventName, String jsFunctionName) : String
- EndBehaviourRegister() : String
- GenerateJSProxy(String proxyName) : String
- GenerateJSProxy(String proxyName, String controller) : String
- GenerateJSProxy(String proxyName, String area, String controller) : String
- LinkToFunction(String innerContent, String functionCodeOrName, IDictionary attributes) : String
- LinkToFunction(String innerContent, String functionCodeOrName) : String
- ButtonToFunction(String innerContent, String functionCodeOrName, IDictionary attributes) : String
- ButtonToFunction(String innerContent, String functionCodeOrName) : String
- ButtonToRemote(String innerContent, String url, IDictionary options) : String
- ButtonToRemote(String innerContent, String url, IDictionary options, IDictionary htmloptions) : String
- LinkToRemote(String innerContent, String url, IDictionary options) : String
- LinkToRemote(String innerContent, String url, IDictionary options, IDictionary htmloptions) : String
- BuildFormRemoteTag(String url, IDictionary options) : String
- BuildFormRemoteTag(IDictionary options) : String
- ObserveField(String fieldId, Int32 frequency, String url, String idOfElementToBeUpdated, String with) : String
- ObserveField(String fieldId, Int32 frequency, String url, IDictionary options) : String
- ObserveField(IDictionary options) : String
- ObserveForm(String formId, Int32 frequency, String url, String idOfElementToBeUpdated, String with) : String
- ObserveForm(String formId, IDictionary options) : String
- ObserveForm(IDictionary options) : String
- PeriodicallyCallRemote(IDictionary options) : String
- PeriodicallyCallRemote(String url, IDictionary options) : String
- InputTextWithAutoCompletion(IDictionary options, IDictionary tagAttributes) : String
- InputTextWithAutoCompletion(String inputName, String url, IDictionary tagAttributes, IDictionary completionOptions) : String
- AutoCompleteInputText(String elementId, String url, IDictionary options) : String
- BuildRemoteFunction(String url, IDictionary options) : String
- RemoteFunction(IDictionary options) : String
- BuildAjaxOptions(IDictionary jsOptions, IDictionary options) : String
- BuildCallbackFunction(CallbackEnum callback, String code, String name) : String
- BuildObserver(String clazz, String name, IDictionary options) : String
- GetOptions(String url, IDictionary options) : IDictionary
- GetOptions(String url, String idOfElementToBeUpdated, String with, String loading, String loaded, String complete, String interactive) : IDictionary
-
Using Behaviour
- Javascript Action Proxies
- LinkToFunction and ButtonToFunction
- LinkToRemote and ButtonToRemote
- Remote Form
- Observers
- Periodical updates
- Auto completion
- DateFormatHelper
-
Effects2Helper
- API documentation
-
Effects2Helper API Document
- Constructors
-
Methods
- InstallScripts() : String
- Appear(String elementId) : String
- Fade(String elementId) : String
- Puff(String elementId) : String
- DropOut(String elementId) : String
- Shake(String elementId) : String
- SwitchOff(String elementId) : String
- BlindUp(String elementId) : String
- BlindDown(String elementId) : String
- SlideUp(String elementId) : String
- SlideDown(String elementId) : String
-
FormHelper
- General concept
- Getting started
- API documentation
- How FormHelper works with sets
- Generating selects
- CheckboxList
-
FormHelper API Document
- Constructors
-
Methods
- TextFieldValue(String target, Object value) : String
- TextFieldValue(String target, Object value, IDictionary attributes) : String
- TextField(String target) : String
- TextField(String target, IDictionary attributes) : String
- TextArea(String target) : String
- TextArea(String target, IDictionary attributes) : String
- PasswordField(String target) : String
- PasswordField(String target, IDictionary attributes) : String
- TextFieldFormat(String target, String formatString) : String
- TextFieldFormat(String target, String formatString, IDictionary attributes) : String
- LabelFor(String target, String label) : String
- LabelFor(String target, String label, IDictionary attributes) : String
- HiddenField(String target) : String
- HiddenField(String target, IDictionary attributes) : String
- CreateCheckboxList(String target, IEnumerable dataSource) : CheckboxList
- CreateCheckboxList(String target, IEnumerable dataSource, IDictionary attributes) : CheckboxList
- CheckboxField(String target) : String
- CheckboxField(String target, IDictionary attributes) : String
- RadioField(String target, Object valueToSend) : String
- RadioField(String target, Object valueToSend, IDictionary attributes) : String
- Select(String target, IEnumerable dataSource) : String
- Select(String target, IEnumerable dataSource, IDictionary attributes) : String
- Select(String target, Object selectedValue, IEnumerable dataSource, IDictionary attributes) : String
- CreateInputElement(String type, String target, Object value, IDictionary attributes) : String
- CreateInputElement(String type, String id, String target, String value, IDictionary attributes) : String
- ObtainValue(String target) : Object
- ObtainValue(RequestContext context, String target) : Object
- QueryPropertyRecursive(Object rootInstance, String[] propertyPath, Int32 piece) : Object
- ObtainRootInstance(RequestContext context, String target) : Object
- CreateHtmlId(IDictionary attributes, String target) : String
- CreateHtmlId(IDictionary attributes, String target, Boolean removeEntry) : String
- ObtainEntry(IDictionary attributes, String key) : String
- ObtainEntryAndRemove(IDictionary attributes, String key, String defaultValue) : String
- ObtainEntryAndRemove(IDictionary attributes, String key) : String
- IsPresent(Object value, Object initialSetValue, PropertyInfo propertyOnInitialSet, Boolean isMultiple) : Boolean
- GetMethod(Object elem, String property) : PropertyInfo
- GetMethod(Type type, String property) : PropertyInfo
-
HtmlHelper
- API documentation
-
HtmlHelper API Document
- Constructors
-
Methods
-
FieldSet(String legend)
: String
-
EndFieldSet()
: String
-
Form(String action)
: String
-
Form(String action, String id, String method)
: String
-
Form(String action, String id, String method, String onSubmit)
: String
- Form(String action, IDictionary attributes) : String
-
EndForm()
: String
-
Link(String target, String linkText)
: String
-
Link(String target, String linkText, IDictionary attributes)
: String
-
LinkTo(String name, String action)
: String
-
LinkTo(String name, String controller, String action)
: String
-
LinkTo(String name, String controller, String action, Object id)
: String
-
LinkToAttributed(String name, String controller, String action, IDictionary attributes)
: String
-
LinkToAttributed(String name, String controller, String action, Object id, IDictionary attributes)
: String
-
MapToVirtual(String target)
: String
-
LabelFor(String forId, String label)
: String
-
LabelFor(String forId, String label, IDictionary attributes)
: String
-
DateTime(String name, DateTime value)
: String
-
DateTime(String name, DateTime value, IDictionary attributes)
: String
-
TextArea(String name, Int32 cols, Int32 rows, String value)
: String
-
InputButton(String value)
: String
- InputButton(String name, String value) : String
- InputButton(String name, String value, IDictionary attributes) : String
- InputCheckbox(String name, Object value) : String
- InputCheckbox(String name, Object value, Boolean isChecked) : String
- InputCheckbox(String name, Object value, IDictionary attributes) : String
- InputRadio(String name, Object value) : String
- InputRadio(String name, Object value, IDictionary attributes) : String
- InputFile(String name) : String
- InputFile(String name, IDictionary attributes) : String
-
InputText(String name, String value)
: String
-
InputText(String name, String value, Int32 size, Int32 maxlength)
: String
-
InputText(String name, String value, Int32 size, Int32 maxlength, IDictionary attributes)
: String
-
InputText(String name, String value, String id)
: String
- InputText(String name, String value, IDictionary attributes) : String
- InputPassword(String name) : String
- InputPassword(String name, String value) : String
- InputPassword(String name, String value, IDictionary attributes) : String
-
InputHidden(String name, String value)
: String
-
InputHidden(String name, Object value)
: String
-
SubmitButton(String value)
: String
-
SubmitButton(String value, IDictionary attributes)
: String
-
Select(String name)
: String
-
Select(String name, IDictionary attributes)
: String
-
EndSelect()
: String
- OptionGroup(String label) : String
- EndOptionGroup() : String
- CreateOption(String text, Object value) : String
- CreateOption(String text, Object value, IDictionary htmlAttributes) : String
-
CreateOptionsFromPrimitiveArray(Array elems, String selected)
: String
-
CreateOptionsFromArray(Array elems, String textProperty, String valueProperty)
: String
-
CreateOptionsFromArray(Array elems, String textProperty, String valueProperty, Object selectedValue)
: String
-
CreateOptions(ICollection elems, String textProperty, String valueProperty)
: String
-
CreateOptions(ICollection elems, String textProperty, String valueProperty, Object selectedValue)
: String
-
BuildUnorderedList(ICollection elements)
: String
-
BuildUnorderedList(ICollection elements, String styleClass, String itemClass)
: String
-
BuildOrderedList(ICollection elements)
: String
-
BuildOrderedList(ICollection elements, String styleClass, String itemClass)
: String
-
FieldSet(String legend)
: String
-
WizardHelper API Document
- Constructors
- Properties
-
Methods
- HasNextStep() : Boolean
- HasPreviousStep() : Boolean
- LinkToStep(String linkText, WizardStepPage step) : String
- LinkToStep(String linkText, WizardStepPage step, Object id) : String
- LinkToStep(String linkText, WizardStepPage step, Object id, IDictionary attributes) : String
- LinkToNext(String linkText) : String
- LinkToNext(String linkText, IDictionary attributes) : String
- LinkToNext(String linkText, Object id) : String
- LinkToNext(String linkText, Object id, IDictionary attributes) : String
- LinkToPrevious(String linkText) : String
- LinkToPrevious(String linkText, IDictionary attributes) : String
- LinkToPrevious(String linkText, Object id) : String
- LinkToPrevious(String linkText, Object id, IDictionary attributes) : String
-
PaginationHelper
- Example
- Cached Pagination
- API documentation
-
PaginationHelper API Document
- Constructors
-
Methods
- CreatePageLink(Int32 page, String text) : String
- CreatePageLink(Int32 page, String text, IDictionary htmlAttributes) : String
- CreatePageLink(Int32 page, String text, IDictionary htmlAttributes, IDictionary queryStringParams) : String
- CreatePagination(IList datasource, Int32 pageSize) : IPaginatedPage
- CreatePagination(IList datasource, Int32 pageSize, Int32 currentPage) : IPaginatedPage
- CreateCachedPagination(String cacheKey, Int32 pageSize, DataObtentionDelegate dataObtentionCallback) : IPaginatedPage
- TextHelper
- UrlHelper
-
ValidationHelper
- Example
- API documentation
-
ValidationHelper API Document
- Constructors
- Properties
-
Methods
- BuildScriptInclude(String baseDir, String js, String extension) : String
- SetSubmitOptions(IDictionary parameters)
- SetSubmitOptions(Boolean confirm, Boolean disable, Boolean groupError, Int32 errorMode)
- InstallScripts() : String
- InstallWithCustomMsg(String scriptFilePath) : String
- InstallScripts(String baseDir) : String
- InstallScripts(String baseDir, String lang) : String
- GetValidationTriggerFunction() : String
- GetValidationTriggerFunction(String formElement) : String
- GetValidationTriggerFunction(String formElement, IDictionary options) : String
-
WizardHelper
- API documentation
-
WizardHelper API Document
- Constructors
- Properties
-
Methods
- HasNextStep() : Boolean
- HasPreviousStep() : Boolean
- LinkToStep(String linkText, WizardStepPage step) : String
- LinkToStep(String linkText, WizardStepPage step, Object id) : String
- LinkToStep(String linkText, WizardStepPage step, Object id, IDictionary attributes) : String
- LinkToNext(String linkText) : String
- LinkToNext(String linkText, IDictionary attributes) : String
- LinkToNext(String linkText, Object id) : String
- LinkToNext(String linkText, Object id, IDictionary attributes) : String
- LinkToPrevious(String linkText) : String
- LinkToPrevious(String linkText, IDictionary attributes) : String
- LinkToPrevious(String linkText, Object id) : String
- LinkToPrevious(String linkText, Object id, IDictionary attributes) : String