XafApplication Members

Manages an XAF application.

Constructors

Name Description
XafApplication()

Creates an instance of the XafApplication class.

XafApplication(ITypesInfo)

Creates an instance of the XafApplication class and initializes the XafApplication.TypesInfo property to a specified value.

Fields

Name Description
Confirmations

Gets the name on the Localization node's child node that provides access to the localizable confirmations texts.

CurrentVersion

For internal use only.

ModelCacheLocationKey

The name of the configuration file key, which specifies the Application Model cache file location (see XafApplication.EnableModelCache).

OptionsNodeName

For internal use only.

TablePrefixesKey

For internal use.

TraceLogLocationKey

Specifies the setting in the configuration file's appSettings section. This setting specifies the log file location.

XafApplicationLogonCatchExceptionKey

Specifies a string identifier for exceptions occurred while logging on to the application.

Properties

Name Description
ApplicationName

Specifies the application's name.

CanRaiseEvents Gets a value indicating whether the component can raise an event.
(Inherited from Component)
CheckCompatibilityType

Specifies how the database and application compatibility is checked.

Connection

Specifies the connection to the database used by the application.

ConnectionString

Specifies the connection string which is used to connect to the application's database or to the Application Server.

Container Gets the that contains the .
(Inherited from Component)
CurrentAspectProvider

Returns an ICurrentAspectProvider object that supplies culture-specific information.

DatabaseUpdateMode

Specifies the mode of updating the database.

DefaultCollectionSourceMode

Specifies the default mode of operation for Collection Sources created by the XafApplication.

DelayedViewItemsInitialization

Indicates whether View Items controls are initialized immediately when a View is created.

DesignMode Gets a value that indicates whether the is currently in design mode.
(Inherited from Component)
EditorFactory

Provides access to the application's Editors Factory, which is used to load View Items and List Editors to the Application Model and create them when needed.

EnableModelCache

Specifies if the Application Model cache designed to improve the startup speed and performance is enabled.

Events Gets the list of event handlers that are attached to this .
(Inherited from Component)
IgnoredExceptions

Returns a collection of exceptions that are not to be reported by the application.

IsConnectionOwner

For internal use only.

IsDelayedDetailViewDataLoadingEnabled

Specifies if delayed loading is enabled for Detail Views in WinForms applications. See WinApplication.IsDelayedDetailViewDataLoadingEnabled.

IsLoading

Indicates whether the application component is currently being initialized.

LinkNewObjectToParentImmediately

Specifies whether or not a link between a master and child object is created immediately when the NewObjectViewController.NewObjectAction is executed in a nested List View with a non-aggregated collection.

MainWindow

Provides access to the application's main Window.

MaxLogonAttemptCount

Specifies the allowed number of failed login attempts before the application closes.

Model

Provides access to the Application Model's root node.

Modules

Provides access to the module list used by the application.

ObjectSpaceProvider

Provides access to the application's Object Space Provider.

ObjectSpaceProviders

Gets a list of Object Space Providers used by XafApplication.

OptimizedControllersCreation

Disables the instantiation of Controllers that will never be activated in nested List Views.

ResourcesExportedToModel

Provides access to a collection of Resource Localizers used in the current application to extend the Application Model's IModelLocalization node.

Security

Provides access to the Security Strategy used in the application.

ShowViewStrategy

Specifies the application's Show View Strategy.

Site

For internal use only.

TablePrefixes

For internal use.

Title

Gets the name associated with the application.

TypesInfo

Gets the ITypesInfo object that supplies metadata on types used in an XAF application.

Methods

Name Description
AskConfirmation(ConfirmationType)

Requests an end-user confirmation.

BeginInit()

Starts the XafApplication's initialization. Initialization occurs at runtime.

CheckCompatibility()

Checks whether the application and database are compatible, and if not, tries to make them compatible.

CreateCollectionSource(IObjectSpace, Type, String)

Creates a collection source for a specified List View.

CreateCollectionSource(IObjectSpace, Type, String, Boolean, CollectionSourceMode)

Creates a Collection Source for a specific List View.

CreateCollectionSource(IObjectSpace, Type, String, CollectionSourceDataAccessMode, CollectionSourceMode)

