C# для профессионалов. Том II - Симон Робинсон

Создание композитного специального элемента управления

В качестве несложного примера композитного специального элемента управления можно объединить элемент управления из предыдущего раздела с кнопкой цикла, которая имелась на тестовой форме.

Назовем этот композитный элемент управления RainbowControl2 и поместим его в новый файл RainbowControl2.cs. Этот элемент управления должен делать следующее:

□ Наследовать из WebControl (а не от Label в этот раз)

□ Поддерживать INamingContainer

□ Иметь два поля для хранения своих элементов управления-потомков

public class RainbowLabel2 : System.Web.UI.WebControls.WebControl, INamingContainer {

 private RainbowLabel rainbowLabel = new RainbowLabel();

 private Button cycleButton = new Button();

Чтобы сконфигурировать композитный элемент управления, необходимо сделать так, чтобы всякий элемент управления-потомок добавлялся к коллекции Controls и правильно инициализировался. Мы делаем это, переопределяя метод CreateChildControls() и помещая туда необходимый код:

protected override void CreateChildControls() {

 cycleButton.Text = "Cycle colors.";

 cycleButton.Click += new System.EventHandler(cycleButton_Click);

 Controls.Add(cycleButton);

 Controls.Add(rainbowLabel);

}

Здесь мы используем только метод Add() коллекции Controls, чтобы работа была корректной. Добавляем также обработчик событий для кнопки, чтобы мы могли циклически менять цвета, это достигается точно таким же образом, как и для других событий. Обработчик событий уже знаком:

protected void cycleButton_Click(object sender, System.EventArgs e) {

 rainbowLabel.cycle();

}

Данный вызов заставляет цвета метки циклически изменяться.

Чтобы предоставить пользователям композитного элемента управления доступ к тексту в потомке rainbowLabel, можно добавить свойство, которое отображается в свойство Text потомка:

public string Text {

 get {

  return rainbowLabel.Text;

 }

 set {

  rainbowLabel.Text = value;

 }

}

Осталось только реализовать Render(). По умолчанию, если не переопределить этот метод, вызывается метод Render() каждого элемента управления потомка. Однако, чтобы получить дополнительный контроль над этим, можно самим вызывать эти методы или, лучше, открытые экземпляры методов RenderControl():

protected override void Render(HtmlTextWriter writer) {

 rainbowLabel.RenderControl(writer);

 cycleButton.RenderControl(writer);

}

Здесь не выводится никакой код HTML, хотя можно было легко это сделать. Нам нужно просто передать полученный экземпляр HtmlTextWriter в метод RenderControl() для потомка, чтобы обычным образом был вставлен HTML, созданный этим потомком. Можно использовать такой элемент управления почти так же, как и RainbowLabel:

<form method="post" runat="server" ID="Form1">

 <PCS:RainbowLabel2 Runat="server"

  Text="Multicolored label composite" ID="rainbowLabel2" />

</form>

вместе со связанным объявлением в скрытом коде формы.

Элемент управления выборочным опросом

Теперь воспользуемся изложенной техникой и создадим более сложный специальный элемент управления. Конечный результат позволит с помощью следующего кода ASP.NET:

<form method="post" runat="server" ID="Form1">

 <PCS: StrawPoll Runat="server" ID="strawPoll1"

  PollStyle="voteonly" Title="Who is your favorite James Bond?">

  <PCS:Option Name="SeanConnery" Votes="101" />

  <PCS:Option Name="Roger Moore" Votes="83" />

  <PCS:Option Name="George Lazenby" Votes="32" />

  <PCS:Option Name="Timothy Dalton" Votes="28" />

  <PCS:Option Name="Pierce Brosnan" Votes="95" />

