Introduction

This document provides an overview of the Extensibility APIs available for GENESIS. These extensibility APIs can be used to enhance the capabilities of the GENESIS suite of products with custom behaviors. The intended audience is primarily advanced customers seeking to integrate more deeply with the GENESIS products and leverage existing GENESIS programmatic functionality that is not normally exposed for typical GENESIS users. This document assumes that you are already familiar with how to develop for the Microsoft .NET Framework/.NET Standard using Microsoft Visual Studio.

The ToolWorX Section Content

The topics in this section describe the APIs available in GENESIS Version 11.05. Public APIs that are also described in the public customer API (see API documentation installed with GENESIS, a.k.a. the "scripting" API) will not be removed in future versions of the product. However, please note that any protected members or public members/types that are not also documented in the public scripting API are subject to change in future versions of the product. (In general, GENESIS would introduce such breaking API changes in future versions only if they bring a significant long-term benefit.) Any compiled code created using these APIs will likely need to be recompiled for subsequent versions of the GENESIS products (to update assembly version references). However, there is a reasonably high probability that little or no code changes would be needed.

These topics contain hyperlinks to a companion API help reference. Click the links to directly access the related API help topics for more detailed technical information about that API.

In some places, this document may refer the reader to see a separate document for more details. Such cases occur when a topic has an extensive amount of information to cover and/or when the topic can be effectively presented as a standalone subject.

Samples and Code Examples

These instructional topics may include short code examples to help demonstrate how an API is used. In some cases, a larger amount of code may be needed to properly explain a complex API. In these cases, you may be referred to a particular sample code project available for download from the Community Portal.