Пример: создание простой веб-части

  • Статья

Дата последнего изменения: 1 сентября 2011 г.

Применимо к: SharePoint Foundation 2010

В этой статье
Создание веб-части
Добавление свойства веб-части
Переопределение метода Render
Развертывание и тестирование веб-части

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

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

Необходимые компоненты

ASP.NET

разработки SharePoint в Microsoft Visual Studio 2010

Создание веб-части

Создание веб-части

  1. Запустите разработки SharePoint в Visual Studio 2010.

  2. В меню Файл выберите пункт Создать, затем щелкните Проект.

  3. В окне Типы проектов выберите в разделе Visual Basic или C# пункт Пустой проект SharePoint.

  4. Введите в качестве имени проекта Sample.DisplayMessage. Нажмите кнопку ОК.

  5. В окне Мастер настройки SharePoint выберите пункт Развернуть как изолированное решение. Нажмите кнопку Готово.

  6. В обозревателе решений щелкните правой кнопкой мыши проект Sample.DisplayMessage, а затем выберите Добавить, Новый элемент.

  7. В диалоговом окне Добавление нового элемента выберите шаблон Веб-часть и введите DisplayMessageWebPart в качестве значения поля Имя. Нажмите кнопку Добавить.

Добавление свойства веб-части

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

ПримечаниеПримечание

Дополнительные сведения о настройке и персонализации см. в разделе Web Parts Personalization.

Теги настраиваемых свойств для веб-частей, основанных на базовом классе страниц веб-частей ASP.NET (Возможно, на английском языке), именуются не так, как как для веб-частей, основанные на базовом классе WebPart. В следующем списке описано каждое из этих свойств.

Создание свойства веб-части

  1. Скопируйте следующий код и вставьте его в файл DisplayMessageWebPart, чтобы создать базовое настраиваемое свойство.

    private string customMessage = "Hello, world!";

public string DisplayMessage
{
    get { return customMessage; }
    set { customMessage = value; }
}

    Private customMessage As String = "Hello, world!"

Public Property DisplayMessage() as String
    Get
        Return customMessage
    End Get
    Set(ByVal value as String)
        customMessage = value
    End Set
End Property

  2. Затем добавьте следующие теги перед декларацией public, чтобы изменения касались каждого пользователя по-отдельности.

    [WebBrowsable(true),
WebDescription("Displays a custom message"),
WebDisplayName("Display Message"),
Personalizable(PersonalizationScope.User)]

    <WebBrowsable(True), _
WebDescription("Displays a custom message"), _
WebDisplayName("Display Message"), _
Personalizable(PersonalizationScope.User)> _

  3. Персонализированное свойство веб-части создано.

Переопределение метода Render

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

Переопределение метода Render

  • Скопируйте следующий код и вставьте его в файл DisplayMessageWebPart, чтобы переопределить метод Render.

    protected override void Render(System.Web.UI.HtmlTextWriter writer)
{
    writer.Write(DisplayMessage);
}

    Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter)
    writer.Write(DisplayMessage)
End Sub

Развертывание и тестирование веб-части

Развертывание и тестирование веб-части

  1. Нажмите клавишу F5, чтобы развернуть веб-часть.

  2. Когда страница откроется в браузере, нажмите кнопку Правка на вкладке Страница, чтобы перевести страницу в режим редактирования.

  3. На вкладке Вставка в контекстной группе Средства правки нажмите кнопку Веб-часть.

  4. В списке Категории выберите Настраиваемый, а затем выберите в списке веб-частей DisplayMessageWebPart. Нажмите кнопку Добавить. Веб-часть появится на странице и будет содержать текст Hello, world!.

  5. Чтобы изменить текст, отображаемый в веб-части, выберите веб-часть на странице, откройте вкладку Параметры в контекстной группе Работа с веб-частью и нажмите кнопку Свойства веб-части.

  6. На панели свойств DisplayMessageWebPart разверните категорию Прочие и измените значение Отобразить сообщение. Щелкните Применить.

  7. Теперь веб-часть отображает введенный пользователем текст внутри веб-части.