Поделиться через

Создание многократно используемых элементов управления для веб-частей или страниц приложений

  • Статья

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

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

Чтобы создать пользовательский элемент управления, добавьте объект Пользовательский элемент управления в пустой проект SharePoint. Дополнительные сведения см. в статье "Практическое руководство. Создание пользовательского элемента управления для страницы приложения SharePoint или веб-части".

При добавлении элемента Пользовательский элемент управления Visual Studio создает в проекте папку, а затем добавляет в нее несколько файлов. Эти файлы описываются в следующей таблице.

Файл Description
Файл пользовательского элемента управления Определяет пользовательский элемент управления. Проектируйте пользовательский элемент управления, добавляя элементы управления и разметку в этот файл.
Файл кода Содержит внутренний код пользовательского элемента управления. Добавляйте в этот файл код для обработки событий.
Файл кода конструктора Содержит код, созданный конструктором (его не следует изменять прямо в файле).

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

Для проектирования пользовательского элемента управления используется конструктор Visual Web Developer в Visual Studio. Чтобы открыть этот конструктор, откройте в своем проекте файл пользовательского элемента управления и перейдите на вкладку Конструктор.

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

Пользовательские элементы управления не отображаются в SharePoint, пока вы не включите их на странице приложения или в веб-части.

Чтобы включить пользовательский элемент управления на странице приложения, откройте веб-страницу, на которую хотите добавить этот пользовательский элемент управления ASP.NET. Перейдите в представление конструирования, выберите файл пользовательского элемента управления в обозревателе решений и перетащите его на эту страницу. Пользовательский элемент управления ASP.NET добавляется на страницу, и конструктор создает директиву @ Register, которая необходима, чтобы страница могла распознать этот пользовательский элемент управления. Теперь можно работать с общедоступными свойствами и методами этого элемента управления.

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

[ToolboxItemAttribute(false)]
public class VisualWebPart1 : WebPart
{
    private const string _ascxPath = @"~/_CONTROLTEMPLATES/CS/VisualWebPart1/VisualWebPart1UserControl.ascx";

    public VisualWebPart1()
    {
    }

    protected override void CreateChildControls()
    {
        Control control = this.Page.LoadControl(_ascxPath);
        Controls.Add(control);
        base.CreateChildControls();
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {
        base.RenderContents(writer);
    }
    
}

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

Для отладки пользовательского элемента управления убедитесь, что он включен на странице приложения или в веб-части вашего проекта SharePoint. После этого можно отлаживать код в пользовательском элементе управления так же, как код в любом проекте Visual Studio.

При запуске отладчика Visual Studio открывается сайт SharePoint.

Откройте в SharePoint страницу приложения с этим пользовательским элементом управления. Если пользовательский элемент управления включен в веб-часть, добавьте эту веб-часть на страницу веб-частей в SharePoint.

Дополнительные сведения об отладке проектов SharePoint см. в разделе Устранение неполадок решений SharePoint.

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