ASPxClientLoadingPanel.SetText(text) Method

Sets the text to be displayed within the ASPxLoadingPanel.

Declaration

SetText(
    text: string
): void

Parameters

Name	Type	Description
text	string	A string value specifying the text to be displayed within the ASPxLoadingPanel.

Remarks

Use the SetText method on the client side to specify the text to be displayed within the ASPxLoadingPanel. The client ASPxClientLoadingPanel.GetText method can be used to obtain the text displayed within the control.

Note

The SetText method does not HTML encode the specified text.

Example

This example demonstrates how the client SetText method can be used to dynamically change the text displayed by the loading panel.

View Example

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>

<%@ Register Assembly="DevExpress.Web.v9.1" Namespace="DevExpress.Web.ASPxCallback" TagPrefix="dxcb" %>
<%@ Register Assembly="DevExpress.Web.v9.1" Namespace="DevExpress.Web.ASPxLoadingPanel" TagPrefix="dxlp" %>
<%@ Register Assembly="DevExpress.Web.ASPxEditors.v9.1" Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dxe" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>How to change the ASPxLoadingPanel's text on the client</title>

    <script type="text/javascript">
        function SendCallback(s,e) {
            clientCallback.PerformCallback();
            clientLoadingPanel.SetText(s.name);
            clientLoadingPanel.Show(); 
        }
    </script>

</head>
<body>
    <form id="form1" runat="server">
        <dxcb:aspxcallback id="ASPxCallback1" runat="server" clientinstancename="clientCallback">
            <ClientSideEvents CallbackComplete="function(s, e) { clientLoadingPanel.Hide(); }" />
        </dxcb:aspxcallback>
        <div style="float: left;margin-right: 10px;">
            <dxe:ASPxButton ID="Text1" runat="server" Text="Show Text1" AutoPostBack="False">
                <ClientSideEvents Click="SendCallback" />
            </dxe:ASPxButton>
        </div>
        <div>
            <dxe:ASPxButton ID="Text2" runat="server" Text="Show Text2" AutoPostBack="False">
                <ClientSideEvents Click="SendCallback" />
            </dxe:ASPxButton>
        </div>
        <dxlp:ASPxLoadingPanel ID="loadingPanel" ClientInstanceName="clientLoadingPanel" runat="server" />
    </form>
</body>
</html>

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class _Default : System.Web.UI.Page {
    protected void Page_Load(object sender, EventArgs e) {
        if(IsCallback)
            System.Threading.Thread.Sleep(1000);
    }
}

Imports Microsoft.VisualBasic
Imports System
Imports System.Data
Imports System.Configuration
Imports System.Collections
Imports System.Web
Imports System.Web.Security
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

Partial Public Class _Default
    Inherits System.Web.UI.Page
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        If IsCallback Then
            System.Threading.Thread.Sleep(1000)
        End If
    End Sub
End Class

<%@ Page Language="vb" AutoEventWireup="true" CodeFile="Default.aspx.vb" Inherits="_Default" %>

<%@ Register Assembly="DevExpress.Web.v9.1" Namespace="DevExpress.Web.ASPxCallback" TagPrefix="dxcb" %>
<%@ Register Assembly="DevExpress.Web.v9.1" Namespace="DevExpress.Web.ASPxLoadingPanel" TagPrefix="dxlp" %>
<%@ Register Assembly="DevExpress.Web.ASPxEditors.v9.1" Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dxe" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>How to change the ASPxLoadingPanel's text on the client</title>

    <script type="text/javascript">
        function SendCallback(s,e) {
            clientCallback.PerformCallback();
            clientLoadingPanel.SetText(s.name);
            clientLoadingPanel.Show(); 
        }
    </script>

</head>
<body>
    <form id="form1" runat="server">
        <dxcb:aspxcallback id="ASPxCallback1" runat="server" clientinstancename="clientCallback">
            <ClientSideEvents CallbackComplete="function(s, e) { clientLoadingPanel.Hide(); }" />
        </dxcb:aspxcallback>
        <div style="float: left;margin-right: 10px;">
            <dxe:ASPxButton ID="Text1" runat="server" Text="Show Text1" AutoPostBack="False">
                <ClientSideEvents Click="SendCallback" />
            </dxe:ASPxButton>
        </div>
        <div>
            <dxe:ASPxButton ID="Text2" runat="server" Text="Show Text2" AutoPostBack="False">
                <ClientSideEvents Click="SendCallback" />
            </dxe:ASPxButton>
        </div>
        <dxlp:ASPxLoadingPanel ID="loadingPanel" ClientInstanceName="clientLoadingPanel" runat="server" />
    </form>
</body>
</html>

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ASPxClientLoadingPanel.SetText(text) Method

Declaration

Parameters

Remarks

Example