Criar controles reutilizáveis para Web Parts ou páginas de aplicativo

No Visual Studio, você pode criar controles personalizados e reutilizáveis que podem ser consumidos por páginas de aplicativo e Web Parts executados no SharePoint. Esses controles são chamados de controles de usuário. Um controle de usuário é um tipo de controle composto que funciona de modo muito parecido com uma página da Web ASP.NET – você pode adicionar controles de servidor Web existentes e marcação a um controle de usuário e definir propriedades e métodos para o controle. Em seguida, você pode inseri-los em páginas da Web ASP.NET, em que atuam como uma unidade.

Criar um controle de usuário

Para criar um controle de usuário, adicione um Controle de Usuário a um Projeto vazio do SharePoint. Para obter mais informações, consulte Como criar um controle de usuário para uma Web Part ou página de aplicativo do SharePoint.

Quando você adiciona um item de Controle de Usuário, o Visual Studio cria uma pasta em seu projeto e adiciona vários arquivos à pasta. A tabela a seguir descreve cada arquivo.

Arquivo	Descrição
Arquivo de controle de usuário	Define o controle de usuário. Projete o controle de usuário adicionando controles e marcação a esse arquivo.
Arquivo de código	Contém o código por trás do controle de usuário. Adicione código para manipular eventos para esse arquivo.
Arquivo de código do designer	Contém o código gerado pelo designer e não deve ser editado diretamente.

Projetar o controle de usuário

Projete o controle de usuário usando o designer do Desenvolvedor Web Visual no Visual Studio. Esse designer aparece quando você abre o arquivo de controle do usuário no projeto e escolhe a guia Design.

Consumir o controle de usuário

Os controles de usuário não aparecem no SharePoint até que você os inclua em uma página de aplicativo ou em uma Web Part.

Para incluir um controle de usuário em uma página de aplicativo, abra a página da Web à qual deseja adicionar o controle de usuário ASP.NET. Alterne para o modo de exibição de Design, selecione o arquivo de controle de usuário personalizado no Gerenciador de Soluções e arraste-o para a página. O controle de usuário ASP.NET é adicionado à página e o designer cria a diretiva @ Register, que é necessária para que a página reconheça o controle de usuário. Agora, você pode trabalhar com as propriedades e os métodos públicos do controle.

Para incluir um controle de usuário em uma Web Part, adicione o controle de usuário à coleção Controls da Web Part no arquivo de código dela. O exemplo a seguir adiciona um controle de usuário à coleção Controls de uma Web Part.

C#

[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);
    }
    
}

VB

<ToolboxItemAttribute(false)> _
Public Class VisualWebPart1
    Inherits WebPart

    Private Const _ascxPath As String = "~/_CONTROLTEMPLATES/VB/VisualWebPart1/VisualWebPart1UserControl.ascx"

    Public Sub New()
    End Sub

    Protected Overrides Sub CreateChildControls()
        Dim control As Control = Page.LoadControl(_ascxPath)
        Controls.Add(control)
        MyBase.CreateChildControls()
    End Sub

    Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
        MyBase.RenderContents(writer)
    End Sub

End Class

Depurar um controle de usuário

Para depurar um controle de usuário, verifique se ele está incluído em uma página de aplicativo ou Web Part no projeto do SharePoint. Em seguida, você pode depurar o código no controle de usuário da mesma forma como depuraria código em qualquer Projeto do Visual Studio.

Quando você inicia o depurador do Visual Studio, o Visual Studio abre o site do SharePoint.

No SharePoint, abra a página de aplicativo que inclui o controle de usuário. Se o controle de usuário estiver incluído em uma Web Part, adicione-a a uma página de Web Part no SharePoint.

Para obter mais informações sobre como depurar projetos do SharePoint, consulte Solucionar problemas com soluções do SharePoint.

Tópicos relacionados

Título	Descrição
Como criar um controle de usuário para uma página de aplicativo do SharePoint ou Web Part	Mostra como criar controles personalizados e reutilizáveis que podem ser consumidos por páginas de aplicativo e Web Parts executados no SharePoint.