IExtension.LocalizedName Property

Definition

Namespace:

Microsoft.ReportingServices.Interfaces

Assemblies:

Microsoft.ReportingServices.Interfaces.dll, Microsoft.ReportingServices.SharePoint.UI.WebParts.dll

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

public:
 property System::String ^ LocalizedName { System::String ^ get(); };

public string LocalizedName { get; }

member this.LocalizedName : string

Public ReadOnly Property LocalizedName As String

Property Value

String

The localized name of the extension.

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`  
`{`  
`...`  
`}`  

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.