IHYCrossPlatformAction

Overview

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

Location

Reference: RemObjects.Hydra.dll
Namespace: RemObjects.Hydra.CrossPlatform
Ancestry: IHYCrossPlatformInterface | IHYCrossPlatformAction

Caption

Stores action title.

property Caption: String read write;

String Caption { get; set; }

var Caption: String { get{} set{} }

Property Caption() As String

Checked

Defines whether action is checked.

property Checked: Boolean read write;

Boolean Checked { get; set; }

var Checked: Boolean { get{} set{} }

Property Checked() As Boolean

DoExecute

This method is called whenever action is executed.

method DoExecute

void DoExecute()

func DoExecute()

Sub DoExecute()

DoUpdate

This method is called whenever action is updated.

method DoUpdate

void DoUpdate()

func DoUpdate()

Sub DoUpdate()

Enabled

Defines whether action is enabled.

property Enabled: Boolean read write;

Boolean Enabled { get; set; }

var Enabled: Boolean { get{} set{} }

Property Enabled() As Boolean

Hint

Stores action hint message.

property Hint: String read write;

String Hint { get; set; }

var Hint: String { get{} set{} }

Property Hint() As String

ImageIndex

Stores action image index.

property ImageIndex: Int32 read write;

Int32 ImageIndex { get; set; }

var ImageIndex: Int32 { get{} set{} }

Property ImageIndex() As Int32

Name

Holds name of the action.

property Name: String read write;

String Name { get; set; }

var Name: String { get{} set{} }

Property Name() As String

RequiredPrivilege

Custom string that defines a privileges that is required to use this action.

property RequiredPrivilege: String read write;

String RequiredPrivilege { get; set; }

var RequiredPrivilege: String { get{} set{} }

Property RequiredPrivilege() As String

SetActionLink

Sets an action link that is associated with this action.

method SetActionLink(link: IHYCrossPlatformActionLink)

void SetActionLink(IHYCrossPlatformActionLink link)

func SetActionLink(_ link: IHYCrossPlatformActionLink)

Sub SetActionLink(link As IHYCrossPlatformActionLink)

Parameters:

link: Reference to the action link.

UserData

Stores user defined data.

property UserData: String read write;

String UserData { get; set; }

var UserData: String { get{} set{} }

Property UserData() As String

Visible

Defines whether action is visible.

property Visible: Boolean read write;

Boolean Visible { get; set; }

var Visible: Boolean { get{} set{} }

Property Visible() As Boolean