Compartilhar via


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

Visual Studio permite que você criar controles personalizados, reutilizáveis que podem ser consumidos por páginas de aplicativo e de Web Parts que são executados no SharePoint. Esses controles são chamados controles de usuário. Para obter mais informações sobre controles de usuário, consulte Controles de usuário do ASP.NET.

Criar um controle de usuário

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

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

File

Descrição

Arquivo de controle de usuário

Define o controle de usuário. Crie o controle de usuário adicionando controles e marcação para este arquivo.

Arquivo de código

Contém código de controle de usuário. Adicione código para manipular eventos para este arquivo.

Arquivo de código do Designer

Contém o código gerado pelo designer e não devem ser editados diretamente.

Criar o controle de usuário

Crie o controle de usuário usando o designer Visual Web Developer, no Visual Studio. Esse designer aparece quando você clica duas vezes no arquivo de controle de usuário em seu projeto. Para obter mais informações sobre como usar esse designer, consulte Mapa de conteúdo do Visual Web Developer.

Consumindo o controle de usuário

Controles de usuário não aparecem no SharePoint até que incluí-los em uma página de aplicativo ou uma Web Part.

Para incluir um controle de usuário em uma página de aplicativo adicione um @ Register diretiva para a página de aplicativo e, em seguida, declare o controle de usuário dentro dos espaços reservados conteúdos de um ou mais na página. Para obter um exemplo de como realizar essa tarefa em uma página ASP.NET a página da Web, consulte Como: incluir um controle de usuário em uma página da Web ASP.NET.

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

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

}

Um controle de usuário de depuração.

Para depurar um controle de usuário, certifique-se de que o controle de usuário é incluído em uma página de aplicativo ou a Web Part no seu projeto do SharePoint. Em seguida, você pode depurar código no controle de usuário, exatamente como você deseja depurar o código em qualquer projeto de Visual Studio.

Quando você inicia o depurador de Visual Studio, 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 é incluído em uma Web Part, adicione a Web Part a uma página de Web Part no SharePoint.

Para obter mais informações sobre depuração de projetos do SharePoint, consulte Solucionando problemas de 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 a Web Part

Mostra como criar controles personalizados, reutilizáveis que podem ser consumidos por páginas de aplicativo e de Web Parts que são executados no SharePoint.

Trabalhando com o Visual Web Developer

Descreve como usar o designer que aparece quando você abre uma página da Web em seu projeto.