interface XCommandInfo in module com::sun::star::ucb::

(Global Index)

Syntax

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

Description

provides access to information on a set of commands.

Method 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.

Method Details



getCommands

Syntax

sequence< com::sun::star::ucb::CommandInfo > getCommands ();

Description

obtains information for all supported commands.

Returns

a sequence with information for all supported commands.

getCommandInfoByName

Syntax

com::sun::star::ucb::CommandInfo getCommandInfoByName (
string Name )
raises ( com::sun::star::ucb::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

Syntax

com::sun::star::ucb::CommandInfo getCommandInfoByHandle (
long Handle )
raises ( com::sun::star::ucb::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

Syntax

boolean hasCommandByName (
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

Syntax

boolean hasCommandByHandle (
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