ConnectionsZone.ConnectToConsumerInstructionText Property
Assembly: System.Web (in system.web.dll)
public: virtual property String^ ConnectToConsumerInstructionText { String^ get (); void set (String^ value); }
/** @property */ public String get_ConnectToConsumerInstructionText () /** @property */ public void set_ConnectToConsumerInstructionText (String value)
public function get ConnectToConsumerInstructionText () : String public function set ConnectToConsumerInstructionText (value : String)
Property Value
A string containing the instructions for creating a consumer connection to the provider. The default text is a culture-specific string supplied by the .NET Framework.The ConnectToConsumerInstructionText property takes effect in a specific connection scenario. When a user clicks the connect verb on a provider control, the ConnectionsZone control displays a portion of the connection UI that enables users to select a consumer. If the user clicked a connect verb on the consumer, then the connection UI would do the reverse, and display information about connecting to a provider.
The text in the ConnectToConsumerInstructionText property is displayed just above the drop-down list controls that contain the available consumer connection points to which a provider can be connected.
You can set this property declaratively, by using the ConnectToConsumerInstructionText attribute in the opening tag of the <asp:connectionszone> element in a page, or you can set the property programmatically.
The following code example demonstrates the use of the ConnectToConsumerInstructionText 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 ConnectToConsumerInstructionText property.
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. Click the End Connection button to end the connection, and then click the Select a consumer for the provider to connect with hyperlink. The consumer connection UI appears, and the custom text assigned to the ConnectToConsumerInstructionText property appears just above the area with the control that allows you to select a connection point on the consumer for connecting with the provider.
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.