The Message is a container to show a message to the user. You could do this using HTML without using the Message component, but the benefit of using the Message component is it delegates the HTML to the form template so you ensure conssitency across all forms. You can create a Message by using the <form-message> tag helper or instantiating a Message<TModel> within a using block.
The Message<TModel> class looks like this and is in the ChameleonForms.Component namespace:
/// <summary>
/// Wraps the output of a message to display to a user.
/// </summary>
/// <typeparam name="TModel">The view model type for the current view</typeparam>
public class Message<TModel> : FormComponent<TModel>
{
/// <summary>
/// Creates a message.
/// </summary>
/// <param name="form">The form the message is being created in</param>
/// <param name="messageType">The type of message to display</param>
/// <param name="heading">The heading for the message</param>
public Message(IForm<TModel> form, MessageType messageType, IHtmlContent heading);
/// <summary>
/// Creates a message.
/// </summary>
/// <param name="form">The form the message is being created in</param>
/// <param name="messageType">The type of message to display</param>
/// <param name="heading">The heading for the message</param>
public Message(IForm<TModel> form, MessageType messageType, string heading);
/// <summary>
/// Returns the HTML representation of the beginning of the form component.
/// </summary>
/// <returns>The beginning HTML for the form component</returns>
public virtual IHtmlContent Begin();
/// <summary>
/// Returns the HTML representation of the end of the form component.
/// </summary>
/// <returns>The ending HTML for the form component</returns>
public virtual IHtmlContent End();
/// <summary>
/// Creates the HTML for a paragraph in the message.
/// </summary>
/// <param name="paragraph">The paragraph to output</param>
/// <returns>The HTML for the paragraph</returns>
public virtual IHtmlContent Paragraph(string paragraph);
/// <summary>
/// Creates the HTML for a paragraph in the message.
/// </summary>
/// <param name="paragraph">The paragraph to output</param>
/// <returns>The HTML for the paragraph</returns>
public virtual IHtmlContent Paragraph(IHtmlContent paragraph);
/// <summary>
/// Creates the HTML for a paragraph in the message.
/// </summary>
/// <param name="paragraph">The paragraph to output as a templated razor delegate</param>
/// <returns>The HTML for the paragraph</returns>
public virtual IHtmlContent Paragraph(Func<dynamic, IHtmlContent> paragraph);The start and end HTML of the Message are generated via the BeginMessage and EndMessage methods in the form template and the paragraph is generated via the MessageParagraph method in the template.
<form-message type="Information" heading="Message title">
@* Message content *@
</form-message>In order to get an instance of a Message<TModel> you can use the BeginMessage extension method on the Form, e.g.:
@using (var m = form.BeginMessage(MessageType.Information, "Message title")) {
@* Message content *@
}The BeginMessage extension methods look like this:
/// <summary>
/// Creates a message.
/// </summary>
/// <example>
/// @using (var m = f.BeginMessage(MessageType.Success, "Your submission was successful")) {
/// @m.Paragraph(string.Format("Your item was successfully created with id {0}", Model.Id))
/// }
/// </example>
/// <typeparam name="TModel">The view model type for the current view</typeparam>
/// <param name="form">The form the message is being created in</param>
/// <param name="messageType">The type of message to display</param>
/// <param name="heading">The heading for the message</param>
/// <returns>The message</returns>
public static Message<TModel> BeginMessage<TModel>(this IForm<TModel> form, MessageType messageType, string heading = null)
{
return new Message<TModel>(form, messageType, heading);
}
/// <summary>
/// Creates a message.
/// </summary>
/// <example>
/// @using (var m = f.BeginMessage(MessageType.Success, new HtmlString("<strong>The submission was successful</strong>"))) {
/// @m.Paragraph(string.Format("Your item was successfully created with id {0}", Model.Id))
/// }
/// </example>
/// <typeparam name="TModel">The view model type for the current view</typeparam>
/// <param name="form">The form the message is being created in</param>
/// <param name="messageType">The type of message to display</param>
/// <param name="heading">The heading for the message</param>
/// <returns>The message</returns>
public static Message<TModel> BeginMessage<TModel>(this IForm<TModel> form, MessageType messageType, IHtmlContent heading)
{
return new Message<TModel>(form, messageType, heading);
}
/// <summary>
/// Creates a message.
/// </summary>
/// <example>
/// @using (var m = f.BeginMessage(MessageType.Success, new HtmlString(@<strong>The submission was successful</strong>))) {
/// @m.Paragraph(string.Format("Your item was successfully created with id {0}", Model.Id))
/// }
/// </example>
/// <typeparam name="TModel">The view model type for the current view</typeparam>
/// <param name="form">The form the message is being created in</param>
/// <param name="messageType">The type of message to display</param>
/// <param name="heading">The heading for the message as a templated razor delegate</param>
/// <returns>The message</returns>
public static Message<TModel> BeginMessage<TModel>(this IForm<TModel> form, MessageType messageType, Func<dynamic, IHtmlContent> heading)
{
return new Message<TModel>(form, messageType, heading(null));
}The MessageType enum is defined like this and appears in the ChameleonForms.Enums namespace:
/// <summary>
/// Types of messages that can be displayed to the user
/// </summary>
public enum MessageType
{
/// <summary>
/// User action required.
/// </summary>
Action,
/// <summary>
/// Action successful.
/// </summary>
Success,
/// <summary>
/// Action failed.
/// </summary>
Failure,
/// <summary>
/// Informational message.
/// </summary>
Information,
/// <summary>
/// Warning message.
/// </summary>
Warning
}When setting the type attribute in the <form-message> tag helper you can reference any of these MessageType values.
If you want to add paragraphs using the template you can do that by using the <message-paragraph> tag helper and of course you can use normal HTML or any valid Razor code as well:
<form-message type="Information" heading="Message title">
<message-paragraph>Here is the first part of the message</message-paragraph>
<img src="/path/to/img" alt="alt text" />
<message-paragraph>Here is a <strong>styled</strong> message</message-paragraph>
@SomeRazorFunctionDefinedOnThisPage()
<partial name="_WooWeCanGetReallyCrazyAndAddPartialsToo_OMG"></partial>
</form-message>If you want to add paragraphs using the template you can do that by using one of the Paragraph methods as defined above and of course you can use normal HTML or any valid Razor code as well:
@using (var m = f.BeginMessage(MessageType.Information, "Message title")) {
@m.Paragraph("Here is the first part of the message")
<img src="/path/to/img" alt="alt text" />
@m.Paragraph(new HtmlString("Here is a <strong>styled</strong> message"))
@SomeRazorFunctionDefinedOnThisPage()
<partial name="_WooWeCanGetReallyCrazyAndAddPartialsToo_OMG"></partial>
@m.Paragraph(@<strong>Message content</strong>)
} <div class="%messagetype%_message">
%if heading%<h3>%heading%</h3>%endif%
<div class="message"> </div>
</div><p>%content%</p> <div class="panel panel-%messageType.ToTwitterEmphasisStyle()%">
%if heading%<div class="panel-heading"><h4 class="panel-title">%heading%</h4></div>%endif%
<div class="panel-body">The ToTwitterEmphasisStyle extension method performs the following conversions from the ChameleonForms message types to the Twitter Emphasis Styles:
ActionbecomesPrimarySuccessbecomesSuccessFailurebecomesDangerInformationbecomesInfoWarningbecomesWarning- Anything else becomes
Default
</div>
</div>Same as default.