CatalogZoneBase.InstructionText Property

 

Gets or sets the text in a zone that provides directions for end users.

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

override InstructionText : string with get, set

Property Value

Type: System.String

A string that contains the directions for end users. A default, culture-specific string is provided by the Web Parts control set.

The string value of the InstructionText property is displayed just below the header area of a CatalogZoneBase zone. The text of the InstructionText property is displayed when a page enters catalog mode and the catalog user interface (UI) becomes visible.

The purpose of the InstructionText property is to provide the user with general instructions on what to do when the catalog UI is displayed.

The following code example demonstrates how to use the InstructionText property declaratively and programmatically. For the full code required to run the example, see the Example section of the CatalogZoneBase class overview.

Notice that the code example declares two <asp:catalogzone> elements, and the first one declares a value for the InstructionText property.

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

In the second part of the code example, the value of the InstructionText property in the first zone is programmatically assigned to a different value.

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

When you load the page in a browser, you can select Catalog from the drop-down list to switch to catalog display mode. When the catalog is visible, notice the value of the InstructionText property displayed in the header area of each zone. You can click the Set Zone Text Properties button, and the InstructionText property of the upper zone is set to the value assigned to it in the code.

.NET Framework
Available since 2.0
Return to top
Show: