Click here to Skip to main content
15,885,366 members
Articles / Desktop Programming / WPF

Calcium: A Modular Application Toolset Leveraging PRISM – Part 2

Rate me:
Please Sign up or sign in to vote.
5.00/5 (48 votes)
23 Nov 2009BSD12 min read 116.3K   3   90  
Calcium provides much of what one needs to rapidly build a multifaceted and sophisticated modular application. Includes a host of modules and services, and an infrastructure that is ready to use in your next application.
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.Practices.Composite.UnityExtensions</name>
    </assembly>
    <members>
        <member name="T:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper">
            <summary>
            Base class that provides a basic bootstrapping sequence that
            registers most of the Composite Application Library assets
            in a <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/>.
            </summary>
            <remarks>
            This class must be overriden to provide application specific configuration.
            </remarks>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.Run">
            <summary>
            Runs the bootstrapper process.
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.Run(System.Boolean)">
            <summary>
            Run the bootstrapper process.
            </summary>
            <param name="runWithDefaultConfiguration">If <see langword="true"/>, registers default Composite Application Library services in the container. This is the default behavior.</param>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.RegisterFrameworkExceptionTypes">
            <summary>
            Registers in the <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> the <see cref="T:System.Type"/> of the Exceptions
            that are not considered root exceptions by the <see cref="T:Microsoft.Practices.Composite.ExceptionExtensions"/>.
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.ConfigureContainer">
            <summary>
            Configures the <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/>. May be overwritten in a derived class to add specific
            type mappings required by the application.
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.ConfigureRegionAdapterMappings">
            <summary>
            Configures the default region adapter mappings to use in the application, in order
            to adapt UI controls defined in XAML to use a region and register it automatically.
            May be overwritten in a derived class to add specific mappings required by the application.
            </summary>
            <returns>The <see cref="T:Microsoft.Practices.Composite.Presentation.Regions.RegionAdapterMappings"/> instance containing all the mappings.</returns>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.ConfigureDefaultRegionBehaviors">
            <summary>
            Configures the <see cref="T:Microsoft.Practices.Composite.Presentation.Regions.IRegionBehaviorFactory"/>. This will be the list of default
            behaviors that will be added to a region. 
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.InitializeModules">
            <summary>
            Initializes the modules. May be overwritten in a derived class to use a custom Modules Catalog
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.GetModuleCatalog">
            <summary>
            Returns the module catalog that will be used to initialize the modules.
            </summary>
            <remarks>
            When using the default initialization behavior, this method must be overwritten by a derived class.
            </remarks>
            <returns>An instance of <see cref="T:Microsoft.Practices.Composite.Modularity.IModuleCatalog"/> that will be used to initialize the modules.</returns>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.CreateContainer">
            <summary>
            Creates the <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> that will be used as the default container.
            </summary>
            <returns>A new instance of <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/>.</returns>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.RegisterTypeIfMissing(System.Type,System.Type,System.Boolean)">
            <summary>
            Registers a type in the container only if that type was not already registered.
            </summary>
            <param name="fromType">The interface type to register.</param>
            <param name="toType">The type implementing the interface.</param>
            <param name="registerAsSingleton">Registers the type as a singleton.</param>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.CreateShell">
            <summary>
            Creates the shell or main window of the application.
            </summary>
            <returns>The shell of the application.</returns>
            <remarks>
            If the returned instance is a <see cref="T:System.Windows.DependencyObject"/>, the
            <see cref="T:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper"/> will attach the default <seealso cref="T:Microsoft.Practices.Composite.Regions.IRegionManager"/> of
            the application in its <see cref="F:Microsoft.Practices.Composite.Presentation.Regions.RegionManager.RegionManagerProperty"/> attached property
            in order to be able to add regions by using the <seealso cref="F:Microsoft.Practices.Composite.Presentation.Regions.RegionManager.RegionNameProperty"/>
            attached property from XAML.
            </remarks>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.Container">
            <summary>
            Gets the default <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> for the application.
            </summary>
            <value>The default <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> instance.</value>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapper.LoggerFacade">
            <summary>
            Gets the default <see cref="T:Microsoft.Practices.Composite.Logging.ILoggerFacade"/> for the application.
            </summary>
            <value>A <see cref="T:Microsoft.Practices.Composite.Logging.ILoggerFacade"/> instance.</value>
        </member>
        <member name="T:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.NotOverwrittenGetModuleEnumeratorException">
            <summary>
              Looks up a localized string similar to The method &apos;GetModuleEnumerator&apos; of the bootstrapper must be overwritten in order to use the default module initialization logic..
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.NullLoggerFacadeException">
            <summary>
              Looks up a localized string similar to The ILoggerFacade is required and cannot be null..
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.NullModuleCatalogException">
            <summary>
              Looks up a localized string similar to The IModuleCatalog is required and cannot be null in order to initialize the modules..
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.NullUnityContainerException">
            <summary>
              Looks up a localized string similar to The IUnityContainer is required and cannot be null..
            </summary>
        </member>
        <member name="P:Microsoft.Practices.Composite.UnityExtensions.Properties.Resources.TypeMappingAlreadyRegistered">
            <summary>
              Looks up a localized string similar to Type &apos;{0}&apos; was already registered by the application. Skipping....
            </summary>
        </member>
        <member name="T:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter">
            <summary>
            Defines a <seealso cref="T:Microsoft.Practices.Unity.IUnityContainer"/> adapter for
            the <see cref="T:Microsoft.Practices.ServiceLocation.IServiceLocator"/> interface
            to be used by the Composite Application Library.
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter.#ctor(Microsoft.Practices.Unity.IUnityContainer)">
            <summary>
            Initializes a new instance of <see cref="T:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter"/>.
            </summary>
            <param name="unityContainer">The <seealso cref="T:Microsoft.Practices.Unity.IUnityContainer"/> that will be used
            by the <see cref="M:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter.DoGetInstance(System.Type,System.String)"/> and <see cref="M:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter.DoGetAllInstances(System.Type)"/> methods.</param>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter.DoGetInstance(System.Type,System.String)">
            <summary>
            Resolves the instance of the requested service.
            </summary>
            <param name="serviceType">Type of instance requested.</param>
            <param name="key">Name of registered service you want. May be null.</param>
            <returns>The requested service instance.</returns>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityServiceLocatorAdapter.DoGetAllInstances(System.Type)">
            <summary>
            Resolves all the instances of the requested service.
            </summary>
            <param name="serviceType">Type of service requested.</param>
            <returns>Sequence of service instance objects.</returns>
        </member>
        <member name="T:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapperExtension">
            <summary>
            Implements a <see cref="T:Microsoft.Practices.Unity.UnityContainerExtension"/> that checks if a specific type was registered with the container.
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapperExtension.IsTypeRegistered(Microsoft.Practices.Unity.IUnityContainer,System.Type)">
            <summary>
            Evaluates if a specified type was registered in the container.
            </summary>
            <param name="container">The container to check if the type was registered in.</param>
            <param name="type">The type to check if it was registered.</param>
            <returns><see langword="true"/> if the <paramref name="type"/> was registered with the container.</returns>
            <remarks>
            In order to use this extension, you must first call <see cref="M:Microsoft.Practices.Unity.IUnityContainer.AddNewExtension``1"/> 
            and specify <see cref="T:Microsoft.Practices.Unity.UnityContainerExtension"/> as the extension type.
            </remarks>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapperExtension.Initialize">
            <summary>
            Initializes the container with this extension's functionality.
            </summary>
        </member>
        <member name="T:Microsoft.Practices.Composite.UnityExtensions.UnityContainerHelper">
            <summary>
            Extensions methods to extend and facilitate the usage of <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/>.
            </summary>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityContainerHelper.IsTypeRegistered(Microsoft.Practices.Unity.IUnityContainer,System.Type)">
            <summary>
            Returns whether a specified type has a type mapping registered in the container.
            </summary>
            <param name="container">The <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> to check for the type mapping.</param>
            <param name="type">The type to check if there is a type mapping for.</param>
            <returns><see langword="true"/> if there is a type mapping registered for <paramref name="type"/>.</returns>
            <remarks>In order to use this extension method, you first need to add the
            <see cref="T:Microsoft.Practices.Unity.IUnityContainer"/> extension to the <see cref="T:Microsoft.Practices.Composite.UnityExtensions.UnityBootstrapperExtension"/>.
            </remarks>        
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityContainerHelper.TryResolve``1(Microsoft.Practices.Unity.IUnityContainer)">
            <summary>
            Utility method to try to resolve a service from the container avoiding an exception if the container cannot build the type.
            </summary>
            <param name="container">The cointainer that will be used to resolve the type.</param>
            <typeparam name="T">The type to resolve.</typeparam>
            <returns>The instance of <typeparamref name="T"/> built up by the container.</returns>
        </member>
        <member name="M:Microsoft.Practices.Composite.UnityExtensions.UnityContainerHelper.TryResolve(Microsoft.Practices.Unity.IUnityContainer,System.Type)">
            <summary>
            Utility method to try to resolve a service from the container avoiding an exception if the container cannot build the type.
            </summary>
            <param name="container">The cointainer that will be used to resolve the type.</param>
            <param name="typeToResolve">The type to resolve.</param>
            <returns>The instance of <paramref name="typeToResolve"/> built up by the container.</returns>
        </member>
    </members>
</doc>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The BSD License


Written By
Engineer
Switzerland Switzerland
Daniel is a former senior engineer in Technology and Research at the Office of the CTO at Microsoft, working on next generation systems.

Previously Daniel was a nine-time Microsoft MVP and co-founder of Outcoder, a Swiss software and consulting company.

Daniel is the author of Windows Phone 8 Unleashed and Windows Phone 7.5 Unleashed, both published by SAMS.

Daniel is the developer behind several acclaimed mobile apps including Surfy Browser for Android and Windows Phone. Daniel is the creator of a number of popular open-source projects, most notably Codon.

Would you like Daniel to bring value to your organisation? Please contact

Blog | Twitter


Xamarin Experts
Windows 10 Experts

Comments and Discussions