ImportCatalogPart.UploadHelpText Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets or sets the text of the message that tells the user how to upload a description file.

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

member UploadHelpText : string with get, set

Property Value

Type: System.String

A string that is used as instructions for the user to upload a description file. The default value is a culture-specific string supplied by the Web Parts control set.

The UploadHelpText property provides a brief sentence or phrase of instructions for users, telling them to click a button to upload the description file. If you assign custom text to this property, or to the UploadButtonText property, the text should make clear that the user is uploading a description file. The text should not say or imply that the upload process is actually uploading the control itself.

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

In the following section of code, notice that the UploadHelpText property value is set declaratively for the control.

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

In this section of code, the UploadHelpText property value is assigned programmatically.

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

When you load the page in a browser, you can use the Display Mode drop-down list control to select Catalog Mode and switch the page to catalog mode. With the page in catalog mode and the description file uploaded, note the various text strings displayed in the user interface (UI) for the ImportCatalogPart control. If you click the Upload Description File button, the text for several of the properties in the UI is changed, including the text for the UploadHelpText property.

.NET Framework
Available since 2.0
Return to top