M_Aml_Editor_Plugin_Contracts_Commanding_EditorCommandBase_GetCAEXFileCommand

EditorCommandBase.GetCAEXFileCommand Method

AutomationML Editor

Calls the command, to get the currently edited CAEX file from the AutomationML editor.

Namespace: Aml.Editor.Plugin.Contracts.Commanding
Assembly: AML.Editor.PluginContracts (in AML.Editor.PluginContracts.dll) Version: 2.1

Syntax

C#

public static CAEXFileType GetCAEXFileCommand(
	this IEditorCommanding plugIn,
	out GetCAEXFileCommandArguments result
)

VB

<ExtensionAttribute>
Public Shared Function GetCAEXFileCommand ( 
	plugIn As IEditorCommanding,
	<OutAttribute> ByRef result As GetCAEXFileCommandArguments
) As CAEXFileType

C++

public:
[ExtensionAttribute]
static CAEXFileType^ GetCAEXFileCommand(
	IEditorCommanding^ plugIn, 
	[OutAttribute] GetCAEXFileCommandArguments^% result
)

Parameters

 

plugIn

Type: Aml.Editor.Plugin.Contracts.Commanding.IEditorCommanding
The plug in.

result

Type: Aml.Editor.Plugin.Contracts.Commanding.GetCAEXFileCommandArguments
The result.

Return Value

Type: CAEXFileType
true, if the operation has been executed successfully; false if an Error exists or no current file is loaded. Interpret the result output for details.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEditorCommanding. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also

Reference

EditorCommandBase Class
Aml.Editor.Plugin.Contracts.Commanding Namespace