 </PCS:StrawPoll>

</form>

получить:

И когда мы нажмем на кнопку vote, изображение изменится на следующее:

Альтернативно, в основном для целей тестирования, можно выводить результаты и кнопки голосования одновременно, и разрешить подавать несколько голосов.

Код ASP.NET вовлечен явно в задание свойства Name и Votes для каждого варианта Option. Это прекрасно подходит для данного примера, хотя можно предвидеть, что более развитая версия этого элемента управления соединится с данными для получения результатов. Однако здесь это рассматриваться не будет, так как может оказаться достаточно сложным.

При анализе кода ASP.NET такие структуры интерпретируются согласованным образом: каждый управляющий элемент-потомок интерпретируется способом, который определен в классе-построителе элемента управления, связанным с элементом управления предком. Этот построитель элемента управления, код которого мы скоро увидим, обрабатывает все вложенное внутрь элемента управления, с которым он связан, включая литеральный текст.

Нам нужно создать два элемента управления: Option — для хранения отдельных вариантов выбора и StrawPoll, который будет содержать и выводить элемент управления выборочного опроса. Оба эти элемента управления будут помещены в новый файл исходного кода: StrawPoll.cs.

Элемент управления Option

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

Поэтому нам потребуется:

□ Код для свойств Name и Votes (хранимых в ViewState)

□ Код инициализации в CreateChildControls()

□ Код для обработчика нажатия кнопки

Мы включаем также вспомогательный метод Increment(), который будет добавлять голос к текущему счету. Этот вспомогательный метод вызывается обработчиком нажатия кнопки.

Нам понадобится также поддержка INamingContainer, так как мы имеем несколько экземпляров этих элементов управления со своими собственными потомками.

Код класса Option будет находиться в файле StrawPoll.cs, который мы должны добавить к проекту вместе со стандартными инструкциями namespace и using, согласно уже известным нам элементам управления RainbowLabel. Код будет иметь следующий вид:

public class Option : System.Web.UI.WebControls.WebControl, INamingContainer {

 public string Name {

  get {

   return (string)ViewState["_name"];

  }

  set {

   ViewState["_name"] = value;

  }

 }

 public long Votes {

  get {

   return (long)ViewState["_votes"];

  }

  set {

   ViewState["_votes"] = value;

  }

 }

 public void Increment() {

  ViewState["_votes"] =(long)ViewState["_votes"] + 1;

 }

 public void Reset() {

  ViewState["_votes"] = 0;

 }

 protected override void CreateChildControls() {

  Button btnVote = new Button();

  btnVote.Text = "Vote";

  btnVote.Click += new System.EventHandler(btnVote_Click);

  Controls.Add(btnVote);

 }

 protected void btnVote_Click(object sender, System.EventArgs e) {

  Increment();

 }

}

Отметим, что метод Render() не был здесь переопределен. Это связано с тем, что этот элемент управления имеет одного наследника, кнопку голосования и никакой другой информации для вывода. Поэтому можно использовать значение по умолчанию, которое будет просто изображением кнопки.

Построитель элемента управления StrawPoll

Теперь мы рассмотрим, как можно транслировать код ASP.NET каждого варианта выбора в элемент управления, который является потомком элемента управления StrawPoll. Чтобы сделать это, необходимо ассоциировать построитель элемента управления с классом StrawPoll с помощью атрибута ControlBuilderAttribute. Нам нужно также определить, что элементы управления-потомки не должны анализироваться никаким другим способом с помощью атрибута ParseChildren:

[ControlBuilderAttribute(typeof(StrawPollControlBuilder)) ]

[ ParseChildren(false) ]

public class StrawPoll : System.Web.UI.WebControls.WebControl, INamingContainer { }

Здесь используется класс с именем StrawPollControlBuilder, определенный следующим образом:

internal class StrawPollControlBuilder : ControlBuilder {

 public override Type GetChildControlType(string tagName, IDictionary attribs) {

  if (tagName.ToLower().EndsWith("option")) return typeof(Option);

  return null;

 }

 public override void AppendLiteralString(string s) {

  // ничего не делать, чтобы избежать добавления встроенного текста

  // к элементу управления

 }

}

Здесь мы переопределяем метод GetChildControlType() базового класса ControlBuilder чтобы он возвращал тип класса Option в ответ на тег с именем <Option>. Фактически, чтобы все работало в максимальном количестве ситуаций, мы ищем любое имя тега, которое оканчивается строкой "option" с буквами в верхнем или нижнем регистре.