WebPartVerb Classe

Définition

public ref class WebPartVerb : System::Web::UI::IStateManager

[System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.EmptyStringExpandableObjectConverter))]
public class WebPartVerb : System.Web.UI.IStateManager

[<System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.EmptyStringExpandableObjectConverter))>]
type WebPartVerb = class
    interface IStateManager

Public Class WebPartVerb
Implements IStateManager

Héritage

Object

WebPartVerb

Attributs

TypeConverterAttribute

Implémente

IStateManager

Exemples

L’exemple de code suivant montre comment créer un objet personnalisé WebPartVerb et une zone personnalisée qui utilise la OnCreateVerbs méthode pour ajouter le verbe au menu verbes de chaque WebPart contrôle contenu dans la zone. L’exemple de code comporte quatre parties :

• Fichier source qui contient un contrôle personnalisé WebPart simple qui affiche du texte.

• Fichier source qui contient un objet personnalisé WebPartVerb et une zone personnalisée WebPartZoneBase simple qui remplace la méthode permettant d’ajouter le OnCreateVerbs verbe personnalisé aux WebPart contrôles de la zone.

• Page web qui contient la zone personnalisée et le contrôle personnalisé WebPart .

• Explication du fonctionnement de l’exemple.

La première partie de l’exemple de code contient du code source qui crée un contrôle simple WebPart qui affiche du texte. Pour que l’exemple de code s’exécute, vous devez compiler ce code source. Vous pouvez le compiler explicitement et placer l’assembly résultant dans le dossier Bin de votre site web ou dans le global assembly cache. Vous pouvez également placer le code source dans le dossier App_Code de votre site, où il sera compilé dynamiquement au moment de l’exécution. Cet exemple de code utilise l’approche de compilation dynamique. Pour obtenir une procédure pas à pas qui montre comment compiler, consultez Procédure pas à pas : Développement et utilisation d’un contrôle de serveur web personnalisé.

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Collections.Generic;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace Samples.AspNet.CS.Controls
{

    // This code snippet creates a simple Web Part control.
    [AspNetHostingPermission(SecurityAction.Demand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    public class SimpleControl : WebPart
    {

        private String _text = "Simple control text";

        public string Text
        {
            get
            {
                if (_text != null)
                    return _text;
                else
                    return string.Empty;
            }
            set { _text = value; }
        }

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

Imports System.Data
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Collections.Generic
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

' This code snippet creates a simple Web Part control.
Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class SimpleControl
    Inherits System.Web.UI.WebControls.WebParts.WebPart

    Private _text As String = "Simple control text"

    Public Property [Text]() As String
      Get
        If Not (_text Is Nothing) Then
          Return _text
        Else
          Return String.Empty
        End If
      End Get
      Set(ByVal value As String)
        _text = value
      End Set
    End Property

    Protected Overrides Sub Render(ByVal writer _
      As System.Web.UI.HtmlTextWriter)

      writer.Write(Me.Text)

    End Sub

  End Class

End Namespace

La deuxième partie de l’exemple contient le code source pour créer la zone personnalisée et l’objet personnalisé WebPartVerb . Notez que la zone remplace la OnCreateVerbs méthode pour ajouter le verbe personnalisé à tous WebPart les contrôles de la zone. Le verbe est ajouté par défaut au menu verbes des contrôles. Notez que, dans le code du verbe personnalisé, le constructeur du verbe utilise un gestionnaire de clics de serveur et que la méthode appelée crée une copie complète de tout contrôle qui hérite directement de la WebPart classe, en ajoutant la copie nouvellement créée à la même zone. Comme la première partie de l’exemple de code, ce code source doit être compilé et, dans cet exemple, le fichier source a été placé dans un App_Code sous-dossier à compiler dynamiquement.

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Collections.Generic;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace Samples.AspNet.CS.Controls
{
/* 
This code sample creates a Web Part zone and adds the 
"Copy Web Part" verb to any control in the zone.
*/
[AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
public class ZoneWithAddedVerb : WebPartZone
{

  protected override void OnCreateVerbs(WebPartVerbsEventArgs e)
  {
    List<WebPartVerb> newVerbs = new List<WebPartVerb>();
    newVerbs.Add(new CopyWebPartVerb(CopyWebPartToNewOne));
    e.Verbs = new WebPartVerbCollection(e.Verbs,newVerbs);
    base.OnCreateVerbs(e);
  }

  void CopyWebPartToNewOne(object sender, WebPartEventArgs e)
  {
    WebPartManager wpmgr = 
      WebPartManager.GetCurrentWebPartManager(Page);
    System.Web.UI.WebControls.WebParts.WebPart wp;
    Type tp = e.WebPart.GetType(); 
    wp = (System.Web.UI.WebControls.WebParts.WebPart)Activator.CreateInstance(tp);   
    wpmgr.AddWebPart(wp, e.WebPart.Zone, e.WebPart.ZoneIndex + 1);
  }
}
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  internal class CopyWebPartVerb : WebPartVerb
  {
    private const String _copyWebPartImageUrl = "~/CopyVerb.ico";

    internal CopyWebPartVerb(WebPartEventHandler serverClickHandler) :  
       base("MyVerb", serverClickHandler)
    { }
    public override string Text
    {
      get { return "Copy Web Part"; }
      set { ;}
    }
    public override string Description
    {
      get { return "This verb will copy this web part control " +
        "to a new one below"; }
      set { ; }
    }
    public override bool Enabled
    {
      get { return base.Enabled; }
      set { base.Enabled = value; }
    }
    
    public override string ImageUrl
    {
      get { return _copyWebPartImageUrl; }
      set { ; }
    }
  }
}

Imports System.Data
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Collections.Generic
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

' This code sample creates a Web Part zone and adds the 
' "Copy Web Part" verb to any control in the zone.
Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class ZoneWithAddedVerb
    Inherits WebPartZone

    'public class ExtendedWebPartZoneBase 
    Protected Overrides Sub OnCreateVerbs(ByVal e _
      As WebPartVerbsEventArgs)

      Dim newVerbs As List(Of WebPartVerb) = _
        New List(Of WebPartVerb)
      newVerbs.Add(New CopyWebPartVerb(AddressOf CopyWebPartToNewOne))
      e.Verbs = New WebPartVerbCollection(e.Verbs, newVerbs)
      MyBase.OnCreateVerbs(e)

    End Sub


    Sub CopyWebPartToNewOne(ByVal sender As Object, _
      ByVal e As WebPartEventArgs)

      Dim wpmgr As WebPartManager = _
        WebPartManager.GetCurrentWebPartManager(Page)
      Dim wp As System.Web.UI.WebControls.WebParts.WebPart
      Dim tp As Type = e.WebPart.GetType()
      wp = CType(Activator.CreateInstance(tp), _
        System.Web.UI.WebControls.WebParts.WebPart)
      wpmgr.AddWebPart(wp, e.WebPart.Zone, e.WebPart.ZoneIndex + 1)

    End Sub

  End Class


  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Friend Class CopyWebPartVerb
    Inherits WebPartVerb
    Private Const _copyWebPartImageUrl As String = "~/CopyVerb.ico"

    Friend Sub New(ByVal serverClickHandler As WebPartEventHandler)
      MyBase.New("MyVerb", serverClickHandler)

    End Sub

    Public Overrides Property [Text]() As String
      Get
        Return "Copy Web Part"
      End Get
      Set(ByVal value As String)
      End Set
    End Property

    Public Overrides Property Description() As String
      Get
        Return "This verb will copy this web part control to a " _
               & "new one below"
      End Get
      Set(ByVal value As String)
      End Set
    End Property

    Public Overrides Property Enabled() As Boolean
      Get
        Return MyBase.Enabled
      End Get
      Set(ByVal value As Boolean)
        MyBase.Enabled = value
      End Set
    End Property
    
    Public Overrides Property ImageUrl() As String
      Get
        Return Me._copyWebPartImageUrl
      End Get
      Set(ByVal value As String)
      End Set
    End Property

  End Class

End Namespace

La troisième partie de l’exemple de code est la page Web qui héberge les contrôles. Notez qu’il existe une Register directive en haut de la page pour déclarer l’espace de noms des contrôles personnalisés. Aucun assembly n’est déclaré, car cet exemple utilise la compilation dynamique. Le contrôle personnalisé WebPart est déclaré dans la zone personnalisée. Vous pouvez également déclarer d’autres WebPart contrôles dans cette zone, et le verbe personnalisé est également ajouté à leurs menus de verbes.

<%@ Page Language="C#" %>
<%@ Register TagPrefix="verbsample" 
    namespace="Samples.AspNet.CS.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <verbsample:ZoneWithAddedVerb id="ZoneWithAddedVerb1" 
      HeaderText="Zone with Added Verb" runat="server">
        <ZoneTemplate>
           <verbsample:SimpleControl id="SimpleControl1" 
            title="Simple Control" runat="server" /> 
        </ZoneTemplate>
        </verbsample:ZoneWithAddedVerb>
     </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Register TagPrefix="verbsample" 
    namespace="Samples.AspNet.VB.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <verbsample:ZoneWithAddedVerb id="ZoneWithAddedVerb1" 
      HeaderText="Zone with Added Verb" runat="server">
        <ZoneTemplate>
           <verbsample:SimpleControl id="SimpleControl1" 
            title="Simple Control" runat="server" /> 
        </ZoneTemplate>
        </verbsample:ZoneWithAddedVerb>
     </form>
</body>
</html>

Chargez la page dans un navigateur, puis cliquez sur le menu verbes du contrôle personnalisé WebPart . Le verbe Copier le composant WebPart doit être visible. Cliquez sur le verbe et notez qu’une copie du contrôle est ajoutée à la zone.

Remarques

Les verbes de composants WebPart sont des éléments d’interface utilisateur interactifs, généralement représentés par des boutons ou des liens hypertexte, qui s’affichent dans les pages qui utilisent des contrôles WebPart. Les utilisateurs cliquent sur des verbes pour effectuer des actions courantes de l’interface utilisateur pour les contrôles WebPart, telles que la fermeture d’un WebPart contrôle ou la fermeture du mode d’affichage d’édition (vue de page spéciale associée au EditorZone contrôle). Tous les verbes standard fournis avec le jeu de contrôles De composants WebPart sont associés à une zone de composants WebPart (WebPartZone, , CatalogZoneEditorZoneou ) ou ConnectionsZoneà un contrôle De composants WebPart Part (WebPart, GenericWebPart, EditorPartou CatalogPart).

Lorsque les verbes standard sont associés à une zone, leurs actions s’appliquent au niveau de la zone et les verbes apparaissent généralement dans l’en-tête ou le pied de page de la zone. Le tableau suivant répertorie les verbes courants au niveau de la zone et décrit leurs actions.

En ce qui concerne les verbes standard associés aux Part contrôles, leurs actions s’appliquent au contrôle lui-même (ou à ses contrôles enfants). Le contrôle de composant agit comme un conteneur pour le verbe et gère le rendu du verbe. La plupart des verbes standard associés aux contrôles de partie s’affichent directement dans la barre de titre ou dans un menu déroulant verbes dans la barre de titre. Si ces verbes apparaissent directement dans l’en-tête ou dans un menu verbes est déterminé par la WebPartVerbRenderMode propriété ; par défaut, les verbes apparaissent dans un menu verbes. Le tableau suivant répertorie les verbes courants associés aux différents Part contrôles et décrit leurs actions.

En plus des verbes standard fournis avec le jeu de contrôles WebPart, vous pouvez également créer des verbes personnalisés. Un scénario courant pour créer des verbes personnalisés consiste à créer des verbes associés Part aux contrôles. Lorsque vous créez ces verbes, par défaut, ils s’affichent dans le menu verbes avec les verbes standard. L’approche de base pour créer de tels verbes consiste à hériter de la WebPartVerb classe pour créer un ou plusieurs verbes personnalisés. Créez ensuite un contrôle qui hérite de la WebPart classe de base et ajoutez les objets personnalisés WebPartVerb à une WebPartVerbCollection collection. Cette collection peut ensuite être ajoutée à la Verbs collection du contrôle, ce qui entraînera l’affichage automatique des verbes personnalisés dans le menu verbes du contrôle au moment de l’exécution. Comme pour les verbes standard, vous pouvez accéder aux verbes personnalisés par programmation sur un WebPart contrôle.

Les applications WebPart peuvent utiliser des contrôles serveur qui n’héritent pas de la WebPart classe, tels que les contrôles personnalisés, les contrôles utilisateur ou les contrôles ASP.NET. Ces contrôles serveur, s’ils sont ajoutés à une WebPartZoneBase zone, sont encapsulés dynamiquement avec un GenericWebPart objet au moment de l’exécution, ce qui leur permet de fonctionner en tant que contrôles d’exécution WebPart . Pour ajouter des verbes personnalisés à un contrôle serveur qui n’hérite pas de la classe, le WebPart contrôle serveur doit implémenter l’interface IWebActionable et remplacer sa Verbs propriété.

Lorsque vous créez un verbe, vous pouvez créer deux types de gestionnaires d’événements associés qui s’exécutent lorsqu’un utilisateur clique sur le verbe : un gestionnaire d’événements côté serveur (code qui s’exécute sur le serveur) et un gestionnaire d’événements côté client (code qui s’exécute dans le navigateur client). En outre, vous pouvez définir des états personnalisés pour les verbes, ce qui est un moyen utile de fournir des signaux visuels aux utilisateurs. Par exemple, vous pouvez créer un état indiquant qu’un verbe a été sélectionné, puis fournir les modifications appropriées dans l’interface utilisateur pour informer l’utilisateur que le verbe est déjà sélectionné. Un autre comportement utile est la possibilité de désactiver les verbes ; En procédant ainsi, vous pouvez empêcher les utilisateurs de cliquer sur des verbes si cela serait dangereux ou inefficace en fonction de l’état de l’application.

La WebPartVerb classe n’expose aucune méthode unique ; ses méthodes exposées sont toutes des substitutions de méthodes de base. Il contient toutefois un certain nombre de propriétés que les développeurs doivent connaître. La Checked propriété indique si un verbe est actuellement sélectionné. Les ClientClickHandler propriétés et ServerClickHandler font référence aux gestionnaires respectifs au sein de la classe (le cas échéant) pour les événements de clic du client et du serveur. La Description propriété contient du texte qui décrit l’objectif d’un verbe dans une info-bulle lorsque les utilisateurs positionnent un pointeur de souris sur le verbe dans l’interface utilisateur. La Enabled propriété indique l’état actuel d’un verbe, qui détermine si un utilisateur peut cliquer sur le verbe et exécuter son action. La ID propriété fournit un ID unique pour l’objet verbe. La ImageUrl propriété contient une URL vers une image qui peut être utilisée pour représenter un verbe dans l’interface utilisateur à la place du rendu par défaut (généralement un bouton ou un lien hypertexte). La Text propriété contient le texte d’étiquette qui apparaît directement sur le verbe dans l’interface utilisateur. La propriété remplacée Visible détermine si un verbe est actuellement affiché dans l’interface utilisateur. Les verbes sont souvent masqués ou désactivés à différents moments dans une application WebPart ; par exemple, les verbes de spécialité (tels que le verbe modifier et le verbe de connexion) ne s’affichent que lorsque les contrôles, paramètres et modes d’affichage appropriés existent sur la page pour permettre à ces verbes de prendre des mesures significatives.

D’autres membres clés pour l’utilisation des verbes incluent la WebPartZoneBase.OnCreateVerbs méthode, qui est un gestionnaire d’événements qui peut être remplacé pour la gestion personnalisée du processus de création de verbes, et l’événement WebPartZoneBase.CreateVerbs .

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à

Voir aussi

• Verbs
• Verbs
• WebPartVerbCollection
• contrôles de composants WebPart ASP.NET