The ix.api namespace

The primary task of this namespace is to clearly differentiate the officially supported public Intrexx functions from other functions that are not intended for public use.

It ensures that developers can easily identify and use Intrexx-specific functionalities without being disturbed by unrelated global functions, such as browser-specific or pure JavaScript functions. In addition, this namespace does not contain internal Intrexx functions that are also not intended for public use.

This approach provides a clean and unambiguous API, prevents the misuse of internal functions, and avoids cluttering the global namespace.

By using the functions under the ix.api namespace, developers can expect greater consistency and ease of maintenance in their Intrexx projects, which contributes to higher productivity and quality in application development.

⚠️ It is important to note that the use of internal functions outside the ix.api area is not supported and may lead to unpredictable results as they may change in future updates without notice.

Usage

The ix.api namespace is divided into several categories, each representing a specific area of functionality.

Example

// Accessing a specific function within the `ix.api` namespace
ix.api.NAMESPACE.FUNCTION_NAME();
Copy

Example

// Retrieve an Intrexx control using the GUID of an element
ix.api.dom.getControl("<ELEMENT-GUID>");

// Get the HTML element of an Intrexx component by its GUID
ix.api.dom.getHtml("<ELEMENT-GUID>");

// Retrieve the value of the `co_Lang` cookie
ix.api.cookie.getValue("co_Lang");

// Load a language constant in the current portal's language
ix.api.text.i18n.get("<LANGUAGE-CONSTANT>");
Copy

Take a look at the individual namespaces for detailed information on the available functions and their usage.