AspxPage Class Reference

Overview

The AspxPage class is a static helper class that provides utility methods for working with Magentrix MVC controllers. It encapsulates common operations such as parameter retrieval, message handling, error management, reference information extraction, and cookie manipulation.

Methods Summary

Methods

GetParameter

Retrieves a parameter value from either the request query string/form data or route data.

Signature

public string GetParameter(string name)

Parameters

Returns

• Type:string
• Description: The parameter value if found; otherwise, null

Example

var userId = AspxPage.GetParameter("userId");

if (!string.IsNullOrEmpty(userId))
{
    // Process the user ID
}

AddMessage (Summary Only)

Adds an informational message to the view messages collection.

Signature

public void AddMessage(string summary)

Parameters

Example

AspxPage.AddMessage("Operation completed successfully.");

AddWarning

Adds a warning message to the view messages collection.

Signature

public void AddWarning(string summary)

Parameters

Example

AspxPage.AddWarning("This action cannot be undone.");

AddMessage (Full)

Adds a custom message with a specified title and message type to the view messages collection.

Signature

public void AddMessage(string title, string summary, MessageType type)

Parameters

Example

AspxPage.AddMessage("Success", "Record saved successfully.", MessageType.Message);
AspxPage.AddMessage("Alert", "Please review the changes.", MessageType.Warning);

AddError (With Property Name)

Adds a validation error to the model state, optionally associated with a specific property.

Signature

public void AddError(string summary, string propertyName = null)

Parameters

Example

// Property-specific error
AspxPage.AddError("Email address is required", "Email");

// Model-level error
AspxPage.AddError("An unexpected error occurred");

AddError (From Exception)

Adds error information to the model state from an exception object.

Signature

public void AddError(Exception ex)

Parameters

Example

try
{
    // Perform operation
}
catch (Exception ex)
{
    AspxPage.AddError(ex);
}

SetCookie

Adds a cookie to the HTTP response.

Signature

public void SetCookie(System.Web.HttpCookie cookie)

Parameters

Exceptions

Example

var cookie = new HttpCookie("UserPreference")
{
    Value = "darkMode",
    Expires = DateTime.Now.AddDays(30)
};
AspxPage.SetCookie(cookie);

GetCookie

Retrieves a cookie from the HTTP request.

Signature

public System.Web.HttpCookie GetCookie(string name)

Parameters

Returns

• Type:HttpCookie
• Description: The requested cookie if found; otherwise, null

Exceptions

Example

var userPrefCookie = AspxPage.GetCookie("UserPreference");
var userPreference = userPrefCookie?.Value;

RemoveCookie

Removes a cookie from the client by setting its expiration date to the past.

Signature

public void RemoveCookie(string name)

Parameters

Exceptions

Behavior

Calls the AspxPage.RemoveCookie() helper method to expire the cookie.

Example

AspxPage.RemoveCookie("UserPreference");

Usage Notes

Message Handling

The class provides three methods for adding messages to the view:

• AddMessage(string summary) — For informational messages
• AddWarning(string summary) — For warning messages
• AddMessage(string title, string summary, MessageType type) — For custom messages

All messages are stored in the controller's ViewMessages collection and can be rendered in the view.

Error Handling

The class provides flexible error handling:

• Property-specific errors using AddError(string summary, string propertyName)
• General model errors using AddError(string summary)
• Exception-based errors using AddError(Exception ex)

Errors are added to the ASP.NET MVC ModelState for validation feedback.

Cookie Security

All cookie methods (SetCookie, GetCookie, RemoveCookie) include built-in protection against manipulating the Forms Authentication cookie, ensuring that authentication security is maintained.

Dependencies

• AspxController — The controller instance that provides access to request, response, routing, and model state

See Also

• Controllers Overview