Class | Description | |
---|---|---|
![]() | ConfigOptions | A ConfigOptions object holds settings pertaining to configuration file management. Do not instantiate this class, access it via the Api object's SetupData.ConfigOptions Property. |
![]() | Constants.DatabaseType | Describes the type of Data Source. |
![]() | Constants.DataType | The DataType constants are used throughout the application including when defining the return type of Quick Functions. |
![]() | Constants.RelationType | Describes the relationship between data objects in a join. |
![]() | EntityCollection | A collection of entities (Data Objects) that exist in the current configuration. Do not instantiate this collection, instead, access it via the Entities Property of the API object. |
![]() | General | The General class holds the Admin Console settings that fall under the General heading. Instead of instantiating the class, access it through the Api object's General Property. |
![]() | JoinCollection | A collection of Joins in the configuration. Do not instantiate this collection, instead access it via the Joins Property of the Api Class. |
![]() | Log | A Log object represents the log file. Do not instantiate this object. Instead, use the static GetLogger() method to retrieve a Logger object that can write to the log. |
![]() | Logger | The Logger object is a singleton class that can write to the API's log file. Just as an author writes a book, a logger writes a log. |
![]() | Parameter | Parameter objects represent a parameter in the ParameterCollection. Parameters are used throughout the Exago application to store values. Although parameters can be created and given a default value in the Administration Console, parameters are designed to be set at runtime through the API. |
![]() | ParameterCollection | The collection of Parameters that exist in the current configuration. Do not instantiate this collection, instead access it through the Parameters Property of the Api Class. |
![]() | QuickFunction | Quick Functions are pre-defined calculations or operators that transform the fields in either detail fields or group columns of ExpressViews. |
![]() | QuickFunctionCollection | A collection of Quick Functions in the system configuration. |
![]() | SetupData | A SetupData object contains all of the session’s configuration settings including Functions, Parameters, Data Objects, Joins, Roles, etc. Access this object via the SetupData Property. The Api object has shortcut properties to several of SetupData's, granting access to them directly from there without having to reference SetupData. For example, calling |
![]() | WrNonUniqueIdException | An exception type that is thrown when an object that requires a unique ID (such as a parameter) is created and its ID is not unique. |
![]() | WrUserMessage | A general exception class that when thrown, displays an error message to the end user. |