Class TrackCommandBarControlEventArgs

Provides data for the TrackCommandBarControl event

Inheritance

object

EventArgs

TrackCommandBarControlEventArgs

Namespace: ABB.Robotics.RobotStudio.Environment

Assembly: ABB.Robotics.RobotStudio.Environment.dll

Syntax

public class TrackCommandBarControlEventArgs : EventArgs

Properties

Container

Returns the container (or parent) of the control being tracked.

Declaration

public ICommandBarControlContainer Container { get; }

Property Value

Type	Description
ICommandBarControlContainer

Remarks

Typically this is either a CommandBarPopup or a CommandBar.

DisabledReason

If the command is disabled, this text will be displayed in e.g. tooltips to explain the reason why it is disabled.

Declaration

public string DisabledReason { get; set; }

Property Value

Type	Description
string

Enabled

Returns true if the control is currently enabled, false otherwise

Declaration

public bool Enabled { get; }

Property Value

Type	Description
bool

Remarks

Note that this property may return a different value from CommandBarControl.Enabled, since the control's enabled status also can be modified by the UpdateCommandUI event.

HelpText

Gets or sets the help text that will be displayed in ScreenTips, as well as in CommandBarGalleryPopups with the GalleryTextPosition property set to 'Right'

Declaration

public string HelpText { get; set; }

Property Value

Type	Description
string

Id

Returns the ID of the CommandBarControl being tracked. This is provided for convenience; The control ID can also be found by casting the sender argument to CommandBarControl.

Declaration

public string Id { get; }

Property Value

Type	Description
string

Tag

Returns the Tag of the CommandBarControl being tracked, or of the tracked item in a CommandBarControlGroup.

Declaration

public object Tag { get; }

Property Value

Type	Description
object

ToolTip

This property is obsolete and may be removed in a future version.

Declaration

[Obsolete("Use HelpText instead")]
public string ToolTip { get; set; }

Property Value

Type	Description
string

Remarks

Use the 'HelpText' property instead to assign text to a control's ScreenTip.