Differences

This shows you the differences between two versions of the page.

--- dev:client_coding:libreoffice_plugin_wire_protocol [2012/07/24 02:20] – [Word Processor Commands] simon
+++ dev:client_coding:libreoffice_plugin_wire_protocol [2013/01/17 14:14] – added Field_convert lddubeau
@@ Line 61: / Line 61: @@
 </code>
-If the request is successful, the client must send a response with a JSON-encoded payload. This response is often <code>null</code> if the command returns no output, but may also be an array, an integer, a string, or a boolean value depending on the command.
+If the request is successful, the client must send a response with a JSON-encoded payload. This response is often null if the command returns no output, but may also be an array, an integer, a string, or a boolean value depending on the command.
 If the request is unsuccessful, the client must send a response with the payload:
@@ Line 319: / Line 319: @@
 | fieldID | %%Integer|String%% | The fieldID, as originally returned by [[#Document_cursorInField]], [[#Document_insertField]], or [[#Document_getFields]]|
 | code | %%String%% | The field code|
+=== Returns ===
+null
+==== Field_convert ====
+Converts a field from one type to another.
+=== Parameters ===
+| documentID | %%Integer|String%% | The documentID, as originally returned by [[#Application_getActiveDocument]]|
+| fieldID | %%Integer|String%% | The fieldID, as originally returned by [[#Document_cursorInField]], [[#Document_insertField]], or [[#Document_getFields]]|
+| fieldType | %%String%% | The type of field used by the document, either ReferenceMark or Bookmark |
+| noteType | %%Integer%% | The type of note specified by the style:<code>
+NOTE_IN_TEXT = 0
+NOTE_FOOTNOTE = 1
+NOTE_ENDNOTE = 2
+</code> |
 === Returns ===
 null