Namespace PolarStudio

Classes

AppConfiguration

The AppConfiguration contains the whole configuration of this server-application.

AppConfiguration_ApplicationSettings

This class stores the specific settings of an application in a project

AppConfiguration_Connection

This class contains the configuration parameters for a connection

AppConfiguration_CustomProperty

This class contains Name/Value pairs (string/string) for custom properties for the configuration.

AppConfiguration_WebService

This class contains the configuration parameters for a WebService

Application

An application in the presentation-layer as started for a user in a session. Is tied to an BudaApplication in the data-layer.

AuthenticationResult

This class is used to communicate the result of an authentication request.

AuthenticationResult_AllowedApplication

This class contains the information about allowing the user to use a specific application in the project.

This class is the Server that creates all web applications. Only one server object is running on a server for all users (for one project). The Server is responsible for the presentation layer and uses the data layer as is provided by the BudaEngine.

Blob

This class provides an easy interface to work with blobs in blob-fields. Blobs are files stored in either the database (in Image or Binary fields) or are stored in the file system while the meta-data is stored in the database in a Text or Varchar field.

BrowserMessage

This class contains info about one message that is queued to be sent to the browser.

BrowserMessages

This class contains the messages that are to be sent to the browser of the user.

BudaApplication

An instanced application opened for a specific user. Use pContext.Session.OpenApplication() to create a new BudaApplication.

BudaDataSet

The BudaDataSet is the Polar Studio way of communicating with the data in the database. It is like a Recordset, but with all features added by Polar Studio

BudaEngine

The core Engine of Polar Studio. There is only one single instance active of the Engine. All other object are created from here.

BudaField

This class contains one field in a dataset.

BudaFields

This class contains the fields of a dataset.

BudaGroup

This class contains info about the group a user is in.

BudaSession

This class represents a session in the data-layer of a user. This session is used to log on to, to open applications, etc.

BudaUser

This class contains information about a user that is logged on to Polar Studio.

Button

This class contains the information about one button as can be shown in the user interface.

Buttons

This class is the container for a set of buttons, for example for the buttons at application or form-level

Context

This class is the generic interface to the items in the context. Depending on the source of the context, some properties may be Nothing/null.

ContextContainer

This class provides access to the Context object and supplies various functions that extend the scripting language.

Control

This class contains one control as is loaded in a form for a web session.

Controls

This class contains Controls.

CustomButton

This class is a container for a button custom created in Polar Studio

CustomButtons

This class contains all buttons that are custom created in Polar Studio

CustomCodeModule

The CustomCodeModule object is used to load custom code (full modules) to execute custom scripts.

CustomFilter

This class contains the details of a custom filter.

CustomFilters

This class can be used to create custom filters to add to a dataset

DataConnector

This class provides a standardized interface with a database.

DataExchange

This class is the main object for creating and importing data exchange files.

DataExchangeTable

This class contains the details of a data exchange table.

DataExchangeTables

This class contains a set of data exchange tables.

EditBufferField

This class contains the temporary value of a field in an EditBufferRecord object.

EditBufferRecord

This class keeps track of a record shown in listview. This edit buffer is the temporary buffer used for as long the data is not stored permanently in the database.

Feature

This class contains the value of a feature. Features can be numeric (int) or non-numeric (meaning boolean)

FeaturesCollection

This class is used to provide an interface to specific configurable features.

Form

This class represents a form as is opened for a user in a web application. This can be either a normal (bound or unbound) form or a system-form (like Polar Tools).

FormFields

This class is used to access the fields that are sent in a HTML form.

GenericEnumeratorPID<T>

This class is an implementation of the GenericEnumerator that needs to store elements based on Name and PID (a GUID-like string)

GenericEnumerator<T>

Class used for deriving enumerating classes from (mainly used for the repository)

IndexedCollection<T>

A collection of items that have a numeric (int) index.

LoggedError

This class contains the details of a logged unhandled error.

LookupCache

This class is used for caching lookup values.

MenuItem

This class is the representation of a menu item in the Polar Studio menu.

MenuItems

This class contains the menu items for a web session

OneTimePassword

This Class is a helper to manage one time passwords using the TOTP mechanism.

PolarCertificate

This class provides an interface to get values from a Blue Polar Certificate, as is used for licence certificates for Polar Studio.

PolarServerApplication

This class contains one application running on the server.

PolarServerApplications

This class is a container for Polar server spplications

PolarStudioServer

This class is a helper to use Polar Studio in a IIS server

