InputMapActionID Enumeration

In This Topic

Actions that can be mapped to the workspace settings WorkspaceDefaults.StartupAction property in an InputMapSequenceAction, when WorkspaceDefaults.WorkspaceStartupOption property is mapped to ApplicationStartupEnum.RunStartupAction.

Syntax

Visual Basic
C#

'Declaration
 
Public Enum InputMapActionID 
   Inherits System.Enum

'Usage
 
Dim instance As InputMapActionID

public enum InputMapActionID : System.Enum

Members

Member	Description
DoNothingAction	This is an action that has no operation. Requires no parameters.
FullScreenViewAction	Puts the Reflection frame in full screen mode. Requires no parameters.
GlobalSettingsAction	Opens the Reflection Desktop global configuration settings. Requires no parameters.
HelpAction	Opens the Help system in a separate window. Requires no parameters.
LaunchApplicationAction	Starts an external application. This action requires three parameters (in order): The full path to the application executable file, of type string. Optional arguments for the application's command line of type string. Specify an empty string if no arguments are necessary. An optional working directory for the application of type string. Specify an empty string if no working directory is desired.
LaunchSupportWebsiteAction	Opens the Attachmate support Web site. Requires no parameters.
LaunchVbaAction	Starts the Visual Basic for Applications Editor. Requires no parameters.
MacroSecurityAction	Opens the API and Macro Security configuration settings. Requires no parameters.
NewDocumentAction	Creates a new document in the Reflection Desktop frame. Requires no parameters.
OpenAction	Opens a document in the Reflection frame. Requires one parameter of type string (the full path to the document to be opened).
OpenDocumentAction	Opens a specific document, either in the active workspace or a new workspace. Requires two parameters: The document file name and extension An open location of type OpenDocumentOption. This determines the location where the document is opened (a new tab inside the existing open workspace, or within a new workspace instance).
OpenURLAction	Opens a URL. This action requires up to three of the following parameters: The URL string value (required) An open location of type OpenUrlActionLocationOption (required). This determines the location where the URL is opened (for example, an external browser, a new Reflection tab, or an existing named Reflection tab). The tab name of type string, if the second parameter is OpenUrlActionLocationOption.NamedTab.
RunMacroAction	Runs a macro, if the required parameters are provided. This action requires three parameters with an optional fourth parameter: The macro name of type string (for example, "Module1.TestMacro"). Include the VBA project namespace in the name, if necessary. The VBA project location where the macro is located (type MacroEnumerationOption). Specify MacroEnumerationOption.CommonProject if the macro is located in the Common project. This is the only valid option for workspace startup, when no documents are open and available. A boolean value that determines whether the user is prompted for a macro to run at runtime. The first two parameters are ignored if this value is true. Optional macro data (type string) to be passed to the macro at runtime. If no macro data is needed, do not add this to the parameter list.
SettingsAction	Opens the settings configuration for the current document. Requires no parameters.
ShowApiGuideAction	Shows the .NET API Guide documentation. Requires no parameters.
ShowApiHelpAction	Shows the .NET API Help documentation. Requires no parameters.
ShowHelpAboutAction	Opens the Help/About dialog box. Requires no parameters.
ShowVbaGuideAction	Shows the Workspace VBA Guide documentation. Requires the VBA feature to be installed. Requires no parameters.
ShowVbaHelpAction	Shows the Workspace VBA Help documentation. Requires the VBA feature to be installed. Requires no parameters.
ToggleRibbonStateAction	Shows or hides the workspace Ribbon. This action cannot be assigned to workspace defaults StartupAction property if the workspace is running in Classic, Classic MDI, Browser, or TouchUx modes. Requires no parameters.
ToggleStatusBarAction	Toggles the workspace status bar on/off. Requires no parameters.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         Attachmate.Reflection.WorkspaceSettings.InputMapActionID

Reference

Attachmate.Reflection.WorkspaceSettings Namespace

Send Feedback