interface XServiceDisplayName in module com::sun::star::lang::

(Global Index)

Syntax

interface XServiceDisplayName : com::sun::star::uno::XInterface ;

Description

provides a name for the service to be used in displays.

This name can be used in displays (dialogs, menus, etc.) to provide a more memorable / meaningful name than the service name or its implementation name. It should not be used to identify / select a specific service / implementation.

Method Summary

getServiceDisplayName returns the display name of the service for a given language.

Method Details



getServiceDisplayName

Syntax

string getServiceDisplayName (
com::sun::star::lang::Locale aLocale );

Description

returns the display name of the service for a given language.

The caller may specify a Locale for the preferred language of the resulting string. However if that locale is not supported the resulting string may be given in a different language. Usually this should be English.

Parameter aLocale

the preferred language for the resulting display name.

Returns

the string to be used for the service in displays.
Top of Page