ConnectionsZone::HeaderText Property
Gets or sets the header text that appears at the top of the connection user interface (UI) created by the ConnectionsZone control.
Assembly: System.Web (in System.Web.dll)
public: property String^ HeaderText { virtual String^ get() override; virtual void set(String^ value) override; }
Property Value
Type: System::String^A string that contains the header text for the connection UI. The default text is a culture-specific string supplied by the .NET Framework.
The text contained in the HeaderText property is visible whenever the connection UI is displayed. When a user clicks the connect verb on the verbs menu of a WebPart control, the connection UI appears, and the header text serves as a label at the very top of the connection UI. The default text is Connections Zone.
This property overrides the base HeaderText property from the WebZone class, so that the default connections zone header text can be assigned to the property.
You can set the value of this property declaratively within the opening tag of the <asp:connectionszone> element, by adding an attribute named HeaderText and assigning it a value. You can also set the property value programmatically.
The following code example demonstrates the use of the HeaderText 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 HeaderText 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 Consumer control, and click the connect verb. In the view that opens for the existing connection, note that the header text at the top of the connections zone is the value assigned to the HeaderText property in the code example.
Available since 2.0