Differences

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

--- scripting:examples:code-completion [2018/06/17 23:32] – [Implementing Custom Code Completion] admin
+++ scripting:examples:code-completion [2018/06/18 00:47] (current) – [Usage of CompletionSet and CompletionItem] admin
@@ Line 44: / Line 44: @@
 ==== Subscribing on onCompletion event  ====
-<file javascript code-completion3.hejs>
+If you want to take full control over the completion process, you can subscribe to [[scripting:api:script-application:on-completion|onCompletion]] event and decide by yourself, what shall be the result of the event.\\
+It can be a display of pre-filled Completion List or maybe, some special dialog or other UI.
+Be aware, that [[scripting:api:script-application:on-completion|onCompletion]] event called for any syntax, so, if you want to limit your code completion to only some specific programming language, you need to implement filtering in the event code by yourself.
+<file javascript code-completion2.hejs>
 ////////////////////////////////////////////////////////////////////////
 // Register Code Completion Handler
 Application.onCompletion = function(/*IRange*/ selection ) {
 	if ( ActiveDocument.Syntax.IsInheritedFrom("js") ) {
-		//var aSuggestions = ["Item1", "Item2", "Item3", "Item4", "Item5", "Item6", "Item7", "Item8", "Item9", "Item10"];
+                // simplest, just pass a list of strings
-		//this.ShowCompletionList(selection, aSuggestions, false);
+		var aSuggestions = ["Item1", "Item2", "Item3", "Item4", "Item5"];
+		this.ShowCompletionList(selection, aSuggestions, false);
-		var item5 = CompletionItem("Item5");
+		return true; // event is handled
-		item5.Pattern = "%CurrentWord%(%|%)";
+	}
-		item5.onDescription = function () { return this.Text + "() ..."; };
+	// event is not handled, editor shall execute default logic
-		var item6 = CompletionItem("Item6");
+	return false;
-		item6.onExpand = onExpand;
+};</file>
-		item6.SubMenu = true;
-		var aSuggestions = [CompletionItem("Item1", "js:methods"), CompletionItem("Item2", "variable"), CompletionItem("Item3"), CompletionItem("Item4", null, 11, 1, "Item4 Description", onExpand), item5, item6];
+If for some reason, in your plugin you cannot create JS like array, to pass a list of strings, you can pass it as [[scripting:api:completion-set:start|CompletionSet]].
+<file javascript code-completion2.hejs>
-		var completion_set = CompletionSet(aSuggestions);
+////////////////////////////////////////////////////////////////////////
+// Register Code Completion Handler
+Application.onCompletion = function(/*IRange*/ selection ) {
+	if ( ActiveDocument.Syntax.IsInheritedFrom("js") ) {
+		var completion_set = CompletionSet();
+                // add as a string
+                completion_set.Add("Variable1");
+                // add as a completion item. To refer style you can use relative syntax e.g. "variable",
+                // absolute "js:method" or at all pass Syntax object directly
+                completion_set.Add(CompletionItem("Variable2", "js:methods"));
 		this.ShowCompletionList(selection, completion_set, true);
-		return true; // processed
+		return true; // event is handled
 	}
+	// event is not handled, editor shall execute default logic
 	return false;
 };</file>
+==== Usage of CompletionSet and CompletionItem  ====
+When you construct [[scripting:api:completion-set:start|CompletionSet]], you can initialize an object by another [[scripting:api:completion-set:start|CompletionSet]] object (items would be copied) or by JS array with strings or CompletionItems.
+<code javascript>
+var completion_set = CompletionSet([
+CompletionItem("Item1", "js:methods"),
+CompletionItem("Item2", "variable"),
+CompletionItem("Item3")
+]);
+// or
+var completion_set2 = CompletionSet(["Item1", "Item2", "Item3"]);
+</code>
+<note important>Do not mix strings and CompletionItems in the same set - it is not supported, and editor will use a type of first object</note>
+If you need more customization of your item displayed in CompletionList, there are several options you can use when constructing explicit [[scripting:api:completion-item:start|CompletionItem]] and passing it to the list.
+<code javascript>
+var item5 = CompletionItem("Item5");
+// custom insetion pattern, with code template syntax.
+// %CurrentWord% - inserted text
+item5.Pattern = "%CurrentWord%(%|%)";
+// custom description tooltip, shown when user scrolls over items and stops on one of them
+item5.onDescription = function () { return this.Text + "() ..."; };
+function onExpand(view, selection) {
+	ActiveDocument.ReplaceText(selection, this.Text + "(...)");
+}
+var item6 = CompletionItem("Item6");
+// adding of custom handler, which is called when item is selected and inserted
+// default, inserts item Text property
+item6.onExpand = onExpand;
+// add small arrow icon on the right of the item, indicating that items expands
+item6.SubMenu = true;
+var aSuggestions = [
+// add completion items with text and style, from which color/image/style of item shall be derived
+CompletionItem("Item1", "js:methods"),
+CompletionItem("Item2", "variable"),
+// use default style for item display
+CompletionItem("Item3"),
+// define an item witthout style, but with explicit image, subimage (public/protected/private)
+// description and selection call-back
+CompletionItem("Item4", null, 11, 1, "Item4 Description", onExpand),
+item5,
+item6];
+</code>