This documentation is archived and is not being maintained.

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 property String^ ConsumersInstructionText {
	String^ get ();
	void set (String^ value);
}
<asp:ConnectionsZone ConsumersInstructionText="String" />

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.

No code example is currently available or this language may not be supported.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: