WebPartConnection.IsActive Propriété
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Obtient une valeur qui indique si un objet WebPartConnection est actuellement établi et capable d'échanger des données entre son contrôle fournisseur et son contrôle consommateur.
public:
property bool IsActive { bool get(); };[System.ComponentModel.Browsable(false)]
public bool IsActive { get; }[<System.ComponentModel.Browsable(false)>]
member this.IsActive : boolPublic ReadOnly Property IsActive As BooleanValeur de propriété
true si la connexion est active ; sinon, false.
- Attributs
Exemples
L’exemple de code suivant illustre l’utilisation de la IsActive propriété .
L’exemple comporte trois parties :
Code source pour une interface et deux WebPart contrôles agissant en tant que fournisseur et consommateur pour une connexion.
Page web pour héberger tous les contrôles et exécuter l’exemple de code.
Explication de l’exécution de l’exemple de page.
La première partie de l’exemple de code est le code source de l’interface et les contrôles consommateur et fournisseur. 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 la 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é.
namespace Samples.AspNet.CS.Controls
{
using System;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public interface IZipCode
{
string ZipCode { get; set;}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class ZipCodeWebPart : WebPart, IZipCode
{
string zipCodeText = String.Empty;
TextBox input;
Button send;
public ZipCodeWebPart()
{
}
// Make the implemented property personalizable to save
// the Zip Code between browser sessions.
[Personalizable()]
public virtual string ZipCode
{
get { return zipCodeText; }
set { zipCodeText = value; }
}
// This is the callback method that returns the provider.
[ConnectionProvider("Zip Code Provider", "ZipCodeProvider")]
public IZipCode ProvideIZipCode()
{
return this;
}
protected override void CreateChildControls()
{
Controls.Clear();
input = new TextBox();
this.Controls.Add(input);
send = new Button();
send.Text = "Enter 5-digit Zip Code";
send.Click += new EventHandler(this.submit_Click);
this.Controls.Add(send);
}
private void submit_Click(object sender, EventArgs e)
{
if (!string.IsNullOrEmpty(input.Text))
{
zipCodeText = Page.Server.HtmlEncode(input.Text);
input.Text = String.Empty;
}
}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class WeatherWebPart : WebPart
{
private IZipCode _provider;
string _zipSearch;
Label DisplayContent;
// This method is identified by the ConnectionConsumer
// attribute, and is the mechanism for connecting with
// the provider.
[ConnectionConsumer("Zip Code Consumer", "ZipCodeConsumer")]
public void GetIZipCode(IZipCode Provider)
{
_provider = Provider;
}
protected override void OnPreRender(EventArgs e)
{
EnsureChildControls();
if (this._provider != null)
{
_zipSearch = _provider.ZipCode.Trim();
DisplayContent.Text = "My Zip Code is: " + _zipSearch;
}
}
protected override void CreateChildControls()
{
Controls.Clear();
DisplayContent = new Label();
this.Controls.Add(DisplayContent);
}
}
}
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Namespace Samples.AspNet.VB.Controls
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Interface IZipCode
Property ZipCode() As String
End Interface
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class ZipCodeWebPart
Inherits WebPart
Implements IZipCode
Private zipCodeText As String = String.Empty
Private input As TextBox
Private send As Button
Public Sub New()
End Sub
' Make the implemented property personalizable to save
' the Zip Code between browser sessions.
<Personalizable()> _
Public Property ZipCode() As String _
Implements IZipCode.ZipCode
Get
Return zipCodeText
End Get
Set(ByVal value As String)
zipCodeText = value
End Set
End Property
' This is the callback method that returns the provider.
<ConnectionProvider("Zip Code Provider", "ZipCodeProvider")> _
Public Function ProvideIZipCode() As IZipCode
Return Me
End Function
Protected Overrides Sub CreateChildControls()
Controls.Clear()
input = New TextBox()
Me.Controls.Add(input)
send = New Button()
send.Text = "Enter 5-digit Zip Code"
AddHandler send.Click, AddressOf Me.submit_Click
Me.Controls.Add(send)
End Sub
Private Sub submit_Click(ByVal sender As Object, _
ByVal e As EventArgs)
If input.Text <> String.Empty Then
zipCodeText = Page.Server.HtmlEncode(input.Text)
input.Text = String.Empty
End If
End Sub
End Class
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class WeatherWebPart
Inherits WebPart
Private _provider As IZipCode
Private _zipSearch As String
Private DisplayContent As Label
' This method is identified by the ConnectionConsumer
' attribute, and is the mechanism for connecting with
' the provider.
<ConnectionConsumer("Zip Code Consumer", "ZipCodeConsumer")> _
Public Sub GetIZipCode(ByVal Provider As IZipCode)
_provider = Provider
End Sub
Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
EnsureChildControls()
If Not (Me._provider Is Nothing) Then
_zipSearch = _provider.ZipCode.Trim()
DisplayContent.Text = "My Zip Code is: " + _zipSearch
End If
End Sub
Protected Overrides Sub CreateChildControls()
Controls.Clear()
DisplayContent = New Label()
Me.Controls.Add(DisplayContent)
End Sub
End Class
End Namespace
La deuxième partie de l’exemple de code est la page Web. Près du haut se trouve une Register directive qui fait référence au code source pour les deux contrôles compilés WebPart dynamiquement. La connexion statique est déclarée dans l’élément <StaticConnections> de la page. Dans l’élément <script> se trouvent quatre gestionnaires d’événements. Chaque gestionnaire d’événements vérifie la valeur de la IsActive propriété sur la connexion statique et écrit un message dans le Label contrôle indiquant si la connexion est active ou inactive à cet état de la page et du cycle de vie du contrôle. Cela montre à quel moment la connexion devient active et qu’elle reste active après le rendu de la page.
<%@ Page Language="C#" %>
<%@ register tagprefix="aspSample"
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">
<script runat="server">
protected void Button1_Click(object sender, EventArgs e)
{
WebPartConnection conn = mgr.StaticConnections[0];
if (conn.IsActive)
lbl1.Text += "<em>Connection 0 is active.</em>";
else
lbl1.Text += "Connection 0 is inactive.";
}
protected void mgr_ConnectionsActivated(object sender, EventArgs e)
{
if(mgr.Connections[0].IsActive)
lbl2.Text += "<em>Connection 0 is active.</em>";
else
lbl2.Text += "Connection 0 is inactive.";
}
protected void mgr_ConnectionsActivating(object sender, EventArgs e)
{
if (mgr.Connections[0].IsActive)
lbl3.Text += "<em>Connection 0 is active.</em>";
else
lbl3.Text += "Connection 0 is inactive.";
}
protected void Page_PreRender(object sender, EventArgs e)
{
if (mgr.Connections[0].IsActive)
lbl4.Text += "<em>Connection 0 is active.</em>";
else
lbl4.Text += "Connection 0 is inactive.";
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="mgr" runat="server"
onconnectionsactivated="mgr_ConnectionsActivated"
onconnectionsactivating="mgr_ConnectionsActivating">
<StaticConnections>
<asp:WebPartConnection ID="conn1"
ConsumerConnectionPointID="ZipCodeConsumer"
ConsumerID="weather1"
ProviderConnectionPointID="ZipCodeProvider"
ProviderID="zip1" />
</StaticConnections>
</asp:WebPartManager>
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<aspSample:ZipCodeWebPart ID="zip1" runat="server"
Title="Zip Code Provider" />
<aspSample:WeatherWebPart ID="weather1" runat="server"
Title="Zip Code Consumer" />
</ZoneTemplate>
</asp:WebPartZone>
<asp:ConnectionsZone ID="ConnectionsZone1" runat="server">
</asp:ConnectionsZone>
<asp:Button ID="Button1" runat="server"
Text="Connection Details"
OnClick="Button1_Click" />
<br />
<asp:Label ID="lbl1" runat="server">
<h3>Button_Click Status</h3>
</asp:Label>
<br />
<asp:Label ID="lbl2" runat="server">
<h3>ConnectionActivating Status</h3>
</asp:Label>
<br />
<asp:Label ID="lbl3" runat="server">
<h3>ConnectionActivated Status</h3>
</asp:Label>
<br />
<asp:Label ID="lbl4" runat="server">
<h3>ConnectionActivated Status</h3>
</asp:Label>
</div>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<%@ Register TagPrefix="aspSample"
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">
<script runat="server">
Protected Sub Button1_Click(ByVal sender As Object, _
ByVal e As System.EventArgs)
Dim conn As WebPartConnection = mgr.StaticConnections(0)
If conn.IsActive Then
lbl1.Text += "<em>Connection 0 is active.</em>"
Else
lbl1.Text += "Connection 0 is inactive."
End If
End Sub
Protected Sub mgr_ConnectionsActivated(ByVal sender As Object, _
ByVal e As System.EventArgs)
If mgr.Connections(0).IsActive Then
lbl2.Text += "<em>Connection 0 is active.</em>"
Else
lbl2.Text += "Connection 0 is inactive."
End If
End Sub
Protected Sub mgr_ConnectionsActivating(ByVal sender As Object, _
ByVal e As System.EventArgs)
If mgr.Connections(0).IsActive Then
lbl3.Text += "<em>Connection 0 is active.</em>"
Else
lbl3.Text += "Connection 0 is inactive."
End If
End Sub
Protected Sub Page_PreRender(ByVal sender As Object, _
ByVal e As System.EventArgs)
If mgr.Connections(0).IsActive Then
lbl4.Text += "<em>Connection 0 is active.</em>"
Else
lbl4.Text += "Connection 0 is inactive."
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="mgr" runat="server"
OnConnectionsActivated="mgr_ConnectionsActivated"
OnConnectionsActivating="mgr_ConnectionsActivating">
<StaticConnections>
<asp:WebPartConnection ID="conn1"
ConsumerConnectionPointID="ZipCodeConsumer"
ConsumerID="weather1"
ProviderConnectionPointID="ZipCodeProvider"
ProviderID="zip1" />
</StaticConnections>
</asp:WebPartManager>
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<aspSample:ZipCodeWebPart ID="zip1" runat="server"
Title="Zip Code Provider" />
<aspSample:WeatherWebPart ID="weather1" runat="server"
Title="Zip Code Consumer" />
</ZoneTemplate>
</asp:WebPartZone>
<asp:ConnectionsZone ID="ConnectionsZone1" runat="server">
</asp:ConnectionsZone>
<asp:Button ID="Button1" runat="server"
Text="Connection Details"
OnClick="Button1_Click" />
<br />
<asp:Label ID="lbl1" runat="server">
<h3>Button_Click Status</h3>
</asp:Label>
<br />
<asp:Label ID="lbl2" runat="server">
<h3>ConnectionActivating Status</h3>
</asp:Label>
<br />
<asp:Label ID="lbl3" runat="server">
<h3>ConnectionActivated Status</h3>
</asp:Label>
<br />
<asp:Label ID="lbl4" runat="server">
<h3>ConnectionActivated Status</h3>
</asp:Label>
</div>
</form>
</body>
</html>
Chargez la page dans un navigateur. La connexion statique est déjà créée et des messages ont déjà été écrits dans les étiquettes indiquant si la connexion était active à différents points de la page et du cycle de vie du contrôle. Cliquez sur le bouton Détails de la connexion et notez que la connexion n’est pas active à ce stade, mais que la connexion est réactivée à chaque fois après l’événement ConnectionsActivated et qu’elle est toujours active (et le restera) après l’événement PreRender de la page.
Remarques
La IsActive propriété indique un état d’un WebPartConnection objet. Lorsque la connexion est dans cet état, les contrôles fournisseur et consommateur de la connexion communiquent et peuvent échanger des données via une interface commune ou un WebPartTransformer objet.
Lorsqu’un utilisateur consulte une page rendue qui inclut une connexion établie en mode de navigation normal, la connexion est généralement active (sauf si elle n’a pas pu être activée en raison d’un conflit ou d’un autre problème lors du chargement de la page). Dans les premières étapes du cycle de vie de la page et du contrôle, la valeur de la propriété est false. La connexion est activée juste après la levée de l’événement ConnectionsActivated sur le WebPartManager contrôle. Plus précisément, la connexion est activée une fois que le consommateur a récupéré une instance de l’interface spécifiée à partir du fournisseur ou d’un WebPartTransformer objet.
Il est utile de savoir si une connexion est active dans les situations où il peut y avoir des conflits ou des problèmes de synchronisation dus à plusieurs connexions sur une page. Par exemple, s’il existe un type de conflit entre deux connexions, le WebPartManager contrôle a la possibilité de ne pas activer l’une des connexions pour éviter le conflit.
