Class CodeEditor

Handles interaction with the external application used for editing scripts.

Index

Constructors

constructor

new CodeEditor(): CodeEditor
Returns CodeEditor
Inherited from CodeEditorGenerated.constructor

Properties

`Static` `Readonly`CodeTypes

CodeTypes: EnumValue<ResourceType, number>[]

Contains resource types that are relevant to the code editor.

Accessors

`Static`activeEditor

get activeEditor(): EnumValue<CodeEditorType, number>
Changes the active code editor. All further operations on this object will be executed using this editor. If the specified editor is not valid for this platform, no change will be made.

Returns EnumValue<CodeEditorType, number>
Inherited from CodeEditorGenerated.activeEditor
set activeEditor(value): void
Parameters
- value: EnumValue<CodeEditorType, number>
Returns void
Inherited from CodeEditorGenerated.activeEditor

`Static`availableEditors

get availableEditors(): Iterable<EnumValue<CodeEditorType, number>>
Returns a list of all available code editors for this platform.

Returns Iterable<EnumValue<CodeEditorType, number>>
Inherited from CodeEditorGenerated.availableEditors

`Static`defaultCodeEditor

get defaultCodeEditor(): EnumValue<CodeEditorType, number>
Determines the default code editor type to be used by the editor.

Returns EnumValue<CodeEditorType, number>

`Static`isSolutionDirty

get isSolutionDirty(): boolean
Checks if the code editor's solution requires updating.

Returns boolean

`Static`projectSolutionPath

get projectSolutionPath(): FilePath
Returns the path to the workspace, if supported by the current code editor.

Returns FilePath
Inherited from CodeEditorGenerated.projectSolutionPath

Methods

`Static`getCodeFileContentsForUUID

getCodeFileContentsForUUID(uuid): UncertainAsyncOp<string, string>
Gets the contents of the code file specified by the UUID.
Parameters
- uuid: UUID
  The UUID of the code resource to be retrieved.
Returns UncertainAsyncOp<string, string>
An async op once the operation has completed.

Inherited from CodeEditorGenerated.getCodeFileContentsForUUID

`Static`getCodeFileSystemJSON

getCodeFileSystemJSON(isReadOnly?): JsonObject
Gets a representation of the FileSystem code resources.
Parameters
- OptionalisReadOnly: boolean
  If set, will override the read-only flag for all code resources. If false, uses the default behavior based on file origin.
Returns JsonObject
A JsonObject that represents the file tree of code resoruces in the file system.

Inherited from CodeEditorGenerated.getCodeFileSystemJSON

`Static`markSolutionDirty

markSolutionDirty(): void
Notifies the code editor that code file structure has changed and the solution needs to be rebuilt.

Returns void

`Static`openCodeResource

openCodeResource(resource, line, column?): void
Opens a the code resource in the currently active code editor.
Parameters
- resource: Resource
  The code resource to open.
- line: number
  Line in the file to focus the editor on.
- Optionalcolumn: number
  Column in the line to focus the editor on. One-based. Only honored by the web IDE extension.
Returns void

`Static`openFile

openFile(path, line, column?): void
Opens a script file in the currently active code editor.
Parameters
- path: FilePath
  FilePath to the script file to open, either absolute or relative to the project resources folder.
- line: number
  Line in the file to focus the editor on.
- Optionalcolumn: number
  Column in the line to focus the editor on. One-based. Only honored by the web IDE extension.
Returns void

`Static`openFileInternal

openFileInternal(resource, lineNumber): void
Opens a code file in the active external editor.
Parameters
- resource: FilePath
  The code file to open, can be absolute or relative to project resources folder. The file should be part of a solution in the active editor.
- lineNumber: number
  Line number to focus on once the file is opened. Might not be supported by all editors.
Returns void
Inherited from CodeEditorGenerated.openFileInternal

`Static`setCodeFileContentsForUUID

setCodeFileContentsForUUID(uuid, contents): UncertainAsyncOp<boolean, string>
Sets the contents of the code file specified by the UUID.
Parameters
- uuid: UUID
  The UUID of the code resource to be updated.
- contents: string
  The contents to update the code file with.
Returns UncertainAsyncOp<boolean, string>
An async op once the operation has completed.

Inherited from CodeEditorGenerated.setCodeFileContentsForUUID

`Static`syncSolution

syncSolution(): void
Generates a solution file for the active editor, which includes all scripts in the project.

Returns void

Class CodeEditor

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CodeEditor

Properties

Static ReadonlyCodeTypes

Accessors

StaticactiveEditor

Returns EnumValue<CodeEditorType, number>

Parameters

Returns void

StaticavailableEditors

Returns Iterable<EnumValue<CodeEditorType, number>>

StaticdefaultCodeEditor

Returns EnumValue<CodeEditorType, number>

StaticisSolutionDirty

Returns boolean

StaticprojectSolutionPath

Returns FilePath

Methods

StaticgetCodeFileContentsForUUID

Parameters

Returns UncertainAsyncOp<string, string>

StaticgetCodeFileSystemJSON

Parameters

Returns JsonObject

StaticmarkSolutionDirty

Returns void

StaticopenCodeResource

Parameters

Returns void

StaticopenFile

Parameters

Returns void

StaticopenFileInternal

Parameters

Returns void

StaticsetCodeFileContentsForUUID

Parameters

Returns UncertainAsyncOp<boolean, string>

StaticsyncSolution

Returns void

Settings

On This Page

`Static` `Readonly`CodeTypes

`Static`activeEditor

`Static`availableEditors

`Static`defaultCodeEditor

`Static`isSolutionDirty

`Static`projectSolutionPath

`Static`getCodeFileContentsForUUID

`Static`getCodeFileSystemJSON

`Static`markSolutionDirty

`Static`openCodeResource

`Static`openFile

`Static`openFileInternal

`Static`setCodeFileContentsForUUID

`Static`syncSolution