RenderHelper Class

Exposes static helper methods that create and set up ASP.NET Web Forms controls.

Namespace: DevExpress.ExpressApp.Web

Assembly: DevExpress.ExpressApp.Web.v22.1.dll

Declaration

C#

public static class RenderHelper

VB.NET

Public Module RenderHelper

Remarks

The RenderHelper is an auxiliary class. It exposes static helper methods that instantiate ASP.NET Web Forms controls. These methods ensure that the created controls are properly set up to maintain a consistent visual style in an XAF ASP.NET Web Forms application’s UI. Use the following static methods to instantiate ASP.NET Web Forms controls in your applications:

The Required Control	The Static Method That Creates and Sets Up the Control
ASPxButton	RenderHelper.CreateASPxButton
ASPxCheckBox	RenderHelper.CreateASPxCheckBox
ASPxComboBox	RenderHelper.CreateASPxComboBox
ASPxDateEdit	RenderHelper.CreateASPxDateEdit
ASPxHyperlink	RenderHelper.CreateASPxHyperLink
ASPxImage	RenderHelper.CreateASPxImage
ASPxLabel	RenderHelper.CreateASPxLabel
ASPxMemo	RenderHelper.CreateASPxMemo
ASPxMenu	RenderHelper.CreateASPxMenu
ASPxNavBar	RenderHelper.CreateASPxNavBar
ASPxPageControl	RenderHelper.CreateASPxPageControl
ASPxPopupMenu	RenderHelper.CreateASPxPopupMenu
ASPxRoundPanel	RenderHelper.CreateASPxRoundPanel
ASPxSpinEdit	RenderHelper.CreateASPxSpinEdit
ASPxTextBox	RenderHelper.CreateASPxTextBox
TableEx	RenderHelper.CreateTable

Whenever you need to instantiate an ASP.NET Web Forms control, instead of manual instantiation use the static RenderHelper‘s methods.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RenderHelper class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application-e4357/CS/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.cs#L166

protected string GetForceButtonClickScript() {
    return string.Format("function(s, e) {{ {0}(e, '{1}'); }}", RenderHelper.GetForceButtonClickFunctionName(), _button.ClientID);
}

XAF_how-to-use-custom-aspxgridview-template-in-a-web-xaf-application-e1671/CS/WebExample.Web/Global.asax.cs#L20

protected void Application_Start(object sender, EventArgs e) {
    RenderHelper.RenderMode = DevExpress.Web.ControlRenderMode.Lightweight;
    ASPxWebControl.CallbackError += new EventHandler(Application_Error);

XAF_how-to-enable-in-place-editing-in-the-aspnet-tree-list-view-aspxtreelisteditor-e3570/CS/WebExample.Module.Web/TreeListInlineEditController.cs#L46

if (control != null) {
    control.Attributes["onclick"] = RenderHelper.EventCancelBubbleCommand;
}

VB.NET

XAF_how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application-e4357/VB/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.vb#L182

Protected Function GetForceButtonClickScript() As String
    Return String.Format("function(s, e) {{ {0}(e, '{1}'); }}", RenderHelper.GetForceButtonClickFunctionName(), _button.ClientID)
End Function

XAF_how-to-use-custom-aspxgridview-template-in-a-web-xaf-application-e1671/VB/WebExample.Web/Global.asax.vb#L22

Protected Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    RenderHelper.RenderMode = DevExpress.Web.ControlRenderMode.Lightweight
    AddHandler ASPxWebControl.CallbackError, AddressOf Application_Error

XAF_how-to-enable-in-place-editing-in-the-aspnet-tree-list-view-aspxtreelisteditor-e3570/VB/WebExample.Module.Web/TreeListInlineEditController.vb#L48

If control IsNot Nothing Then
    control.Attributes("onclick") = RenderHelper.EventCancelBubbleCommand
End If

Inheritance

Object

RenderHelper