Jam.Shell.Types.TShellCommand

This type encapsulates a shell context menu command.

Syntax

Pascal

TShellCommand = record
  Destination: string;
  OperationOptions: TOperationOptions;
end;

Remarks

It is compatible with command verbs which are strings but also supports a set of well defined command defined through the TShellAction enum. Several implicit operators take care of necessary conversions.

To e.g. check a TShellCommand that is passed via some event, you can simply write

 if (command = TShellAction.saOpen) then ...

 if (command = 'open') then ...

Namespace

Jam.Shell.Types

Public Methods

	Name	Description
	constructor Create(pCommand: TShellAction; const pDestination: string = ''); overload;	Creates and initializes a TShellCommand.

TShellCommand Fields

	Name	Description
	Destination: string;	This member can be used for command that need an additional string parameter, like rename, create folder or move.
	OperationOptions: TOperationOptions;	Defines which kind of user interaction is allowed.

TShellCommand Methods

	Name	Description
	function Equals(const pCommand: TShellCommand): Boolean; overload;	Compares the TShellAction to a command supplied as string.
	function Equals(const pCommand: string): Boolean; overload;	Compares the TShellAction to a command supplied as string.
	function ToCommand: String;	Returns a shell command for a TShellAction enum.
	function ToString(pWithAccelerators: Boolean = True): String;	Returns a label for a TShellAction enum.

TShellCommand Operators

	Name	Description
	class operator Equal(pCommand1: TShellCommand; pCommand2: TShellAction);	Allows to compare a TShellCommand with a TShellAction.
	class operator Equal(pCommand1: TShellCommand; pCommand2: TShellCommand);	Allows to compare two TShellCommands.
	class operator Equal(pCommand1: TShellCommand; const pCommand2: string);	Allows to compare a TShellCommand with a command verb as string.
	class operator Implicit(pCommand: TShellAction);	Converts a TShellAction into a TShellCommand.
	class operator In(pCommand1: TShellCommand; pCommand2: TShellActions);	Allows to check if a TShellCommand is in a set of TShellActions.
	class operator NotEqual(pCommand1: TShellCommand; pCommand2: TShellAction);	Allows to compare a TShellCommand with a TShellAction.

Links

Jam.Shell.Types, Legend, Members, Public Methods, TShellCommand Fields, TShellCommand Methods, TShellCommand Operators

Contents | Index | Home