Scripting Setup - Revision history

Dgreenwood: /* Example Object Library scripts */

2026-10-07T15:05:33Z

Example Object Library scripts

← Older revision		Revision as of 10:05, 7 October 2026
Line 447:		Line 447:

	== Example Object Library scripts ==		== Example Object Library scripts ==

			These were developed for and tested in Grooper 2025.

	=== Example Activity script: Rename a Batch using a string expression ===		=== Example Activity script: Rename a Batch using a string expression ===
	<pre>		<pre>

Dgreenwood: /* Bonus: How in-app help works for Object Libraries */

2026-10-07T13:28:21Z

Bonus: How in-app help works for Object Libraries

← Older revision		Revision as of 08:28, 7 October 2026
Line 286:		Line 286:
	Grooper's in-app help for custom code (the description text shown in help panels and property tooltips) comes from '''XML documentation comments''' in your C# script.		Grooper's in-app help for custom code (the description text shown in help panels and property tooltips) comes from '''XML documentation comments''' in your C# script.
	* Help documentation can be added for the object itself as well as its properties.		* Help documentation can be added for the object itself as well as its properties.
			* You may add <code><summary></code> and <code><remarks></code> comments.
			** Summary comments show up on tooltips. Remarks comments do not.
			** Both summary and remarks comments show up in the help panels and on the Help page.
	* Doc comment lines start with three slashes. They are documentation, not code:		* Doc comment lines start with three slashes. They are documentation, not code:
	<pre>		<pre>
Line 294:		Line 297:
	</pre>		</pre>
	* When you compile the Object Library, the C# compiler extracts these comments into an XML file named after the project (for example, <code>My_Command.xml</code>). This file is stored in the Object Library's ReleaseDLL folder next to the compiled DLL.		* When you compile the Object Library, the C# compiler extracts these comments into an XML file named after the project (for example, <code>My_Command.xml</code>). This file is stored in the Object Library's ReleaseDLL folder next to the compiled DLL.
	* Grooper reads that XML file and displays the <code><summary></code> and ~~(optional)~~ <code><remarks></code> text. The content is rendered '''as HTML''', so standard HTML tags can be used for formatting.		* Grooper reads that XML file and displays the <code><summary></code> and <code><remarks></code> text. The content is rendered '''as HTML''', so standard HTML tags can be used for formatting.

	<big>Rules for writing doc comments</big>		<big>Rules for writing doc comments</big>
Line 334:		Line 337:
	/// Comma or semicolon separated list of file names to delete from each selected item.		/// Comma or semicolon separated list of file names to delete from each selected item.
	/// Only files that actually exist on the item are deleted.		/// Only files that actually exist on the item are deleted.
			/// </summary>
			/// <remarks>
	/// Example: <code>Grooper.Characters.txt, Grooper.Layout.json, Grooper.DocumentData.json</code>		/// Example: <code>Grooper.Characters.txt, Grooper.Layout.json, Grooper.DocumentData.json</code>
	/// </~~summary~~>		/// </remarks>
	[Viewable]		[Viewable]
	[DisplayName("File Names")]		[DisplayName("File Names")]

Dgreenwood: /* Bonus: How in-app help works for Object Libraries */

2026-10-07T13:08:45Z

Bonus: How in-app help works for Object Libraries

← Older revision		Revision as of 08:08, 7 October 2026
Line 284:		Line 284:
	===== Bonus: How in-app help works for Object Libraries =====		===== Bonus: How in-app help works for Object Libraries =====

	Grooper's in-app help for custom code (the description text shown in ~~command dialogs, the~~		Grooper's in-app help for custom code (the description text shown in help panels and property tooltips) comes from '''XML documentation comments''' in your C# script.
	~~Execute activity,~~ and property tooltips) comes from '''XML documentation comments''' in your		* Help documentation can be added for the object itself as well as its properties.
	C# script.

	* Doc comment lines start with three slashes. They are documentation, not code:		* Doc comment lines start with three slashes. They are documentation, not code:
	<pre>		<pre>
Line 320:		Line 318:
	/// <summary>		/// <summary>
	/// Deletes Grooper-generated artifact files from selected Batches, Batch Folders, and Batch Pages.		/// Deletes Grooper-generated artifact files from selected Batches, Batch Folders, and Batch Pages.
			/// </summary>
			/// <remarks>
	/// Common Grooper artifacts include:		/// Common Grooper artifacts include:
	/// <ul>		/// <ul>
Line 326:		Line 326:
	/// <li><code>Grooper.DocumentData.json</code> (stored document data created by Extract)</li>		/// <li><code>Grooper.DocumentData.json</code> (stored document data created by Extract)</li>
	/// </ul>		/// </ul>
	/// </~~summary~~>		/// </remarks>
	[Serializable]		[Serializable]
	[DisplayName("Delete Grooper Files")]		[DisplayName("Delete Grooper Files")]

Dgreenwood: /* Formatting the help text */

2026-10-06T16:21:18Z

Formatting the help text

← Older revision		Revision as of 11:21, 6 October 2026
Line 305:		Line 305:
	* The content must be well-formed XML: close every tag, and a literal & must be written as &amp;		* The content must be well-formed XML: close every tag, and a literal & must be written as &amp;

	== Formatting the help text ==		<big>Formatting the help text</big>

	Because Grooper renders the summary as HTML, standard HTML tags work:		Because Grooper renders the summary as HTML, standard HTML tags work:
Line 315:		Line 315:
	Note: C#-specific doc tags such as <list type="bullet"> and <c> are for Visual Studio's own documentation rendering. Grooper does not translate them, so use plain HTML instead.		Note: C#-specific doc tags such as <list type="bullet"> and <c> are for Visual Studio's own documentation rendering. Grooper does not translate them, so use plain HTML instead.

	~~======~~ Example ~~======~~		<big>Example</big>

	<pre>		<pre>

Dgreenwood: /* Bonus: How in-app help works for Object Libraries */

2026-10-06T16:20:56Z

Bonus: How in-app help works for Object Libraries

← Older revision		Revision as of 11:20, 6 October 2026
Line 298:		Line 298:
	* Grooper reads that XML file and displays the <code><summary></code> and (optional) <code><remarks></code> text. The content is rendered '''as HTML''', so standard HTML tags can be used for formatting.		* Grooper reads that XML file and displays the <code><summary></code> and (optional) <code><remarks></code> text. The content is rendered '''as HTML''', so standard HTML tags can be used for formatting.

	~~======~~ Rules for writing doc comments ~~======~~		<big>Rules for writing doc comments</big>

	* Place the doc comment immediately above the class, property, or method it describes.		* Place the doc comment immediately above the class, property, or method it describes.

Dgreenwood: /* Bonus: How to add the in-app help for a custom object */

2026-10-06T16:16:51Z

Bonus: How to add the in-app help for a custom object

@@ Line 282: / Line 282: @@
 :** <i class="material-symbols-outlined" style="font-variation-settings: 'FILL' 1;">account_tree</i> tree
-===== Bonus: How to add the in-app help for a custom object =====
+===== Bonus: How in-app help works for Object Libraries =====
-'''''COMING SOON'''''
+Grooper's in-app help for custom code (the description text shown in command dialogs, the
 ==== Debug the script in a browser ====

Dgreenwood: /* Thing you can't do in web client scripts */

2026-10-05T15:43:51Z

Thing you can't do in web client scripts

← Older revision		Revision as of 10:43, 5 October 2026
Line 373:		Line 373:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

			== Example Object Library scripts ==
			=== Example Activity script: Rename a Batch using a string expression ===
			<pre>
			using Grooper;
			using Grooper.Core;
			using System;
			using System.ComponentModel;
			using System.Runtime.Serialization;
			namespace RenameBatch
			{
			/// <summary>Renames a Batch using a string expression</summary>
			/// <remarks>
			/// Use this activity to rename a Batch "in-flight" during a Batch Process. The expression can use any of the Batch's properties, including its index data, or system data to generate a new name.
			///
			/// If you need to reference [Data Fields] by name in the expression, set the 'Content Type' property so the expression can be compiled against the correct [Data Model].
			/// </remarks>
			[DataContract, AllowedScopes(GrooperDb.ProcessingScope.Batch), IconName("drive_file_rename_outline"), Category("Custom Activities")]
			public class RenameBatch : CodeActivity, IScoped
			{
			public RenameBatch(ConnectedObject owner)
			: base(owner)
			{
			NameExpression = new StringExpression(this);
			}
			/// <summary>The Content Type whose fields should be available in the Name Expression.</summary>
			/// <remarks>
			/// Select the [Content Type] that defines the [Data Fields] you want to reference by name in the 'Name Expression' property.
			/// This also enables IntelliSense for that Content Type's Data Model within the expression editor.
			/// </remarks>
			[Viewable, UI(typeof(ContentTypeEditor))]
			public ContentType ContentType
			{
			get => (ContentType)Database.GetNode(ContentTypeId);
			set => ContentTypeId = value?.Id ?? Guid.Empty;
			}
			[DataMember] public Guid ContentTypeId;
			/// <summary>Expression used to generate the name for the current Batch.</summary>
			/// <remarks>
			/// This expression must evaluate to a <b>string</b> value.
			/// </remarks>
			[DataMember, Required, Viewable, DisplayName("Name Expression")]
			public StringExpression NameExpression { get; set; }
			public override void ProcessTask(BatchObject curNode)
			{
			Batch batch = curNode as Batch;
			if (batch == null)
			return;
			if (NameExpression.IsEmpty) return;
			string newName = NameExpression.ComputeValue(batch, batch.LoadIndexData(ContentType));
			if (!String.IsNullOrWhiteSpace(newName))
			batch.Name = newName;
			}
			}
			}
			</pre>
			<section end="Object Library" />

	== Thing you can't do in web client scripts ==		== Thing you can't do in web client scripts ==

Dgreenwood: /* Example Activity script: Rename a Batch using a string expression */

2026-10-05T15:43:05Z

Example Activity script: Rename a Batch using a string expression

← Older revision		Revision as of 10:43, 5 October 2026
Line 373:		Line 373:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

	~~=== Example Activity script: Rename a Batch using a string expression ===~~
	~~<pre>~~
	~~using Grooper;~~
	~~using Grooper.Core;~~
	~~using System;~~
	~~using System.ComponentModel;~~
	~~using System.Runtime.Serialization;~~
	~~namespace RenameBatch~~
	{
	~~/// <summary>Renames a Batch using a string expression</summary>~~
	~~/// <remarks>~~
	~~/// Use this activity to rename a Batch "in-flight" during a Batch Process. The expression can use any of the Batch's properties, including its index data, or system data to generate a new name.~~
	~~///~~
	~~/// If you need to reference [Data Fields] by name in the expression, set the 'Content Type' property so the expression can be compiled against the correct [Data Model].~~
	~~/// </remarks>~~
	~~[DataContract, AllowedScopes(GrooperDb.ProcessingScope.Batch), IconName("drive_file_rename_outline"), Category("Custom Activities")]~~
	~~public class RenameBatch : CodeActivity, IScoped~~
	{
	~~public RenameBatch(ConnectedObject owner)~~
	~~: base(owner)~~
	{
	~~NameExpression = new StringExpression(this);~~
	}
	~~/// <summary>The Content Type whose fields should be available in the Name Expression.</summary>~~
	~~/// <remarks>~~
	~~/// Select the [Content Type] that defines the [Data Fields] you want to reference by name in the 'Name Expression' property.~~
	~~/// This also enables IntelliSense for that Content Type's Data Model within the expression editor.~~
	~~/// </remarks>~~
	~~[Viewable, UI(typeof(ContentTypeEditor))]~~
	~~public ContentType ContentType~~
	{
	~~get => (ContentType)Database.GetNode(ContentTypeId);~~
	~~set => ContentTypeId = value?.Id ?? Guid.Empty;~~
	}
	~~[DataMember] public Guid ContentTypeId;~~
	~~/// <summary>Expression used to generate the name for the current Batch.</summary>~~
	~~/// <remarks>~~
	~~/// This expression must evaluate to a <b>string</b> value.~~
	~~/// </remarks>~~
	~~[DataMember, Required, Viewable, DisplayName("Name Expression")]~~
	~~public StringExpression NameExpression { get; set; }~~
	~~public override void ProcessTask(BatchObject curNode)~~
	{
	~~Batch batch = curNode as Batch;~~
	~~if (batch == null)~~
	~~return;~~
	~~if (NameExpression.IsEmpty) return;~~
	~~string newName = NameExpression.ComputeValue(batch, batch.LoadIndexData(ContentType));~~
	~~if (!String.IsNullOrWhiteSpace(newName))~~
	~~batch.Name = newName;~~
	}
	}
	}
	~~</pre>~~
	~~<section end="Object Library" />~~

	== Thing you can't do in web client scripts ==		== Thing you can't do in web client scripts ==

Dgreenwood: /* Example Activity script: Rename a Batch using a string expression */

2026-09-11T21:18:54Z

Example Activity script: Rename a Batch using a string expression

← Older revision		Revision as of 16:18, 11 September 2026
Line 386:		Line 386:
	/// <remarks>		/// <remarks>
	/// Use this activity to rename a Batch "in-flight" during a Batch Process. The expression can use any of the Batch's properties, including its index data, or system data to generate a new name.		/// Use this activity to rename a Batch "in-flight" during a Batch Process. The expression can use any of the Batch's properties, including its index data, or system data to generate a new name.
			///
			/// If you need to reference [Data Fields] by name in the expression, set the 'Content Type' property so the expression can be compiled against the correct [Data Model].
	/// </remarks>		/// </remarks>
	[DataContract, AllowedScopes(GrooperDb.ProcessingScope.Batch), IconName("drive_file_rename_outline"), Category("Custom Activities")]		[DataContract, AllowedScopes(GrooperDb.ProcessingScope.Batch), IconName("drive_file_rename_outline"), Category("Custom Activities")]

Dgreenwood: /* Creating and debugging Grooper scripts */

2026-09-11T21:16:07Z

Creating and debugging Grooper scripts

← Older revision		Revision as of 16:16, 11 September 2026
Line 373:		Line 373:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

			=== Example Activity script: Rename a Batch using a string expression ===
			<pre>
			using Grooper;
			using Grooper.Core;
			using System;
			using System.ComponentModel;
			using System.Runtime.Serialization;
			namespace RenameBatch
			{
			/// <summary>Renames a Batch using a string expression</summary>
			/// <remarks>
			/// Use this activity to rename a Batch "in-flight" during a Batch Process. The expression can use any of the Batch's properties, including its index data, or system data to generate a new name.
			/// </remarks>
			[DataContract, AllowedScopes(GrooperDb.ProcessingScope.Batch), IconName("drive_file_rename_outline"), Category("Custom Activities")]
			public class RenameBatch : CodeActivity, IScoped
			{
			public RenameBatch(ConnectedObject owner)
			: base(owner)
			{
			NameExpression = new StringExpression(this);
			}
			/// <summary>The Content Type whose fields should be available in the Name Expression.</summary>
			/// <remarks>
			/// Select the [Content Type] that defines the [Data Fields] you want to reference by name in the 'Name Expression' property.
			/// This also enables IntelliSense for that Content Type's Data Model within the expression editor.
			/// </remarks>
			[Viewable, UI(typeof(ContentTypeEditor))]
			public ContentType ContentType
			{
			get => (ContentType)Database.GetNode(ContentTypeId);
			set => ContentTypeId = value?.Id ?? Guid.Empty;
			}
			[DataMember] public Guid ContentTypeId;
			/// <summary>Expression used to generate the name for the current Batch.</summary>
			/// <remarks>
			/// This expression must evaluate to a <b>string</b> value.
			/// </remarks>
			[DataMember, Required, Viewable, DisplayName("Name Expression")]
			public StringExpression NameExpression { get; set; }
			public override void ProcessTask(BatchObject curNode)
			{
			Batch batch = curNode as Batch;
			if (batch == null)
			return;
			if (NameExpression.IsEmpty) return;
			string newName = NameExpression.ComputeValue(batch, batch.LoadIndexData(ContentType));
			if (!String.IsNullOrWhiteSpace(newName))
			batch.Name = newName;
			}
			}
			}
			</pre>
	<section end="Object Library" />		<section end="Object Library" />