Documentation of Editor API

Asked by Jan on 11 Nov 2017

Latest activity Edited by Jan on 26 Aug 2019

Accepted Answer by Michelle Hirsch

50 views (last 30 days)

There is an API to interact with the files opened in the editor, see e.g.

matlab.desktop.editor.getAll

But how can I find the corresponding docs or further explanations? These trials are not successful in R2016b:

docsearch editor
docsearch editor api
docsearch matlab.desktop.editor
docsearch getAll
doc matlab.desktop.editor.getAll  % [EDITED: This DOES work!]
doc matlab.desktop.editor         % This also - See Michelle's answer

Searching in the net does not find the official documentation also, e.g. asking Google for "matlab.desktop.editor.getAll" provides these links on top:

Is this API documented?
If so, where do I find an exhaustive documentation?
How could I find this by my own?

PS. What a pity that the powerful feature of running macros in the editor has been removed after Matlab version 5.3! FEX: EditorMacro does not work as stable as I need it.

0 Comments

1 Answer

Link

Answer by Michelle Hirsch on 17 Nov 2017

Accepted Answer

These functions are documented through their source code help, though there are no reference pages. Our intention is that the editor interface is fully supported.

You can use help or doc to get help on any function in the package. Doc just opens the help in the documentation browser. You can also get a listing of all of the documented functionality by calling

doc matlab.desktop.editor

3 Comments

Jan on 17 Nov 2017

@Michelle: Whoops. I did try

doc matlab.desktop.editor
help matlab.desktop.editor

in R2016b - I checked in the Command History, that I had no typo in it. I asked in the forum, because I got the "did not match any documents" and "not found" messages.

But after reading your answer I tried it again - with success. Strange. I guess a shadowed a built-in function let doc fail, but I cannot reproduce it.

Thanks for your answer. I suspected, that I have overseen a detail...

Ian on 25 Aug 2019

Hmmm. Doc and Help matlab.desktop.editor says

"matlab.desktop.editor Summary of Editor Document functionality. Programmatically access the MATLAB Editor to open, change, save, or close documents."

But doesn't list any functions to save a file or close a file's editor window. I've tried the obvious "matlab.desktop.editor.close(...)" and "matlab.desktop.editor.closeDocument(...)" with no success. What are the functions for save and close?

Walter Roberson on 25 Aug 2019

Ian,

You need to extract an active instance instance and work with it.

allinstances = matlab.desktop.editor.getAll;

now examine {allinstances.FileName} to figure out which if the instances is the one that is of interest to you. Supposing it is at offset idx, then

allinstances(idx).save() or .saveAs() or .close())

You are now following this question

Jan (view profile)