PolarTimeZone

This class is a wrapper for a timezone.

PolarTimeZones

This class contains all the found timezones.

PolarTimerManagerUI

This class creates the user interface for the built in Timer Manger

PolarTimerManagerUI.Timer

This class contains the details of a timer.

PolarTimerManagerUI.TimerError

This class contains the details of an error in the timer.

PolarTools

This class contains the PolarTools components used in a web session.

PolarToolsComponent

The template for PolarToolsComponents

PolarToolsComponent_AllTablesMenu

This class is the implementation of the Polar Tools component 'All tables menu'.

PolarToolsComponent_CurrentUsers

This class is the implementation of the Polar Tools component 'Current users'.

PolarToolsComponent_DatabaseDocumentation

This class is the implementation of the Polar Tools component 'Database documentation'.

PolarToolsComponent_ErrorLog

This class is the implementation of the Polar Tools component 'Error log'.

PolarToolsComponent_InstantSQL

This class is the implementation of the Polar Tools component 'Instant SQL'.

PolarToolsComponent_InstantScript

This class is the implementation of the Polar Tools component 'Instant script'.

PolarToolsComponent_Log

This class is the implementation of the Polar Tools components 'Logs'

PolarToolsComponent_LoginLog

This class is the implementation of the Polar Tools component 'Login log'.

PolarToolsComponent_PerformanceOverview

This class is the implementation of the Polar Tools component 'Performance overview'.

PolarToolsComponent_SendMessageToAllSessions

This class is the implementation of the Polar Tools component 'Send message to all sessions'.

PolarToolsComponent_ServerStats

This class is the implementation of the Polar Tools component 'Server stats'.

PolarToolsComponent_TestMail

This class is the implementation of the Polar Tools component 'Test mail'.

PolarXMLdocument

This class is a wrapper for the main parsing functions of the dot net XmlDocument object to give it an equal interface as the MSXML objects.

PolarXMLnode

This class is a wrapper for an XML node.

Report

This class contains a report as defined in Polar Reports.

ReportCategory

This class represents a category that holds one or more categorized reports.

ReportColumn

This class contains the details of a column in a report.

ReportConnection

This class contains the specifics of a custom connection for reporting.

ReportEngine

This class is the engine that creates the reporting html and interfaces with the user's web session

ReportFilter

This class contains the details of a filter in a report.

ReportParameter

This class contains the details of a report parameter.

ReportSubReportDefinition

This class contains the details for a sub report.

ReportUI

This class is the reporting user interface for a web session.

Request

The Request only lives while one request is processed.

ReturnBlobResponse

This class contains the data as can be returned when a blob is requested

SavedQuery

This class contains the data for one saved query.

ServerVariables

This class provided a similar interface to the server variables as was available in classic ASP applications. Not all variables are implemented.

Session

This class is created for each (Web)session.

StatsManager

This class is used to keep track of statistics of the server. A StatsManager has an interval (for example 1 minute or 5 minutes) over which the statistics are kept. For each of these intervals several numbers are stored.

StatsRecord

This class contains the details of one StatsRecord that contains the information about one interval in the StatsManager.

Style

This class contains css style settings for a control in Polar Studio. These style settings can be manipulated. Also, this object can create the style expression as to add to a HTML control.

StyleProperties

This class contains collection of properties for a style

StyleProperty

This class contains the specifics of one specific style property

TextButton

This class represents one text button as added to a session, an application or a form.

TextButtons

This class is used to create and manipulate text buttons.

Transaction

This class is used for simplifying the use of transactions in script.

UpdateDatabase

This class is used to update a polar studio data database to the newest version according to the used project.

UpdateMetaModel

This class is used in Polar Studio internally to update and sanitize the repository.

UserSettings

The UserSettings provide a standardized way to get/set user-specific settings.

XMLcollection<ParentObjectType, ChildObjectType>

A collection of objects with their definition stored in XML

XMLobject<ParentObjectType>

Returns one object in an xml collection.

XMLparent

An extension for objects that can be contained in XMLcollections.

XMLparseError

This class is a wrapper for the ParseError.

clsBPwebQueryString

This method provides an easy interface to the query string of a request.

clsBPwebRequest

This class is used as wrapper/interface for the web request

clsBPwebResponse

This class provides a generic wrapper/interface for the HttpResponse used for processing the current request.

repApplication

This class contains the information about an application in the Polar Studio repository.

repApplicationSettings

This class contains the group specific settings for an application.

repApplications

This class contains the applications in the Polar Studio repository.

