Share via


IExtension.LocalizedName Property

Gets the localized name of the extension to be displayed in a user interface.

Namespace:  Microsoft.ReportingServices.Interfaces
Assemblies:   Microsoft.ReportingServices.Interfaces (in Microsoft.ReportingServices.Interfaces.dll)
  Microsoft.ReportingServices.SharePoint.UI.WebParts (in Microsoft.ReportingServices.SharePoint.UI.WebParts.dll)

Syntax

'Declaration
ReadOnly Property LocalizedName As String
    Get
'Usage
Dim instance As IExtension
Dim value As String

value = instance.LocalizedName
string LocalizedName { get; }
property String^ LocalizedName {
    String^ get ();
}
abstract LocalizedName : string
function get LocalizedName () : String

Property Value

Type: System.String
The localized name of the extension.

Remarks

The LocalizedName property is called by the report server to retrieve the localized name of the extension. Your extension should set the localized name based on the locale of the calling thread. You can use the CultureInfo class in System.Globalization namespace to discover the locale settings of the thread. For more information, see "System.Globalization Namespace" in the Microsoft .NET Framework SDK documentation.

Note

A Reporting Services extension class should always provide the LocalizedNameAttribute attribute. If the LocalizedNameAttribute attribute has not been applied to the extension class, the Reporting Services engine will attempt to examine the LocalizedName property of the extension class; because this requires constructing an instance of the extension, this may incur a performance penalty.

Examples

The following code snippet shows the LocalizedNameAttribute being set on an extension class:

namespace PolygonsCRI

{

[LocalizedName("Polygons")]

[Editor(typeof(CustomEditor), typeof(ComponentEditor))]

[ToolboxBitmap(typeof(PolygonsDesigner),"Polygons.ico")]

// this CRI-specific attribute sets the name of the

// custom report item which is referenced by the config

// files and saved in the report definition language

[CustomReportItem("Polygons")]

// the main class for our CRI design-time component

public class PolygonsDesigner : CustomReportItemDesigner

{

...

}