Skip to content

getting-started.md

Latest commit

 

History

History
101 lines (73 loc) · 4.6 KB

getting-started.md

File metadata and controls

101 lines (73 loc) · 4.6 KB

Codartis Diagram Tool - Getting Started

Learn how to install the tool, start a trial, activate your license, and add source code symbols to your diagrams.

Help Topics

Page Overview

Supported Visual Studio Versions

  • Visual Studio 2019: version 16.11.12 or later
  • Visual Studio 2022: version: 17.14.10 or later
  • Visual Studio 2026: version: 18.2.1 or later

All Visual Studio editions are supported: Community, Professional, and Enterprise.

Installation

Option 1: Using the Extension Manager in Visual Studio

  1. Open Visual Studio and go to Extensions | Manage Extensions.
  2. Select the Browse tab, type "Codartis" in the search box, and press Enter.
  3. On the right side panel, click Install.
  4. Restart Visual Studio to complete the installation.

Option 2: Using the VSIX Installer

  1. Download the Codartis Diagram Tool VSIX file from the Visual Studio Marketplace:
  2. Double-click the downloaded VSIX file and follow the installer instructions.
  3. If you encounter permission errors, see the Troubleshooting page or install via Visual Studio.

Note: Older versions are available here.

Activating a License Key or Starting a Trial

Note: Make sure a solution is open in Visual Studio. Codartis Diagram Tool may not be available otherwise. See the Troubleshooting page for details.

  1. In Visual Studio, open the Codartis Diagram Tool window via View | Other Windows | Codartis Diagram Tool
    • Or use the keyboard shortcut: CTRL+SHIFT+D, CTRL+SHIFT+D
  2. On the Codartis Diagram Tool panel:
    • To activate a license, click Activate, enter your license key, and press OK.
    • To start a 30-day trial, click Start Trial.
About Panel

To purchase a license, visit: codartis.com

Limited Mode

If the tool is not activated and no trial is running (or the trial has expired), it operates in Limited Mode:

  • You can load, view, and rearrange diagrams.
  • Adding items or saving diagrams is disabled.

Activate a license or start a trial to unlock all features.

Adding Diagram Items from a Source Code Editor Window

Using the Context Menu

Right-click a type or member name and select one of:

  • Add to Codartis Diagram
  • Add to Codartis Diagram With Hierarchy
Add to Diagram from source code

Using a Keyboard Shortcut

Place the caret on a type or member name, then use:

  • Adding an item: CTRL+SHIFT+D, CTRL+SHIFT+A
  • Adding an entire type hierarchy: CTRL+SHIFT+D, CTRL+SHIFT+H

Adding Diagram Items from Solution Explorer

Using Drag-and-Drop

  • Drag items from Solution Explorer to the Codartis Diagram Tool window.

Using the Context Menu

  • Right-click a file, folder, project, solution folder, or the solution node in Solution Explorer, then select Add to Codartis Diagram.
Add to Diagram from Solution Explorer

Tip: Avoid adding too many items at once (e.g., entire projects), as diagrams may become cluttered or slow. Around 50 items is a practical limit.