repControl

This class contains the information about a control in the Polar Studio repository.

repControlSettings

This class contains the group specific settings for a control.

repControls

This class contains the controls in a form in the Polar Studio repository.

repCustomControl

This class contains information about a custom control in the Polar Studio repository.

repCustomControls

This class contains the custom controls defined in the Polar Studio repository.

repDomain

This class contains the information about a domain in an application in the Polar Studio repository.

repDomainOption

This class conains an option in a ValueList domain.

repDomainOptions

This class contains the options of a ValueList domain.

repDomains

This class contains the domains in an application in the Polar Studio repository.

repField

This class contains a field in the Polar Studio repository.

repFieldSettings

This class contains the group specific field settings.

repFieldStatePermissions

This class returns the permissions for a field for a specifc state.

repFields

This class contains the fields in a table in the Polar Studio repository.

repFillWithField

This class contains the details of a field with field.

repFillWithFields

This class contains the fields an empty field can be filled with when a foreign key is set in its table.

repFilter

This class contains the information for a filter on a table

repFilterPermissions

This class contains the permissions for a filter.

repFilters

This class contains the filters for a table as defined in the Polar Studio repository.

repForm

This class contains a form in the repository.

repFormOrder

This class contains the settings for a form order defined in the repository.

repFormOrderControlProperties

This class contains the properties for a control for the form order.

repFormOrderControlPropertiesList

This class contains the control properties of a form order.

repFormOrderPermissions

This class contains the permissions of a form order.

repFormOrders

This class contains the orders defined in a form.

repFormSettings

This class contains the group specific settings for a form.

repForms

This class contains the forms in an application in the Polar Studio repository.

repGroup

This class contains the details of a group in the repository.

repGroups

This class contains the groups of an application in the Polar Studio repository.

repLanguage

This class contains the details of a language in the Polar Studio repository.

repLanguages

This class contains the languages defined in the Polar Studio repository.

repProject

This is the main repository object that contains (directly or indirectly) all other repository objects.

repRelationship

This class contains the details of a relationship in the repository.

repRelationshipDependencies

This class contains a set of dependencies.

repRelationshipDependency

This class contains the details about a dependency.

repRelationships

This class contains a set of relationships

repState

This class contains the details of a state in the repository.

repStateTransition

This class contains the details of a state transition in the Polar Studio repository.

repStateTransitionSettings

This class contains the group specific settings of a state transition.

repStateTransitions

This class contains a set of state transitions.

repStates

This class contains a collection of states.

repTable

This class contains the details of a table in the repository.

repTablePermissions

This class contains the group/state specific table permissions.

repTableSettings

This class contains the group specific settings of a table.

repTables

This class contains the tables in an application the repository of polar studio..

repUniqueSet

This class contains the details of a unique set.

repUniqueSetField

This class contains the details of a field in a unique set.

repUniqueSetFields

This class contains the fields in a unique set.

repUniqueSets

This class contains the unique sets in a table in the repository of Polar Studio.

Enums

AppConfiguration_Connection.AppConfigurationConnectionType

The type of database connection

AuthenticationResult.OneTimePassword_KeyType

This enum is used to communicate about the current OneTimePassword

AuthenticationResult.OneTimePassword_Status

This enum indicates if a OneTimePassword is to be used.

BrowserMessages.SuppressDuplicatesEnum

This enum is to configure the mechanism to suppress multiple identical messages

ButtonContext

This enum is used for the context of custom buttons

ButtonUpdatePolicy

This enum is used to set the Update Policy for custom buttons. This update takes place before the custom button action is called.

ColumnAlignment

This enum is used to set the alignment of a report column.

ConfirmStateTransition

This enum is used to set the confirmation of a state transition.

CrossTabFunction

This enum lists the functions (roles) of a column in a cross-tab report.

DataConnector.dcConnectionType

This enum indicates the type of connection.

DateFormat

This enum is used to set the dateformat for a session.

DateSeparator

This enum is used to set the date separator for a session.

DecimalCharacter

This enum is used to set the decimal character for a session.

ImplicitMultiScript

ImplicitMultiScript is used to run multiple implicit scripts for specific named events. Implicit Multi-Scripts are scripts that are defined as private, so there can be multiple instances of a specific event-handler. For events that are 'Breaking', for example an Project_GlobalOnUpdate, use BreakOnResult. For non-breaking events, like Project_GlobalOnCloseForm use IgnoreResults.

Table of Contents

Namespace PolarStudio

Classes