ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Framework Namespace / FrameworkApplication Class
Properties Methods Events


In This Topic
    FrameworkApplication Class Members
    In This Topic

    The following tables list the members exposed by FrameworkApplication.

    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic) Gets the DAML identifier of the currently active ribbon tab.  
    Public Propertystatic (Shared in Visual Basic) Gets the application's current tool. Only one tool is active at a time.  
    Public Propertystatic (Shared in Visual Basic)Gets the ArcGIS.Desktop.Framework.Contracts.Pane or ArcGIS.Desktop.Framework.Contracts.DockPane that is currently active.  
    Public Propertystatic (Shared in Visual Basic) Gets the application properties.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the application's theme that dictates its visual style. Three themes are supported: default (metro), dark, and high contrast.  
    Public Propertystatic (Shared in Visual Basic) Gets the contextual data that is passed to the commands in a context menu.  
    Public Propertystatic (Shared in Visual Basic) Gets the current context menu's default data context as a view-model. This is for Esri internal use only.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the application's current tool. Only one tool is active at a time.  
    Public PropertyGets the System.Windows.Threading.Dispatcher this System.Windows.Threading.DispatcherObject is associated with. (Inherited from System.Windows.Threading.DispatcherObject)
    Public Propertystatic (Shared in Visual Basic) Gets all the active dockpane instances; this singleton also lets you activate, create, and close dockpanes.  
    Public Propertystatic (Shared in Visual Basic) Gets the application's event aggregator.  
    Public Propertystatic (Shared in Visual Basic) Gets the default floating window name.  
    Public Propertystatic (Shared in Visual Basic) Gets the content flow direction for text and user interface elements.  
    Public Propertystatic (Shared in Visual Basic)Gets the Incoming tool. This is set when SetCurrentToolAsync is called.  
    Public Propertystatic (Shared in Visual Basic) Gets true once the application shell has been loaded and a license has been acquired.  
    Public Propertystatic (Shared in Visual Basic) Gets whether the application is the active application.  
    Public Propertystatic (Shared in Visual Basic) Gets whether the application backstage is open.  
    Public Propertystatic (Shared in Visual Basic) Gets a boolean value of true indicating the application is currently busy.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets a value indicating whether the application's user interface is currently enabled.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets whether the ribbon is currently minimized.  
    Public PropertyGets or sets the main window of the application. (Inherited from System.Windows.Application)
    Public Propertystatic (Shared in Visual Basic) Gets or sets the application's name which is displayed in the application's title bar. Note, the title bar will switch to the Title property if it is not empty.  
    Public Propertystatic (Shared in Visual Basic) Define the time span in seconds for showing the same notification to limit the toast display frequency.  
    Public Propertystatic (Shared in Visual Basic)Gets the Outgoing tool. This is set when SetCurrentToolAsync is called.  
    Public Propertystatic (Shared in Visual Basic) Gets all the active pane instances; this singleton also lets you activate, create, and close panes.  
    Public PropertyGets a collection of application-scope properties. (Inherited from System.Windows.Application)
    Public PropertyGets or sets a collection of application-scope resources, such as styles and brushes. (Inherited from System.Windows.Application)
    Public Propertystatic (Shared in Visual Basic) Get or sets the current user interface scaling factor.  
    Public PropertyGets or sets the condition that causes the System.Windows.Application.Shutdown method to be called. (Inherited from System.Windows.Application)
    Public PropertyGets or sets a UI that is automatically shown when an application starts. (Inherited from System.Windows.Application)
    Public Propertystatic (Shared in Visual Basic) Gets the application's state object.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the application's SubTitle.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the application's Title.  
    Public PropertyGets the instantiated windows in an application. (Inherited from System.Windows.Application)
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic) Activates the specified ribbon tab.  
    Public Methodstatic (Shared in Visual Basic) Focuses the main window.  
    Public Methodstatic (Shared in Visual Basic) Presents a notification.  
    Public Methodstatic (Shared in Visual Basic) Closes the application.  
    Public Methodstatic (Shared in Visual Basic) Closes the backstage.  
    Public Methodstatic (Shared in Visual Basic) Gets the contextual data as the requested type T. Contextual data represents the selected item (or items) that is passed to a command when executing that command on a context menu.  
    Public Methodstatic (Shared in Visual Basic)Overloaded.   
    Public Methodstatic (Shared in Visual Basic) Obtains a function that can be used to execute the specified command.  
    Public Methodstatic (Shared in Visual Basic) Obtains a function that can be used to execute the specified command with arguments.  
    Public Methodstatic (Shared in Visual Basic) Returns the specified module; the module is loaded if necessary.  
    Public MethodSearches for a user interface (UI) resource, such as a System.Windows.Style or System.Windows.Media.Brush, with the specified key, and throws an exception if the requested resource is not found (see XAML Resources). (Inherited from System.Windows.Application)
    Public Methodstatic (Shared in Visual Basic) Returns a collection of AddInfos representing the currently loaded add-ins.  
    Public Methodstatic (Shared in Visual Basic) Returns a run-time wrapper around the specified DAML component.  
    Public Methodstatic (Shared in Visual Basic) Hides all minitoolbars.  
    Public Methodstatic (Shared in Visual Basic) Opens the backstage.  
    Public Methodstatic (Shared in Visual Basic) Queues an action that will be performed when the application next enters an idle state where the user is not interacting with a modal dialog or performing any activity that might conflict with the specified action.  
    Public Methodstatic (Shared in Visual Basic) Adds the supplied customization filter to the application's customization model.  
    Public Methodstatic (Shared in Visual Basic) Removes the specified notification.  
    Public MethodOverloaded.  (Inherited from System.Windows.Application)
    Public Methodstatic (Shared in Visual Basic) Activates the specified tool.  
    Public Methodstatic (Shared in Visual Basic) Shows the help topic associated with the specified helpContextID.  
    Public Methodstatic (Shared in Visual Basic) Opens the specified wizard.  
    Public MethodOverloaded.  (Inherited from System.Windows.Application)
    Public Methodstatic (Shared in Visual Basic)Overloaded.   
    Public Methodstatic (Shared in Visual Basic) Sets the spell check language.  
    Public MethodSearches for the specified resource. (Inherited from System.Windows.Application)
    Public Methodstatic (Shared in Visual Basic) Removes the specified customization filter from the application's customization model.  
    Top
    Public Events
     NameDescription
    Public EventOccurs when an application becomes the foreground application. (Inherited from System.Windows.Application)
    Public EventOccurs when an application stops being the foreground application. (Inherited from System.Windows.Application)
    Public EventOccurs when an exception is thrown by an application but not handled. (Inherited from System.Windows.Application)
    Public EventOccurs just before an application shuts down, and cannot be canceled. (Inherited from System.Windows.Application)
    Public EventOccurs when a navigator in the application begins navigation to a content fragment, Navigation occurs immediately if the desired fragment is in the current content, or after the source XAML content has been loaded if the desired fragment is in different content. (Inherited from System.Windows.Application)
    Public EventOccurs when content that was navigated to by a navigator in the application has been loaded, parsed, and has begun rendering. (Inherited from System.Windows.Application)
    Public EventOccurs when the content that is being navigated to by a navigator in the application has been found, although it may not have completed loading. (Inherited from System.Windows.Application)
    Public EventOccurs when a new navigation is requested by a navigator in the application. (Inherited from System.Windows.Application)
    Public EventOccurs when an error occurs while a navigator in the application is navigating to the requested content. (Inherited from System.Windows.Application)
    Public EventOccurs periodically during a download that is being managed by a navigator in the application to provide navigation progress information. (Inherited from System.Windows.Application)
    Public EventOccurs when the StopLoading method of a navigator in the application is called, or when a new navigation is requested by a navigator while a current navigation is in progress. (Inherited from System.Windows.Application)
    Public EventOccurs when the user ends the Windows session by logging off or shutting down the operating system. (Inherited from System.Windows.Application)
    Public EventOccurs when the System.Windows.Application.Run method of the System.Windows.Application object is called. (Inherited from System.Windows.Application)
    Top
    See Also