WebPart.ImportErrorMessage Property


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

Gets or sets an error message that is used if errors occur when a WebPart control is imported.

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

public virtual string ImportErrorMessage { get; set; }

Property Value

Type: System.String

A string that contains the error message. The default value is a standard error message supplied by the Web Parts control set.

The ImportErrorMessage property allows you to set a custom error message that is displayed if an error occurs when a user tries to import a part control's description file into a catalog of Web Parts controls. You can set the property declaratively on a WebPart control, adding the ImportErrorMessage attribute within the opening tag of the control and assigning an error message string to it. You can also set the property value programmatically.

For a full code example that demonstrates both exporting and importing .WebPart description files for WebPart controls, which includes use of the ImportErrorMessage property, see the ImportCatalogPart class.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

The personalization scope of this property is set to Shared and can be modified only by authorized users. For more information, see PersonalizableAttribute and Web Parts Personalization Overview.

.NET Framework
Available since 2.0
Return to top