Provides interfaces for programmatically working with the application, pages, page elements and their properties.

Remarks
The IHostAware and IApplicationXxx interfaces are only available to custom controls that have a .NET implementation and that need programmatic access to interact with the application (e.g., hooking events, requesting data from the DataHub Data Historian). That is, IHostAware and the IApplicationXxx interfaces are not used in script.

IPage, IPageElement and IPageElementParameter are indirectly available via Intrinsic Objects from any script expression.

The only classes exposed by this namespace derive from EventArgs and are for use with IApplication events, which means they too are only available to custom controls and are not used in script.

The enumerations are available in script. Many script functions and element properties require the value of a known enumeration (i.e., Enum). For example, normally the user would set the the alignment and resize behavior of an Image element using Property Explorer. However, setting the properties using script requires assigning the relevant enumeration values, as in this code.

Copy 
 SETP("Image1@HorizontalAlignment", HorizontalAlignment.Left);
 SETP("Image1@VerticalAlignment", VerticalAlignment.Center);
 SETP("Image1@Stretch", Stretch.None);
Classes
Name Description
Public class CultureEventArgs Contains event data for the IApplication.UICultureChanged event.
Public class EditorModeChangedEventArgs Contains event data for the IApplication.EditorModeChanged event.
Public class ZoomEventArgs Contains event data for the IApplication.ZoomChanged event.
Top
Interfaces
Name Description
Public interface IApplication Supports controls that need access to functionality exposed by the hosting application.
Public interface IApplicationConnection Supports controls that need to access server resources using the hosting application's web connection.
Public interface IApplicationData Supports controls that need to request historical data from hosting application's Data Historian.
Public interface IApplicationDiagnostics Supports controls that need to write messages to the hosting application's diagnostic trace log.
Public interface IApplicationMappingServices Supports controls that need to access mapping services.
Public interface IApplicationOptions Supports controls that need access to the hosting application's user options.
Public interface IHostAware Supports controls that need to be aware of their hosting environment.
Public interface IHostParameterLabel Obsolete. Supports controls that need to influence PropertyExplorer Parameter label text.
Public interface IPage Represents a logical container for a collection of controls saved as a 'Page' in the hosting application.
Public interface IPageElement Represents an element on a hosted page and provides access to the element's parameters.
Public interface IPageElementParameter Represents a parameter of an element on a hosted page.
Top
Enumerations
Name Description
Public enumeration BadDataAdornmentDefaultType Describes the possible values for the BadDataAdornment PageProperty.
Public enumeration BadDataAdornmentType Describes the possible values for the BadDataAdornment common property (which includes deferring to the page-level option).
Public enumeration BindingType Used when programmatically working with Parameter BindingExpressions.
Public enumeration CommandExecutionState Describes the state of a command that a control has requested the hosting application execute.
Public enumeration DataHubPointAttributes Used when programmatically working with the Parameter PointBindingExpression.
Public enumeration EditorModes Describes the possible states of the hosting application.
Public enumeration OptionAccessibility Used when registering an option category to describes the scope/accessibility of options.
Public enumeration PageElementAdornmentStyle
Public enumeration PointQueryOptions Describes options when performing a GetPointNames query.
Public enumeration Severity Describes the severity of a condition or a message relayed to the hosting application.
Public enumeration TagQueryOptions Describes options when checking an element's Tags.
Top
See Also