KB HDI Code How to Explore the UiPath Activities Api SDK using Visual Studio - rpapub/WatchfulAnvil GitHub Wiki
UiPath.Activities.Api
SDK Using Visual Studio?
How Do I Explore the Overview
This guide explains how to explore the UiPath.Activities.Api
SDK using built-in features of Visual Studio. It helps you understand the structure and behavior of the SDK in the context of developing custom Workflow Analyzer rules.
Prerequisites
- Clone the repository: https://github.com/rpapub/WatchfulAnvil
- Open the provided solution in Visual Studio
- Ensure the solution builds and runs the included sample rule (
NullOperationRule
)
Steps
-
Use IntelliSense to Discover SDK Types
- Type inside your custom rule and use
Ctrl+Space
to explore available types, members, and signatures. - Hover over identifiers to view documentation summaries and type information.
- Type inside your custom rule and use
-
Navigate with Go To Definition
- Hold
Ctrl
and click on SDK types or method names to view their structure in metadata view. - Visual Studio displays public properties, method signatures, and inheritance information.
- Hold
-
Browse SDK Structure Using Object Browser
- Go to
View > Object Browser
. - Select the
UiPath.Activities.Api
reference from the project. - Explore namespaces, interfaces, and classes exposed by the SDK.
- Go to
-
Use the Debugger to Inspect Runtime Behavior
- Place breakpoints inside rule logic (e.g., in
Inspect()
). - Launch UiPath Studio and attach the debugger to
UiPath.Studio.exe
. - Run Workflow Analyzer in Studio and step through rule execution to inspect live objects.
- Place breakpoints inside rule logic (e.g., in
-
Inspect Types with Reflection (Optional)
- Insert reflection code to list available members during runtime:
foreach (var m in typeof(IActivityModel).GetMembers()) { Console.WriteLine($"{m.MemberType}: {m.Name}"); }
- Insert reflection code to list available members during runtime:
Expected Outcome
After completing these steps, you will be able to:
- Discover and understand available SDK types and members
- Trace how and when custom rules are invoked by Studio
- Examine runtime data passed to your rules
- Develop and iterate rules with confidence and deeper insight
Related Articles
- tbd