Creates a Collection Source for a specific List View.

CreateCollectionSource(IObjectSpace, Type, String, CollectionSourceMode)

Creates a Collection Source for a specific List View.

CreateController<ControllerType>()

Creates a Controller of a specified type. If there is a Controller of the same type, assigns its settings to the new Controller.

CreateDashboardView(IObjectSpace, String, Boolean)

Creates a Dashboard View using information from the Application Model's Views | DashboardView node specified by the dashboardViewID parameter.

CreateDatabaseUpdater(IObjectSpaceProvider)

Creates a Database Updater for a specified Object Space Provider.

CreateDetailView(IObjectSpace, IModelDetailView, Boolean)

Creates a Detail View based on information from the Application Model's Views | DetailView node specified by the modelDetailView parameter.

CreateDetailView(IObjectSpace, IModelDetailView, Boolean, Object)

Creates a Detail View for the specified object with settings from the Application Model's Views | DetailView node specified by the modelDetailView parameter.

CreateDetailView(IObjectSpace, Object)

Creates a Detail View based on information specified in the Application Model for the type of the specified object.

CreateDetailView(IObjectSpace, Object, Boolean)

Creates a DetailView for the specified object and initializes its properties.

CreateDetailView(IObjectSpace, Object, View)

Creates a Detail View for a specified object based on information on the source View.

CreateDetailView(IObjectSpace, String, Boolean)

Creates a Detail View based on information from the Application Model's Views | DetailView node specified by the detailViewID parameter.

CreateDetailView(IObjectSpace, String, Boolean, Object)

Creates a Detail View for the specified object based on the information from the Application Model's Views | DetailView node specified by the detailViewID parameter.

CreateDetailView(IObjectSpace, String, Boolean, Object, Boolean)

For internal use.

CreateDetailView(Object)

Creates a Detail View based on information specified in the Application Model for the type of the specified object.

CreateDetailView(Object, Boolean)

Creates a Detail View based on information specified in the Application Model for the type of the specified object.

CreateFrame(TemplateContext)

Creates a new Frame.

CreateLayoutManager(Boolean)

Creates a Layout Manager.

CreateListEditor(CollectionSourceBase, IModelListView)

Creates the List Editor which is specified in the appropriate Application Model node.

CreateListView(IModelListView, CollectionSourceBase, Boolean)

Creates a List View based on the information from the Application Model's node specified by the modelListView parameter.

CreateListView(IModelListView, CollectionSourceBase, Boolean, ListEditor)

Creates a List View based on the information from the Application Model's node specified by the modelListView parameter using the provided ListEditor.

CreateListView(IObjectSpace, Type, Boolean)

Creates a List View used for the objects of the specified type, by default.

CreateListView(String, CollectionSourceBase, Boolean)

Creates a List View based on information from the Application Model's Views | View node specified by the listViewId parameter.

CreateListView(Type, Boolean)

Creates a List View used for the objects of the specified type, by default.

CreateNestedFrame(ViewItem, TemplateContext)
CreateNestedFrame(ViewItem, TemplateContext, View)
CreateNestedObjectSpace(IObjectSpace)

Creates nested Object Space.

CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
CreateObjectSpace()

Creates an Object Space. Use this method overload if your application registers only one Object Space Provider.

CreateObjectSpace(Type)

Creates an Object Space that supports a given object type. Use this method overload if your application registers several Object Space Providers.

CreatePopupWindow(TemplateContext, String, Boolean, Controller[])

Creates a new pop-up Window.

CreatePopupWindow(TemplateContext, String, Controller[])

Creates a new pop-up Window.

CreatePopupWindow(TemplateContext, String, View, Boolean, Controller[])
CreatePropertyCollectionSource(IObjectSpace, Type, Object, IMemberInfo, String)

Creates a Collection Source for a nested List View that displays a collection property.

CreatePropertyCollectionSource(IObjectSpace, Type, Object, IMemberInfo, String, Boolean, CollectionSourceMode)

Creates a Collection Source for a nested List View that displays a collection property.

CreatePropertyCollectionSource(IObjectSpace, Type, Object, IMemberInfo, String, CollectionSourceDataAccessMode, CollectionSourceMode)

