McApplication Object
    
 
Description

This is the IQL application object.

Object Model

































Remarks

This object is the root of the IQL object model. Since this object has the appobject attribute, all of its methods and properties become available in the global name space (VB and VBA projects). It is one of the only creatable objects of the IQL object model (it can be created using New or CreateObject).

Members

Methods
AncestorOfOperatormethod AncestorOfOperator
CaptureWindow

Captures a portion of the screen either by a specified rectangle coordinates, a window name or handle

CreateObjectmethod CreateObject
CreateOperatormethod CreateOperator
EnumUserMeasurementsmethod EnumUserMeasurements
Exit

Exit the application.

FindWindow

Finds a window “handle” if the window exists

GetOperator

Returns an instance of a named operator for a given Parent.

GetRegisteredUserMeasurementmethod GetRegisteredUserMeasurement
LocalizeControls

Localize a control, a form or a collection of controls.

Localized

Translate an english string to its equivalent in the current language.

LocalizedHelpId

Returns a localized (language specific) help context for a named feature.

LocalizeString

Translate an english string to its equivalent in the current language.

ParentOfOperatormethod ParentOfOperator
RegisterUserMeasurementmethod RegisterUserMeasurement
ReportLicensesInUsemethod ReportLicensesInUse
SetBusyState

Changes the application cursor and manages the progress meter.

SetToolHelp

Displays help text for tools.

ShowAddIns

Display the Add-in Manager dialog.

ShowError

Logs an error to the EventLog and optionally shows an error message dialog.

ShowHelp

Display a Windows (.hlp) or compiled HTML help file (.chm)


Properties
ActiveImageRead-write propertyproperty ActiveImage
ActiveImageAliasRead-only propertyproperty ActiveImageAlias
ActiveWindowRead-only property

Returns a reference to the foreground image workspace.

AddInsRead-only property

Returns a reference to the application's Add-in collection.

AoiListRead-only propertyAoiList Operator
ApplicationRead-only property

Returns a reference to the application object McApplication.

CaptureRead-only propertyCapture operator
CommandBarsRead-only property

Returns the McCommandBars collection.

CommandsRead-only property
DatabasesRead-only propertyAvailable databases
DataManagerRead-only property
DataViewerRead-only property
DialogsRead-only property

Returns a reference to the dialog collection.

EventLogRead-only propertyproperty EventLog
ExeNameRead-only property

Returns the name of the application's executable file without the extension.

ExePathRead-only property

This property returns the fully qualified path of the directory where the application's main executable is installed.

FullScreenRead-write property

Switches full screen mode on or off.

hWndRead-only property

Returns the window handle of the main application window.

IdentitiesRead-only property

Returns a reference to the identities collection.

ImageFilesRead-only propertyFile Converter
ImagesRead-only propertyproperty Images
IntensityCalibsRead-only propertyproperty IntensityCalibs
IsAutomatedRead-only property

This property is True when the application was started by OLE automation.

IsMetricRead-only property

Returns whether the current regional settings use metric units or not.

IsRunTimeRead-only property

Returns True if this McApplication instance is controlled by the run time engine (McRunTime).

LocaleRead-only property

Returns the currently selected locale (LCID).

LocaleFontRead-only property

Returns a StdFont object appropriate for the current locale.

McObjectRead-only propertyproperty McObject
McObjectsRead-only propertyproperty McObjects
MeasurementsRead-only property
MeasurementSequenceRead-only propertyproperty MeasurementSequence
ModelAnnotationOverlayRead-only propertyModel overlay layer for annotations
NameRead-only property

Returns the name (title) of the application.

OutputRead-only property

Returns a reference to the McOutput object of the application.

PathRead-only property

Returns the absolute path of the folder where application data is stored.

PrintManagerRead-only property
ProjectsRead-only property

Returns a reference to the project collection.

RecorderRead-only property

Gives access to the recording API.

ReporterRead-only property
SCalibrationRead-only property
ScreenCapturesRead-only propertyScreen Capture Files
SettingsRead-only property

Returns a collection of settings for a given Module and Section.

SpatialCalibsRead-only propertyproperty SpatialCalibs
StatusBarRead-only property

Returns a reference to the McStatusBar object of the application.

ThresholdToolRead-only property
VBERead-only property

Returns a reference to the VBA object model.

VersionRead-only property

Returns the version of the application.

VisibleRead-write property

Returns or set whether the application is visible or not.

WindowPositionRead-write property

Sets or reveals the position of the main application window or optionally a given window.

WindowsRead-only property

Returns a reference to the window collection.


Events
ActivateIdentity

This event is fired when the active identity is about to change.

AfterActivateIdentity

This event is fired when an identity has just been activated.

AfterError

This event is sent after an error is detected but before the error is logged or a message box is shown

AfterIdentityChanged

This event is fired when an identity is being reset.

AfterInitialize

This event is sent after the application is created.

BeforeActivateIdentity

This event is fired when the active identity is about to change.

BeforeIdentityChanged

This event is fired before an identity is reset.

BeforeShutdown

This event is sent before the shutdown procedure starts.

Initialize

This event is sent when the application is created.

SettingChanged

This event is sent whenever a setting is changed.

Shutdown

This event is sent just before the applications exits.