Общие сведения о классе PageRequestManager ASP.NET

Visual Studio 2010

Обновлен: Ноябрь 2007

Класс PageRequestManager в Microsoft AJAX (библиотека) управляет частичным обновлением страниц в обозревателе. Если на странице содержится элемент управления ScriptManager и один или несколько элементов управления UpdatePanel, для страницы автоматически включается функция частичной отрисовки. Класс PageRequestManager предоставляет свойства, методы и события, которые позволяют настраивать частичные обновления страниц при помощи клиентского сценария. Класс PageRequestManager предоставляет модель события клиентской страницы, которую можно использовать так же, как модель события серверной страницы.

В этом разделе рассматриваются следующие темы:

Можно включить функцию частичного обновления страницы с помощью веб-серверных элементов управления ScriptManager и UpdatePanel. Частичные обновления страницы не требуют клиентского сценария. Тем не менее, можно использовать класс PageRequestManager и клиентский сценарий, если необходимо следующее:

  • Управление обработкой нескольких асинхронных обратных передач. Поведением по умолчанию задано, что последняя обратная передача имеет приоритет. Класс PageRequestManager позволяет отдавать приоритет отдельным обратным передачам и отменять остальные, которые имеют более низкий приоритет.

  • Предоставление визуальных подсказок или иных уведомлений, с помощью которых помечаются области страницы, для которых было выполнено обновление, либо созданные в результате последней асинхронной передачи. Таким образом можно оптимизировать работу пользователей, особенно в том, что касается сценариев с использованием нескольких элементов управления UpdatePanel.

  • Отображение сообщений о состоянии во время асинхронных передач. Если выполнение обратной передачи занимает длительное время, возможно, потребуется отображать индикатор хода выполнения, например, в виде анимированного изображения. Можно также предоставить пользователю возможность отменить обратную передачу.

  • Обеспечение настраиваемой обработки сообщений об ошибке для частичного обновления страниц. При возникновении непредвиденной ошибки во время асинхронной обратной передачи можно обработать ошибку с помощью клиентского сценария.

  • Доступ к соответствующему запросу и объектам ответов, используемым для асинхронной обратной передачи.

Функциональные возможности частичного обновления страниц в Microsoft AJAX (библиотека) включают в себя:

  • События жизненного цикла клиентской страницы, возникающие в ключевые моменты в ходе частичного обновления страницы.

  • Сведения об элементах управления UpdatePanel, которые были удалены, обновлены или созданы во время асинхронной обратной передачи.

  • Свойства и методы, позволяющие в клиентском сценарии определить, обрабатывает ли страница асинхронную обратную передачу. Также можно использовать данные методы, чтобы остановить текущую асинхронную обратную передачу, либо отменить новые обратные передачи.

  • Сведения о данных сервера, отправляемые в элементы управления, которые не участвуют в частичных обновлениях страниц.

Во время частичного обновления страницы, инициализированного асинхронной обратной передачей, класс PageRequestManager координирует инкрементное обновление содержимого страниц в обозревателе. Серверный элемент управления UpdatePanel и клиентский класс PageRequestManager в значительной мере скрывают сложность частичного обновления страниц. При использовании клиентского сценария и членов класса PageRequestManager можно настроить поведение частичного обновления страниц в обозревателе.

Обработка событий частичного обновления страниц

Во время обработки страницей обратной передачи и асинхронной обратной передачи можно обрабатывать события объектной модели документа обозревателя (DOM) таким образом, чтобы запустить настраиваемый сценарий. Например, можно запустить сценарий, когда обозреватель загружает или выгружает страницу.

Тем не менее, события объектной модели документа не позволяют ни получить доступ ко всем значимым сведениям, ни управлять поведением во время асинхронной обратной передачи и в ходе частичных обновлений страниц. Таким образом, класс PageRequestManager предоставляет следующие события, которые позволяют настраивать частичные обновления страниц:

Дополнительные сведения об этих событиях см. в разделе Работа с событиями класса PageRequestManager.

В следующем примере демонстрируется использование события PageLoaded класса PageRequestManager для анимации элемента управления UpdatePanel при обновлении страницы после выполнения асинхронной обратной передачи. В данном примере пользователь может выбирать дату и вводить адрес электронной почты в форму для создания запроса билета. При выполнении асинхронной обратной передачи (вызванной при помощи ссылок вне элемента управления UpdatePanel) для панели выполняется анимация, чтобы уведомить пользователя о том, что в текстовое поле было введено значение данных. Страница содержит всплывающее окно, которое отображает элемент управления Calendar. Календарь отображается или скрывается с помощью свойства Visible элемента управления. Нет необходимости обновлять целую страницу при отображении или скрытии календаря, либо при выборе данных, поскольку элемент управления Calendar находится внутри элемента управления UpdatePanel.


