ConnectionsZone.ConsumersInstructionText Property


Gets or sets the instructional text shown in the consumers section of the connection user interface (UI), when a connection already exists.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public virtual string ConsumersInstructionText { get; set; }

Property Value

Type: System.String

A string serving as the instructional text for consumers participating in a connection. The default text is a culture-specific string supplied by the .NET Framework.

The ConsumersInstructionText property takes effect in a specific connection scenario. When a user clicks the connect verb on a provider control, and a connection already exists, the ConnectionsZone control displays a view that enables users to disconnect the connection. The view also shows any consumers participating in the connection. Just above the list of consumers is the consumers instruction text, which by default is more of a description of what consumer controls do in a connection.

You can set the value of this property declaratively within the opening tag of the <asp:connectionszone> element, by adding an attribute named ConsumersInstructionText and assigning it a value. You can also set the property value programmatically.

The following code example demonstrates the use of the ConsumersInstructionText property with a ConnectionsZone control. The example contains only the code for the Web page that demonstrates use of the property; for the other two code files needed to run the example, see the Example section of the ConnectionsZone class overview. The code example has four parts:

  • A user control that enables you to switch display modes on the Web page. Obtain this code from the ConnectionsZone class overview.

  • A source file that contains the code for a ZIP Code interface, and two WebPart controls acting as the provider and the consumer for a connection. Obtain this code from the ConnectionsZone class overview.

  • A Web page that hosts all the controls, declares an <asp:connectionszone> element, and shows how to use the property programmatically.

  • An explanation of how the example works in a browser.

The Web page declares an <asp:connectionszone> element and, in the Page_PreRender method, the code assigns a value to the ConsumersInstructionText property.

<%@ Page Language="C#" %>
<%@ register tagprefix="uc1" 
    src="~/displaymodemenucs.ascx" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="Samples.AspNet.CS.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 

<script runat="server">

  protected void Page_PreRender(object sender, EventArgs e)
     // Set properties on verbs.
     connectionsZone1.CancelVerb.Description = 
       "Terminates the connection process";
     connectionsZone1.CloseVerb.Description = 
       "Closes the connections UI";
     connectionsZone1.ConfigureVerb.Description =
       "Configure the transformer for the connection";
     connectionsZone1.ConnectVerb.Description =
       "Connect two WebPart controls";
     connectionsZone1.DisconnectVerb.Description =
       "End the connection between two controls";

     // Set properties for UI text strings.
     connectionsZone1.ConfigureConnectionTitle = 
     connectionsZone1.ConnectToConsumerInstructionText = 
       "Choose a consumer connection point";
     connectionsZone1.ConnectToConsumerText = 
       "Select a consumer for the provider to connect with";
     connectionsZone1.ConnectToConsumerTitle = 
       "Send data to this consumer";
     connectionsZone1.ConnectToProviderInstructionText =
       "Choose a provider connection point";
     connectionsZone1.ConnectToProviderText =
       "Select a provider for the consumer to connect with";
     connectionsZone1.ConnectToProviderTitle =
       "Get data from this provider";
     connectionsZone1.ConsumersInstructionText = 
       "WebPart controls that receive data from providers";
     connectionsZone1.ConsumersTitle = "Consumer Controls";
     connectionsZone1.GetFromText = "Receive from";
     connectionsZone1.GetText = "Retrieve";
     connectionsZone1.HeaderText = 
      "Create and Manage Connections";
     connectionsZone1.InstructionText = 
      "Manage connections for the selected WebPart control";
     connectionsZone1.InstructionTitle = 
       "Manage connections for consumers or providers";
     connectionsZone1.NoExistingConnectionInstructionText = 
       "No connections exist. Click the above link to create "
       + "a connection.";
     connectionsZone1.NoExistingConnectionTitle = 
       "No current connections";
     connectionsZone1.ProvidersInstructionText =
       "WebPart controls that send data to consumers";
     connectionsZone1.ProvidersTitle = "Provider controls";


<html xmlns="" >
<head runat="server">
    <title>Connection Zone Sample</title>
  <form id="form1" runat="server">
  <asp:webpartmanager runat="server" id="mgr">
      <asp:webpartconnection id="connection1" 
        providerid="zipProvider" />
  <uc1:displaymodemenucs id="menu1" runat="server" />
  <asp:webpartzone id="WebPartZone1" runat="server">
      <aspsample:zipcodewebpart id="zipProvider" runat="server" 
        Title="Zip Code Provider"  />
      <aspsample:weatherwebpart id="zipConsumer" runat="server" 
        Title="Zip Code Consumer" />
  <asp:connectionszone id="connectionsZone1" runat="server" >
    <cancelverb text="Terminate" />
    <closeverb text="Close Zone" />
    <configureverb text="Configure" />
    <connectverb text="Connect Controls" />
    <disconnectverb text="End Connection" />

Load the page in a browser. Switch to connect mode, using the Display Mode control. Click the verbs menu arrow on the ZIP Code Provider control, and click the connect verb. In the view that opens for the existing connection, look in the consumers section for the custom text assigned to the ConsumersInstructionText property.

.NET Framework
Available since 2.0
Return to top