ConnectionsZone::ConnectToConsumerTitle Property

 

Gets or sets the title text of the section in the connection user interface (UI) in which users can select a specific consumer to connect with.

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

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

Property Value

Type: System::String^

A string serving as the title of the section where users select consumers. The default title is a culture-specific string supplied by the .NET Framework.

The ConnectToConsumerTitle property takes effect in a specific connection scenario. When users click the connect verb on a provider control, and no connection exists, they eventually arrive at a view in which they can select a consumer to connect with the previously selected provider. The title of this view is supplied by the ConnectToConsumerTitle property.

You can set this property declaratively, by using the ConnectToConsumerTitle 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 ConnectToConsumerTitle 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 ConnectToConsumerTitle 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. Click the End Connection button to end the connection, and then click the link to select a consumer. In the view for selecting a consumer, note that the title text of the section is the text that the code assigns to the ConnectToConsumerTitle property.

.NET Framework
Available since 2.0
Return to top
Show: