Include Script Files (UI.Include)

The UI.Include() method allows you to include and execute code from external .cs files within your Launchpad scripts. This enables reuse code and organize your scripts more easily.

Methods

Use the following methods to include a script file (.cs) inside another script file.

UI.Include(filename)

Includes and executes a .cs file in the current script context.

Parameters:

• filename (string): The path to the .cs file to include (relative or absolute)

Example:

UI.Include("Utils.cs");
UI.Include("Constants.cs");

UI.Include(filename1, filename2, ...)

Includes multiple .cs files in sequence.

Parameters:

• filenames (params string[]): Array of filenames to include

Example:

UI.Include("Utils.cs", "Constants.cs", "Helpers.cs");

UI.TryInclude(filename)

Attempts to include a file and returns true if successful, false otherwise.

Parameters:

• filename (string): The path to the .cs file to include

Returns:

• bool: True if the file was successfully included, false otherwise

Example:

if (UI.TryInclude("OptionalHelpers.cs"))
{    
     Console.WriteLine("Optional helpers loaded");    // Use optional helper methods
}
else
{    
     Console.WriteLine("Optional helpers not available, using defaults");    // Fall back to default behavior
}

UI.SetIncludePath(directory)

Sets the default directory where UI.Include() will look for files when using relative paths. This is primarily used in Launchpad Command and Launchpad App where scripts don't have an associated file path.

Parameters:

• directory (string): The directory path to use as the base for relative includes

Example:

UI.SetIncludePath(@"C:\MyScripts\Common");
UI.Include("Utils.cs");  // Will look in C:\MyScripts\Common\Utils.cs

UI.GetIncludePath()

Gets the current default include directory.

Returns:

• string: The current include path, or null if not set

Example:

string currentPath = UI.GetIncludePath();
Console.WriteLine($"Current include path: {currentPath ?? "Not set"}");

Usage

In Launchpad Explorer

When running scripts through Launchpad Explorer, the include system automatically knows the location of your script file. You can use simple relative paths.

// Your capsule structure:
// MyCapsule
///   Scripts
///     MainScript.cs      <- You are here
//     Utils.cs
//     Helpers
///       GeometryHelpers.cs

// Include files in the same directory
UI.Include("Utils.cs");

// Include files in subdirectories
UI.Include("Helpers/GeometryHelpers.cs");

In Launchpad Command or App

When typing code directly (not running from a file), you need to either:

1. Use absolute paths:

UI.Include(@"C:\MyScripts\Utils.cs");
UI.Include(@"D:\RevitTools\Common\Constants.cs");

1. Set an include path first:

// Set the base directory for includes
UI.SetIncludePath(@"C:\MyScripts");
// Now use relative paths
UI.Include("Utils.cs");
UI.Include("Common/Constants.cs");