|
|
The Application type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
|
BeginProgress()()()() |
Provides an instance of the Progress class
which starts reporting of progress of an operation, typically displaying a progress bar
or dialog to the end user.
|
|
|
BeginProgress(String) |
Provides an instance of the Progress class
which starts reporting of progress of an operation, typically displaying a progress bar
or dialog to the end user.
|
|
|
BeginProgress(String, String) |
Provides an instance of the Progress class
which starts reporting of progress of an operation, typically displaying a progress bar
or dialog to the end user.
|
|
|
EndProgress |
Finishes the operation and disposes of the Progress control allocated using BeginProgress()
|
|
|
Equals | (Inherited from Object.) |
|
|
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode |
Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
|
|
GetType |
Gets the Type of the current instance. (Inherited from Object.) |
|
|
LoadDocumentInfo |
Load DocumentInfo.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
RegisterBitmap |
Register a bitmap for later use by the graphics system. The function returns
an integer ID, or -1 if registration failed.
|
|
|
ToString | (Inherited from Object.) |
|
|
TryLoadDocumentInfo |
Try to Load DocumentInfo.
|
|
|
UnregisterBitmap |
Unregister a previously registered bitmap. The function returns
true if successful, or false otherwise.
|
Properties
| Name | Description | |
|---|---|---|
|
|
ActiveDocument |
Gets a reference to the current Document being displayed in a View
|
|
|
Automation |
Gets a reference to the
ApplicationAutomation singleton,
which provides the same interface for automation as NavisWorksApplication in the Automation assembly
|
|
|
Bim360 |
Provides access to the BIM360 state of the application of which is hosting the API. Will be null
if the application doesn't have BIM360 state.
|
|
|
Documents |
Gets a reference to the Read Only collection of documents currently open
|
|
|
DragDrop |
Provides access to Drag Drop utilities.
|
|
|
Gui |
Provides information about the Gui of the application which is hosting the API. Will be null
if the application doesn't have a Gui.
|
|
|
IsAutomated |
Gets whether this instance is running under Automation
|
|
|
MainDocument |
Gets a reference to the Primary Document being worked on. Once set the MainDocument does
not change for the lifetime of the application.
|
|
|
Options |
Provides access to Application Options.
|
|
|
Plugins |
Provides information about the Plugins available
in the application runtime
|
|
|
Resources |
Provides access to Application Resources.
|
|
|
Title |
Title for application. Suitable for display in window title bar, or similar.
|
|
|
Version |
Provides information about the version of the currently running API and Runtime
|
Events
| Name | Description | |
|---|---|---|
|
|
ActiveDocumentChanged |
Occurs when the ActiveDocument has changed
|
|
|
ActiveDocumentChanging |
Occurs when the ActiveDocument is about to change
|
|
|
Bim360Created |
Occurs when the Application's BIM360 state been created. Bim360 will be non-null.
|
|
|
Bim360Destroying |
Occurs when the Application's BIM360 state is about to be destroyed. Bim360 will be set to
null after this event has been raised.
|
|
|
DocumentAdded | |
|
|
DocumentRemoved | |
|
|
FileInteractiveResolved |
Occurs when a file reference has been interactively resolved. Raised before FileResolved if
automatic resolution has failed.
|
|
|
FileInteractiveResolving |
Occurs when a file reference needs to be interactively resolved. Raised after FileResolving
if automatic resolution has failed.
|
|
|
FileResolved |
Occurs when a file reference has been resolved. Typically when opening a file.
|
|
|
FileResolving |
Occurs when a file reference needs to be resolved. Typically when opening a file.
|
|
|
GuiCreated |
Occurs when the Application's GUI has been created. Gui will be non-null.
|
|
|
GuiDestroying |
Occurs when the Application's GUI is about to be destroyed. Gui will be set to
null after this event has been raised.
|
|
|
Idle |
Occurs when the application finishes processing and is about to enter the idle state.
|
|
|
MainDocumentChanged |
Occurs when the MainDocument has changed
|
|
|
MainDocumentChanging |
Occurs when the MainDocument is about to change.
|
|
|
ProgressBeginning |
Occurs when BeginProgress() is called.
If any handler markes the event as handled, the standard progress dialog will not be displayed.
|
|
|
ProgressEnded |
Occurs when EndProgress is called.
|
|
|
ProgressErrorReporting |
Occurs when an error occurs during the lifetime of a
Progress object.
For example, if an error occurs whilst opening a large file the error
can be displayed to the user who is offered the chance to cancel.
|
|
|
ProgressMessageReporting |
Occurs during Progress
reporting when message describing current operation is updated.
|
|
|
ProgressSubOperationBegan |
Occurs when Progress.BeginSubOperation
is called.
|
|
|
ProgressSubOperationEnded |
Occurs when Progress.EndSubOperation
is called.
|
|
|
ProgressUpdating |
Occurs during Progress
reporting when progress is updated.
|