Creates a Collection Source for a nested List View that displays a collection property.

CreatePropertyCollectionSource(IObjectSpace, Type, Object, IMemberInfo, String, CollectionSourceMode)

Creates a Collection Source for a nested List View that displays a collection property.

CreateTemplate(String)

For internal use only.

CreateWindow(TemplateContext, ICollection<Controller>, Boolean)

Creates a new Window.

CreateWindow(TemplateContext, ICollection<Controller>, Boolean, Boolean)

Creates a new Window.

CreateWindow(TemplateContext, ICollection<Controller>, Boolean, Boolean, View)
Dispose() Releases all resources used by the .
(Inherited from Component)
EndInit()

Ends the XafApplication's initialization.

Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) Determines whether the specified object instances are considered equal.
(Inherited from Object)
Exit()

Finishes runing the application.

FindDetailViewId(Object, View)

Returns the ID of the Detail View which must be used for a specific object, when invoked from the source View.

FindDetailViewId(Type)

Returns the ID of the Detail View which is used for objects of a specified type by default.

FindListViewId(Type)

Returns the ID of the List View which is used for objects of a specified type by default.

FindLookupListViewId(Type)

Returnes the ID of the Lookup List View which is used for objects of a specified type by default.

FindModelClass(Type)

Returns the Application Model's IModelClass node representing the specific business class.

FindModelView(String)

Provides access the Application Model node that defines a specified View.

GetCompletedViewShortcut(ViewShortcut)

For internal use only.

GetDetailViewId(Type)

Returns the ID of the Detail View which is used for objects of a specified type by default, and raises an exception if the appropriate View ID is not found.

GetDiffDefaultName(String)

Gets the model differences file name

GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
GetListViewId(Type)

Returns the ID of the List View which is used for objects of a specified type by default, and raises an exception if the appropriate View ID is not found.

GetObjectSpaceToShowDetailViewFrom(Frame, Type)

Returns an Object Space in which a Detail View should be created to be displayed via the ShowViewStrategyBase.ShowView method.

GetObjectSpaceToShowDetailViewFrom(Frame, Type, TargetWindow)

Returns an Object Space in which a Detail View should be created to be displayed via the ShowViewStrategyBase.ShowView method.

GetService(Type) Returns an object that represents a service provided by the or by its .
(Inherited from Component)
GetTemplateCustomizationModel(IFrameTemplate)

Returns the Application Model node where settings of a specified Template are stored.

GetType() Gets the of the current instance.
(Inherited from Object)
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
LogOff()

Performs the application logout.

Logon()

Performs the logon.

MemberwiseClone() Creates a shallow copy of the current .
(Inherited from Object)
MemberwiseClone(Boolean) Creates a shallow copy of the current object.
(Inherited from MarshalByRefObject)
ProcessShortcut(ViewShortcut)

Creates a View by a specified shortcut.

ReferenceEquals(Object, Object) Determines whether the specified instances are the same instance.
(Inherited from Object)
SaveModelChanges()

Saves the changes made by an end-user, up to the current moment, to the differences storage.

SetFormattingCulture(String)

Sets the specified formatting culture for the current application.

SetLanguage(String)

Sets the specified language for the current application when called before the application windows are shown.

Setup()

Initializes the newly created XafApplication class instance.

Setup(ExpressApplicationSetupParameters)

Initializes the newly created XafApplication class instance.

Setup(String, IList<IObjectSpaceProvider>, ApplicationModulesManager, ISecurityStrategyBase)

Initializes the newly created XafApplication class instance.

Setup(String, IList<IObjectSpaceProvider>, String[], ISecurityStrategyBase)

Initializes the newly created XafApplication class instance.

Setup(String, IObjectSpaceProvider)

Initializes the newly created XafApplication class instance.

Setup(String, IObjectSpaceProvider, ApplicationModulesManager, ISecurityStrategyBase)

Initializes the newly created XafApplication class instance.

Setup(String, IObjectSpaceProvider, String[], ISecurityStrategyBase)

Initializes the newly created XafApplication class instance.

Setup(String, String, String[])

Initializes the newly created XafApplication class instance.

Setup(String, String, String[], ISecurityStrategyBase)

