Redigera

Dela via

Metadata localization overview

  • Artikel

Some metadata defined inside of configuration objects support localization. Properties that support localization are adorned with LocalizableStringAttribute and the compiler emits a warning if these properties are set to a non-localizable value. These values can be localized by including string-resources.json files with your extension and surrounding the string resource key with % characters.

A Command with a localized DisplayName and ToolTipText looks like the following:

public override CommandConfiguration CommandConfiguration => new("%Microsoft.VisualStudio.MyExtension.SampleRemoteCommand.DisplayName%")
{
    ToolTipText = "%Microsoft.VisualStudio.MyExtension.SampleRemoteCommand.ToolTipText%"
}

string-resources.json

Your extension should provide a string-resources.json file for every language that your extension supports. This JSON file is a dictionary of key/value pairs where the key is a globally (all of Visual Studio) unique identifier for a string resource and the value is the localized string resource. These JSON files should be deployed with your extension under the .vsextension directory, with each language you support being shipped in a folder matching the name of the locale, that is, "de" for German, "it" for Italian, etc. The string-resources.json deployed at the root of the .vsextension directory is used as the default if your extension doesn't support the language that Visual Studio is currently set to. An example of what this directory structure would look like can be seen here:

Localization directory structure

string-resources.json sample:

{
    "Microsoft.VisualStudio.MyExtension.SampleRemoteCommand.DisplayName": "Sample Remote Command Display Name",
    "Microsoft.VisualStudio.MyExtension.SampleRemoteCommand.ToolTipText": "Sample Remote Command ToolTip"
}

Next steps

Learn more about VisualStudio.Extensibility commands at Add Visual Studio commands.