ConnectionsZone::ConnectToProviderInstructionText Property

 

Gets or sets the instructional text displayed in the section of the connection user interface (UI) where users select a provider connection point that the consumer will connect to.

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

public:
property String^ ConnectToProviderInstructionText {
	virtual String^ get();
	virtual void set(String^ value);
}

Property Value

Type: System::String^

A string containing the instructions on creating a provider connection to the consumer. The default text is a culture-specific string supplied by the .NET Framework.

The ConnectToProviderInstructionText property takes effect in a specific connection scenario. When a user clicks the connect verb on a consumer control, the ConnectionsZone control displays a portion of the connection UI that enables users to select a provider. If the user clicked a connect verb on the provider, then the connection UI would do the reverse, and display information about connecting to a consumer.

The text in the ConnectToProviderInstructionText property is displayed just above the drop-down list controls that contain the available provider connection points to which a consumer can be connected.

You can set this property declaratively, by using the ConnectToProviderInstructionText 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 ConnectToProviderInstructionText 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 ConnectToProviderInstructionText 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 Consumer control, and click the connect verb. Click the End Connection button to end the connection, and then click the Select a provider for the consumer to connect with hyperlink. The provider connection UI appears, and the custom text assigned to the ConnectToProviderInstructionText property appears just above the area with the control that allows you to select a connection point on the provider for connecting with the consumer.

.NET Framework
Available since 2.0
Return to top
Show: