Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: ucb ::

interface XCommandInfo
Description
provides access to information on a set of commands.

Methods' Summary
getCommands obtains information for all supported commands.  
getCommandInfoByName returns information for a specific command.  
getCommandInfoByHandle returns information for a specific command.  
hasCommandByName checks whether a command specific is supported.  
hasCommandByHandle checks whether a apecific command is supported.  
Methods' Details
getCommands
sequence< CommandInfo >
getCommands();

Description
obtains information for all supported commands.
Returns
a sequence with information for all supported commands.
getCommandInfoByName
CommandInfo
getCommandInfoByName( [in] string  Name )
raises( UnsupportedCommandException );

Description
returns information for a specific command.
Returns
the information for the requested command.
Parameter Name
specifies the name of the requested command.
Throws
UnsupportedCommandException if the command is not supported.
getCommandInfoByHandle
CommandInfo
getCommandInfoByHandle( [in] long  Handle )
raises( UnsupportedCommandException );

Description
returns information for a specific command.
Returns
the information for the requested command.
Parameter Handle
specifies the handle of the requested command.
Throws
UnsupportedCommandException if the command is not supported.
hasCommandByName
boolean
hasCommandByName( [in] string  Name );

Description
checks whether a command specific is supported.
Returns
true if a command with the specified name is supported; otherwise false is returned.
Parameter Name
specifies the name of the requested command.
hasCommandByHandle
boolean
hasCommandByHandle( [in] long  Handle );

Description
checks whether a apecific command is supported.
Returns
true if a command with the specified handle is supported; otherwise false is returned.
Parameter Name
specifies the handle of the requested command.
Top of Page

Apache Software Foundation

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

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