Initializes the newly created XafApplication class instance.

ShowDetailViewFrom(Frame)

Indicates whether a Views invoked from the specified Frame can be displayed in a new Window.

ToString() Returns a containing the name of the , if any. This method should not be overridden.
(Inherited from Component)
UpdateStatus(String, String, String, Object[])

Triggers the XafApplication.StatusUpdating event.

Events

Name Description
CreateCustomCollectionSource

Occurs when creating a Collection Source for a List View.

CreateCustomDeviceSpecificModelDifferenceStore

Occurs when a storage for device-specific model differences is being created.

CreateCustomLogonParameterStore

Occurs both when reading and writing the last logon parameters, before creating the logon parameters storage.

CreateCustomLogonWindowControllers

Occurs when creating Controllers for a Logon Window.

CreateCustomLogonWindowObjectSpace

Occurs when creating an Object Space for a Logon Window's Detail View.

CreateCustomModelCacheManager

Occurs when the object used to manage saving and loading the Application Model cache is created.

CreateCustomModelCacheStream

This event is intended for internal use. Handle the XafApplication.CreateCustomModelCacheManager event instead.

CreateCustomModelDifferenceStore

Occurs when a storage for model differences is being created.

CreateCustomObjectSpaceProvider

Occurs when setting up the application.

CreateCustomPropertyCollectionSource

Occurs when creating a Collection Source for a nested List View that displays a collection property.

CreateCustomTemplate

Occurs when creating a Template.

CreateCustomUserModelDifferenceStore

Occurs when a storage for end-user model differences is being created.

CustomCheckCompatibility

Occurs when trying to access the application's database (when logging on or creating an Object Space).

CustomProcessShortcut

Occurs when a View is created by its shortcut.

CustomizeFormattingCulture

Occurs after a formatting culture has been set internally.

CustomizeLanguage

Occurs after a language has been set for the application internally.

CustomizeLanguagesList

Occurs when setting up the application.

CustomizeTableName

For internal use.

CustomizeTemplate

Occurs after a Template has been created.

DashboardViewCreated

Occurs after a Dashboard View has been created.

DashboardViewCreating

Occurs when creating a Dashboard View.

DatabaseUpdaterCreating

Occurs when creating a database updater.

DatabaseVersionMismatch

Occurs when the application being run calls the database.

DetailViewCreated

Occurs after a Detail View has been created.

DetailViewCreating

Occurs when creating a Detail View.

Disposed Occurs when the component is disposed by a call to the method.
(Inherited from Component)
HandleShortcutProcessingException

For internal use only.

LastLogonParametersRead

Occurs after loading the last logon parameters from the settings storage to the logon object.

LastLogonParametersReading

Occurs before loading the last logon parameters from the settings storage to the logon object.

LastLogonParametersWriting

Occurs before saving the logon Window's logon parameters to the settings storage.

ListViewCreated

Occurs after a List View has been created.

ListViewCreating

Occurs when creating a List View.

LoggedOff

Occurs after an end-user has logged off.

LoggedOn

Occurs after an end-user has logged on.

LoggingOff

Occurs when a user clicks the Log Off button or the ASP.NET session ends.

LoggingOn

Occurs when the Logon button on the logon Window is clicked.

LogonFailed

Occurs when the logon fails.

ModelChanged

Occurs when the Application Model instance returned by the XafApplication.Model property is changed.

ObjectSpaceCreated

Occurs after an Object Space has been created via the XafApplication.CreateObjectSpace method.

PropertyChanged

Occurs when the XafApplication.ApplicationName, XafApplication.Security or XafApplication.Connection property is changed.

SettingUp

Occurs before initializing the XafApplication class instance.

SetupComplete

Occurs after the XafApplication class instace has been initialized.

ShowViewStrategyChanged

Occurs when the XafApplication.ShowViewStrategy object is changed.

StatusUpdating

Occurs when the XafApplication status is updated.

UserDifferencesLoaded

Occurs after the user-defined Application Model differences are loaded.

ViewCreated

Occurs after a View has been created.

ViewCreating

Occurs when creating a View.

ViewShowing

Occurs before showing a View.

ViewShown

Occurs after a View is shown.

See Also