Class CodeEditingManager

Editor utility to managed and use different code editors. Allows to open solution and source code files.

System.Object
CodeEditingManager
Namespace: FlaxEditor
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public static class CodeEditingManager : Object

Properties

IsAsyncOpenRunning

Determines whether asynchronous open action is running in a background.

Declaration
[Unmanaged]
public static bool IsAsyncOpenRunning { get; }
Property Value
System.Boolean

Methods

GetGenerateProjectCustomArgs(CodeEditorTypes)

Gets the custom arguments for the Flax.Build tool to add when generating project files for this code editor.

Declaration
[Unmanaged]
public static string GetGenerateProjectCustomArgs(CodeEditorTypes editorType)
Parameters
FlaxEditor.CodeEditorTypes editorType

The code editor type.
Returns
System.String

The custom arguments to generate project files.

GetName(CodeEditorTypes)

Gets the name of the editor.

Declaration
[Unmanaged]
public static string GetName(CodeEditorTypes editorType)
Parameters
FlaxEditor.CodeEditorTypes editorType

The code editor type.
Returns
System.String

The name.

OnFileAdded(CodeEditorTypes, String)

Called when source file gets added to the workspace. Can be used to automatically include new files into the project files.

Declaration
[Unmanaged]
public static void OnFileAdded(CodeEditorTypes editorType, string path)
Parameters
FlaxEditor.CodeEditorTypes editorType

The code editor type.
System.String path

The path.

OpenFile(CodeEditorTypes, String, Int32)

Opens the file. Handles async opening.

Declaration
[Unmanaged]
public static void OpenFile(CodeEditorTypes editorType, string path, int line)
Parameters
FlaxEditor.CodeEditorTypes editorType

The code editor type.
System.String path

The file path.
System.Int32 line

The target line (use 0 to not use it).

OpenSolution(CodeEditorTypes)

Opens the solution project. Handles async opening.

Declaration
[Unmanaged]
public static void OpenSolution(CodeEditorTypes editorType)
Parameters
FlaxEditor.CodeEditorTypes editorType

The code editor type.