IMyTerminalControlButton Interface

v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

This is a control button. When a button is clicked an action is performed.

Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public interface IMyTerminalControlButton : IMyTerminalControl, 
	IMyTerminalControlTitleTooltip

Public Interface IMyTerminalControlButton
	Inherits IMyTerminalControl, IMyTerminalControlTitleTooltip

public interface class IMyTerminalControlButton : IMyTerminalControl, 
	IMyTerminalControlTitleTooltip

type IMyTerminalControlButton =  
    interface
        interface IMyTerminalControl
        interface IMyTerminalControlTitleTooltip
    end

The IMyTerminalControlButton type exposes the following members.

Methods

	Name	Description
	RedrawControl	Recreates the control GUI. This allows you to update the Title of some controls. (Inherited from IMyTerminalControl.)
	UpdateVisual	This updates a control that is currently displayed, allowing you to refresh it's state (Inherited from IMyTerminalControl.)

Properties

	Name	Description
	Action	The action taken when a button is clicked
	Enabled	Allows you to set if the control is enabled (Inherited from IMyTerminalControl.)
	Id	Identifier of control (Inherited from IMyTerminalControl.)
	SupportsMultipleBlocks	Allows you to set if the control is visible when the block is selected as a group (Inherited from IMyTerminalControl.)
	Title	Allows you to get or set the Label that appears on the control (Inherited from IMyTerminalControlTitleTooltip.)
	Tooltip	Allows you to get or set the tooltip that appears when you hover over the control (Inherited from IMyTerminalControlTitleTooltip.)
	Visible	Allows you to set if the control is visible (Inherited from IMyTerminalControl.)