IHYCrossPlatformAction

Overview

The IHYCrossPlatformAction interface describes an action item that can be passed between platforms. This interface is used internally to transfer actions, you don't need to use this interface directly, instead you can IHYPlugin to get access to a list of actions.

Location


 

Caption

Gets or sets action title.

property Caption: WideString read write

Checked

Gets or sets value that defines whether action is checked.

property Checked: WordBool read write

DoExecute  safecall

This method is called whenever action is executed.

procedure DoExecute

DoUpdate  safecall

This method is called whenever action is updated.

procedure DoUpdate

Enabled

Gets or sets value that defines whether action is enabled.

property Enabled: WordBool read write

Hint

Gets or sets action hint message.

property Hint: WideString read write

ImageIndex

Gets or sets action image index.

property ImageIndex: Integer read write

Name

Gets or sets name of the action.

property Name: WideString read write

RequiredPrivilege

Gets or sets custom string that defines a privileges that is required to use this action.

property RequiredPrivilege: WideString read write

SetActionLink  safecall

Sets reference to an instance of the action link.

procedure SetActionLink(const Link: IHYCrossPlatformActionLink)

Parameters:

  • Link: Reference to an instance of the action link.

UserData

Gets or sets user defined data.

property UserData: WideString read write

Visible

Gets or sets value that defines whether action is visible.

property Visible: WordBool read write

 

Caption

Gets or sets action title.

property Caption: WideString read write

Checked

Gets or sets value that defines whether action is checked.

property Checked: WordBool read write

Enabled

Gets or sets value that defines whether action is enabled.

property Enabled: WordBool read write

Hint

Gets or sets action hint message.

property Hint: WideString read write

ImageIndex

Gets or sets action image index.

property ImageIndex: Integer read write

Name

Gets or sets name of the action.

property Name: WideString read write

RequiredPrivilege

Gets or sets custom string that defines a privileges that is required to use this action.

property RequiredPrivilege: WideString read write

UserData

Gets or sets user defined data.

property UserData: WideString read write

Visible

Gets or sets value that defines whether action is visible.

property Visible: WordBool read write

 

DoExecute  safecall

This method is called whenever action is executed.

procedure DoExecute

DoUpdate  safecall

This method is called whenever action is updated.

procedure DoUpdate

SetActionLink  safecall

Sets reference to an instance of the action link.

procedure SetActionLink(const Link: IHYCrossPlatformActionLink)

Parameters:

  • Link: Reference to an instance of the action link.

 

  • IHYCrossPlatformAction Interface