<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
    protected void ChosenDate_TextChanged(object sender, EventArgs e)
    {
        DateTime dt = new DateTime();
        DateTime.TryParse(ChosenDate.Text, out dt);

        CalendarPicker.SelectedDate = dt;
        CalendarPicker.VisibleDate = dt;
    }
    protected void Close_Click(object sender, EventArgs e)
    {
        SetDateSelectionAndVisible();
    }

    protected void ShowDatePickerPopOut_Click(object sender, ImageClickEventArgs e)
    {
        DatePickerPopOut.Visible = !DatePickerPopOut.Visible;
    }

    protected void CalendarPicker_SelectionChanged(object sender, EventArgs e)
    {
        SetDateSelectionAndVisible();
    }

    private void SetDateSelectionAndVisible()
    {
        if (CalendarPicker.SelectedDates.Count != 0)
            ChosenDate.Text = CalendarPicker.SelectedDate.ToShortDateString();
        DatePickerPopOut.Visible = false;
    }

    protected void SubmitButton_Click(object sender, EventArgs e)
    {
        if (Page.IsValid)
        {
            MessageLabel.Text = "An email with availability was sent.";
        }
        else
        {
            MessageLabel.Text = "";
        }
    }

    protected void Page_Load(object sender, EventArgs e)
    {
        CompareValidatorDate.ValueToCompare = DateTime.Today.ToShortDateString();
        ExtraShow1.Text = DateTime.Today.AddDays(10.0).ToShortDateString();
        ExtraShow2.Text = DateTime.Today.AddDays(11.0).ToShortDateString();
    }

    protected void ExtraShow_Click(object sender, EventArgs e)
    {
        ChosenDate.Text = ((LinkButton)sender).Text;
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>Calendar Example</title>
    <style type="text/css">
        body {
            font-family: Tahoma;
        }
        .PopUpCalendarStyle
        {
              background-color:lightblue;
              position:absolute;
              visibility:show;
              margin: 15px 0px 0px 10px;
              z-index:99;   
              border: solid 2px black;
        }
        .UpdatePanelContainer
        {
            width: 260px;
            height:110px;
        }

    </style>
</head>
<body>
    <form id="form1" runat="server">
        <asp:ScriptManager ID="ScriptManager1" runat="server" />
        <script type="text/javascript">
        Type.registerNamespace("ScriptLibrary");
        ScriptLibrary.BorderAnimation = function(color, duration) {
            this._color = color;
            this._duration = duration;
        }
        ScriptLibrary.BorderAnimation.prototype = {
            animatePanel: function(panelElement) {
                var s = panelElement.style;
                s.borderWidth = '1px';
                s.borderColor = this._color;
                s.borderStyle = 'solid';
                window.setTimeout(
                    function() {{ s.borderWidth = 0; }},
                    this._duration
                );
            }
        }
        ScriptLibrary.BorderAnimation.registerClass('ScriptLibrary.BorderAnimation', null);

        var panelUpdatedAnimation = new ScriptLibrary.BorderAnimation('blue', 1000);
        var postbackElement;
        Sys.WebForms.PageRequestManager.getInstance().add_beginRequest(beginRequest);
        Sys.WebForms.PageRequestManager.getInstance().add_pageLoaded(pageLoaded);

        function beginRequest(sender, args) {
            postbackElement = args.get_postBackElement();
        }
        function pageLoaded(sender, args) {
            var updatedPanels = args.get_panelsUpdated();
            if (typeof(postbackElement) === "undefined") {
                return;
            } 
            else if (postbackElement.id.toLowerCase().indexOf('extrashow') > -1) {
                for (i=0; i < updatedPanels.length; i++) {            
                    panelUpdatedAnimation.animatePanel(updatedPanels[i]);
                }
            }

        }
        </script>
        <h1>Tickets</h1>
        <p>
            <strong>Latest News</strong> Due to overwhelming response, we
            have added two extra shows on:
            <asp:LinkButton ID="ExtraShow1" runat="server" OnClick="ExtraShow_Click" />
            and
            <asp:LinkButton ID="ExtraShow2" runat="server" OnClick="ExtraShow_Click" />.
            Don't forget curtain time is at 7:00pm sharp. No late arrivals.
        </p>
        <hr />
        <div class="UpdatePanelContainer">
            <asp:UpdatePanel runat="server" ID="UpdatePanel1" UpdateMode="Conditional">
                <Triggers>
                    <asp:AsyncPostBackTrigger ControlID="ExtraShow1" />
                    <asp:AsyncPostBackTrigger ControlID="ExtraShow2" />
                </Triggers>
                <ContentTemplate>
                    <fieldset>
                        <legend>Check Ticket Availability</legend>Date
                        <asp:TextBox runat="server" ID="ChosenDate" OnTextChanged="ChosenDate_TextChanged" />
                        <asp:ImageButton runat="server" ID="ShowDatePickerPopOut" OnClick="ShowDatePickerPopOut_Click"
                            ImageUrl="../images/calendar.gif" AlternateText="Choose a date."
                            Height="20px" Width="20px" />
                        <asp:Panel ID="DatePickerPopOut" CssClass="PopUpCalendarStyle"
                            Visible="false" runat="server">
                            <asp:Calendar ID="CalendarPicker" runat="server" OnSelectionChanged="CalendarPicker_SelectionChanged">
                            </asp:Calendar>
                            <br />
                            <asp:LinkButton ID="CloseDatePickerPopOut" runat="server" Font-Size="small"
                                OnClick="Close_Click" ToolTip="Close Pop out">
                            Close
                            </asp:LinkButton>
                        </asp:Panel>
                        <br />
                        Email
                        <asp:TextBox runat="server" ID="EmailTextBox" />
                        <br />
                        <br />
                        <asp:Button ID="SubmitButton" Text="Check" runat="server" ValidationGroup="RequiredFields"
                            OnClick="SubmitButton_Click" />
                        <br />
                        <asp:CompareValidator ID="CompareValidatorDate" runat="server"
                            ControlToValidate="ChosenDate" ErrorMessage="Choose a date in the future."
                            Operator="GreaterThanEqual" Type="Date" Display="None" ValidationGroup="RequiredFields" EnableClientScript="False"></asp:CompareValidator>
                        <asp:RequiredFieldValidator ID="RequiredFieldValidatorDate" runat="server"
                            ControlToValidate="ChosenDate" Display="None" ErrorMessage="Date is required."
                            ValidationGroup="RequiredFields" EnableClientScript="False"></asp:RequiredFieldValidator>
                        <asp:RegularExpressionValidator ID="RegularExpressionValidatorEmail"
                            runat="server" ControlToValidate="EmailTextBox" Display="None"
                            ValidationGroup="RequiredFields" ErrorMessage="The email was not correctly formatted."
                            ValidationExpression="^([0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})$" EnableClientScript="False"></asp:RegularExpressionValidator>
                        <asp:RequiredFieldValidator ID="RequiredFieldValidatorEmail"
                            runat="server" ValidationGroup="RequiredFields" ControlToValidate="EmailTextBox"
                            Display="None" ErrorMessage="Email is required." EnableClientScript="False"></asp:RequiredFieldValidator><br />
                        <asp:ValidationSummary ID="ValidationSummary1" runat="server"
                            ValidationGroup="RequiredFields" EnableClientScript="False" />
                        <asp:Label ID="MessageLabel" runat="server" />
                    </fieldset>
                </ContentTemplate>
            </asp:UpdatePanel>
        </div>
    </form>
</body>
</html>


В следующей таблице перечислены классы, которые связаны с классом PageRequestManager.

Класс

Описание

Класс Sys.WebForms.PageRequestManager

Управляет частичным обновлением страницы клиента и предоставляет члены для создания пользовательских клиентских сценариев.

Класс Sys.WebForms.InitializeRequestEventArgs

Предоставляет данные события для события initializeRequest, которое вызывается до начала выполнения асинхронного запроса.

Класс Sys.WebForms.BeginRequestEventArgs

Предоставляет данные события для события beginRequest, которое вызывается после начала асинхронной обратной передачи и до отправки обратной передачи серверу.

Класс Sys.WebForms.PageLoadingEventArgs

Предоставляет данные события для события pageLoading, которое вызывается после получения ответа асинхронной передачей, но до обновления содержимого страницы. Данное событие не возникает, если обратная передача остановлена, либо если создается необработанное исключение на сервере во время обработки.

Класс Sys.WebForms.PageLoadedEventArgs

Предоставляет данные события для события pageLoaded, которое вызывается после обновления всего содержимого страницы в результате либо синхронной обратной передачи, либо асинхронной обратной передачи. Данное событие не возникает, если обратная передача остановлена, либо если создается необработанное исключение на сервере во время обработки.

Класс Sys.WebForms.EndRequestEventArgs

Обеспечивает данные события для события endRequest, которое вызывается после завершения асинхронной обратной передачи.

Показ: