Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: util ::

interface XLocalizedAliases
Description
is the interface for binding programmatic names to aliases. Aliases can be provided in several locales for the same programmatic name.

Methods' Summary
bindAlias registers an alias for a programmatic name.  
unbindAlias revokes an alias for a programmatic name.  
lookupAlias retrieves a registered porgrammatic name identified by an alias.  
lookupProgrammatic retrieves a given alias for a programmatic name.  
unbindAliases removes all aliases for a programmatic name.  
rebindAliases rebinds all aliases registered to a given URL to a new one.  
renameAlias renames an alias for a programmatic name.  
listAliases retrieves a list of all registered aliases for a certain language.  
Methods' Details
bindAlias
void
bindAlias( [in] string  programmaticName,
[in] ::com::sun::star::lang::Locale  locale,
[in] string  alias )
raises( ::com::sun::star::container::ElementExistException );

Description
registers an alias for a programmatic name.
unbindAlias
void
unbindAlias( [in] ::com::sun::star::lang::Locale  locale,
[in] string  alias )
raises( ::com::sun::star::container::NoSuchElementException );

Description
revokes an alias for a programmatic name.
lookupAlias
string
lookupAlias( [in] ::com::sun::star::lang::Locale  locale,
[in] string  Alias )
raises( ::com::sun::star::container::NoSuchElementException );

Description
retrieves a registered porgrammatic name identified by an alias.
lookupProgrammatic
string
lookupProgrammatic( [in] ::com::sun::star::lang::Locale  locale,
[in] string  programmatic )
raises( ::com::sun::star::container::NoSuchElementException );

Description
retrieves a given alias for a programmatic name.
unbindAliases
void
unbindAliases( [in] string  programmaticName )
raises( ::com::sun::star::container::NoSuchElementException );

Description
removes all aliases for a programmatic name.
rebindAliases
void
rebindAliases( [in] string  currentProgrammatic,
[in] string  newProgrammatic )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::container::ElementExistException );

Description
rebinds all aliases registered to a given URL to a new one.
renameAlias
void
renameAlias( [in] ::com::sun::star::lang::Locale  locale,
[in] string  oldName,
[in] string  aNewName )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::container::ElementExistException );

Description
renames an alias for a programmatic name.
listAliases
sequence< AliasProgrammaticPair >
listAliases( [in] ::com::sun::star::lang::Locale  locale );

Description
retrieves a list of all registered aliases for a certain language.
Parameter locale
specifies the locale scope.
Returns
a sequence of registered pair of alias and programmatic name.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.