ExternalControl Class

Definition

Wraps external applications in a .Net control so the UII application host can treat them as normal UII hosted applications.

public ref class ExternalControl : System::Windows::Forms::Control
public class ExternalControl : System.Windows.Forms.Control
type ExternalControl = class
    inherit Control
Public Class ExternalControl
Inherits Control
Inheritance
ExternalControl

Constructors

ExternalControl(XmlDocument)

Initializes a new instance of the Microsoft.Uii.Csr.ExternalControl class with the specified initstring.

Properties

AssemblyUrl

Returns the configured path of the executable.

HandleRef

Returns a HandleRef for Control.Handle

HostInside
HostOnTop
Hwnd

Obsolete. Retained for legacy compatibility. Use MainWindow instead.

Icon

Icon extracted from the running process. Returns null if no icon could be extracted.

isAppClosing

flag to close applications

MainWindow

Top-level window handle of the external application.

NoMessagePump

Indicates whether message pump is enabled

Process

The running process associated with this control.

Methods

AttachListenersForWindowPositioning(TabItem)

Attaches to events on the specified tabItem and parent tabControl to support window positioning. Multiple invocations with the same tabItem will have the same effect as a single invocation. If window positioning is not configured, this method will have no effect.

AttachListenersForWindowPositioning(TabPage)

Attaches to events on the specified tabPage and parent tabControl to support window positioning. Multiple invocations with the same tabPage will have the same effect as a single invocation. If window positioning is not configured, this method will have no effect.

Clear()

Resets internal state so another initstring can be started. Any associated running Process will NOT terminated, use Close() to terminate the process.

Close()

Terminates the hosted Process. Attempts to first send MainWindow a close message before termination.

DetachAllListenersForWindowPositioning()

Detaches any previously attached events that support window positioning. If window positioning is not configured, this method will have no effect.

DetachAllListenersForWpfWindowPositioning()

Detaches any previously attached events that support window positioning. If window positioning is not configured, this method will have no effect.

Dispose(Boolean)

Dispose

HidePositionedWindow()

Hides the positioned window. If window positioning is not configured, this method will have no effect.

Host(Boolean)

Host

OnPaintBackground(PaintEventArgs)

OnPaintBackground

ShowAndActivateDeckPositionedWindow()

Shows and Activates (sizes and positions) the positioned window. If window positioning is not configured, this method will have no effect.

ShowAndActivatePositionedWindow()

Shows and Activates (sizes and positions) the positioned window. If window positioning is not configured, this method will have no effect.

Start(Boolean)

Parses initstring, launches the corresponding process (if one has not been already assigned), searches for (and acquires) the main window of the application, then configures a window management strategy based upon the initstring configuration.

Applies to