Caliburn.Micro.Platform

A host for action related attached properties.

A property definition representing the target of an . The DataContext of the element will be set to this instance.

A property definition representing the target of an . The DataContext of the element is not set to this instance.

Sets the target of the .

The element to attach the target to. The target for instances of .

Gets the target for instances of .

The element to which the target is attached. The target for instances of

Sets the target of the .

The element to attach the target to. The target for instances of . The DataContext will not be set.

Gets the target for instances of .

The element to which the target is attached. The target for instances of

Checks if the -Target was set.

DependencyObject to check True if Target or TargetWithoutContext was set on

Uses the action pipeline to invoke the method.

The object instance to invoke the method on. The name of the method to invoke. The view. The source of the invocation. The event args. The method parameters.

The context used during the execution of an Action or its guard.

Determines whether the action can execute.

Returns true if the action can execute, false otherwise.

Any event arguments associated with the action's invocation.

The actual method info to be invoked.

The message being executed.

The source from which the message originates.

The instance on which the action is invoked.

The view associated with the target.

Gets or sets additional data needed to invoke the action.

The data key. Custom data associated with the context.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Called when the execution context is disposed

Used to send a message from the UI to a presentation model class, indicating that a particular Action should be invoked.

Causes the action invocation to "double check" if the action should be invoked by executing the guard immediately before hand.

This is disabled by default. If multiple actions are attached to the same element, you may want to enable this so that each individaul action checks its guard regardless of how the UI state appears.

Causes the action to throw if it cannot locate the target or the method at invocation time.

True by default.

Represents the method name of an action message.

Represents the parameters of an action message.

Creates an instance of .

Gets or sets the name of the method to be invoked on the presentation model class.

The name of the method.

Gets the parameters to pass as part of the method invocation.

The parameters.

Occurs before the message detaches from the associated object.

Called after the action is attached to an AssociatedObject.

Called when the action is being detached from its AssociatedObject, but before it has actually occurred.

Invokes the action.

The parameter to the action. If the action does not require a parameter, the parameter may be set to a null reference.

Forces an update of the UI's Enabled/Disabled state based on the the preconditions associated with the method.

Returns a that represents the current .

A that represents the current .

Invokes the action using the specified

Applies an availability effect, such as IsEnabled, to an element.

Returns a value indicating whether or not the action is available.

Finds the method on the target matching the specified message.

The target. The message. The matching method, if available.

Sets the target, method and view on the context. Uses a bubbling strategy by default.

Prepares the action execution context for use.

Try to find a candidate for guard function, having: - a name in the form "CanXXX" - no generic parameters - a bool return type - no parameters or a set of parameters corresponding to the action method

The execution context A MethodInfo, if found; null otherwise

A source of assemblies that are inspectable by the framework.

The singleton instance of the AssemblySource used by the framework.

Finds a type which matches one of the elements in the sequence of names.

A caching subsystem for .

Extracts the types from the spezified assembly for storing in the cache.

Installs the caching subsystem.

Hosts dependency properties for binding.

Allows binding on an existing view. Use this on root UserControls, Pages and Windows; not in a DataTemplate.

Allows binding on an existing view without setting the data context. Use this from within a DataTemplate.

Gets the model to bind to.

The dependency object to bind to. The model.

Sets the model to bind to.

The dependency object to bind to. The model.

Gets the model to bind to.

The dependency object to bind to. The model.

Sets the model to bind to.

The dependency object to bind to. The model.

Allows application of conventions at design-time.

Gets whether or not conventions are being applied at design-time.

The ui to apply conventions to. Whether or not conventions are applied.

Sets whether or not do bind conventions at design-time.

The ui to apply conventions to. Whether or not to apply conventions.

Provides methods for searching a given scope for named elements.

Searches through the list of named elements looking for a case-insensitive match.

The named elements to search through. The name to search for. The named element or null if not found.

Adds a child resolver.

The type filter. The resolver.

Removes a child resolver.

The resolver to remove. true, when the resolver was (found and) removed.

Gets all the instances with names in the scope.

Named instances in the provided scope. Pass in a and receive a list of named instances in the same scope.

Finds a set of named instances in each hop in a .

Searches all the elements in the parameter as well as the visual children of each of these elements, the , the HeaderedContentControl.Header, the , or the HeaderedItemsControl.Header, if any are found.

Finds a path of dependency objects which traces through visual anscestry until a root which is , a , a Page with a dependency object Page.ContentProperty value, a dependency object with set to . and are included in the resulting in order to track which item in an items control we are scoped to.

Maintains a connection in the visual tree of dependency objects in order to record a route through it.

Gets or sets the starting point of the route.

Adds a segment to the route.

The source dependency object. The target dependency object.

Tries to get a target dependency object given a source.

The possible beginning of a route segment (hop). The target of a route segment (hop). if had a target recorded; otherwise.

Inherit from this class in order to customize the configuration of the framework.

The application.

Creates an instance of the bootstrapper.

Set this to false when hosting Caliburn.Micro inside and Office or WinForms application. The default is true.

Initialize the framework.

Called by the bootstrapper's constructor at design time to start the framework.

Called by the bootstrapper's constructor at runtime to start the framework.

Provides an opportunity to hook into the application object.

Override to configure the framework and setup your IoC container.

Override to tell the framework where to find assemblies to inspect for views, etc.

A list of assemblies to inspect.

Override this to provide an IoC specific implementation.

The service to locate. The key to locate. The located service.

Override this to provide an IoC specific implementation

The service to locate. The located services.

Override this to provide an IoC specific implementation.

The instance to perform injection on.

Override this to add custom behavior to execute after the application starts.

The sender. The args.

Override this to add custom behavior on exit.

The sender. The event args.

Override this to add custom behavior for unhandled exceptions.

The sender. The event args.

Locates the view model, locates the associate view, binds them and shows it as the root view.

The view model type. The optional window settings.

Locates the view model, locates the associate view, binds them and shows it as the root view.

The view model type. The optional window settings.

Used to configure the conventions used by the framework to apply bindings and create actions.

Converters to/from .

Indicates whether or not static properties should be included during convention name matching.

False by default.

Indicates whether or not the Content of ContentControls should be overwritten by conventional bindings.

False by default.

The default DataTemplate used for ItemsControls when required.

The default DataTemplate used for Headered controls when required.

Changes the provided word from a plural form to a singular form.

Derives the SelectedItem property name.

Creates a binding and sets it on the element, applying the appropriate conventions.

Applies the appropriate binding mode to the binding.

Determines whether or not and what type of validation to enable on the binding.

Determines whether a value converter is is needed and applies one to the binding.

Determines whether a custom string format is needed and applies it to the binding.

Determines whether a custom update source trigger should be applied to the binding.

Adds an element convention.

The type of element. The default property for binding conventions. The default property for action parameters. The default event to trigger actions.

Adds an element convention.

Gets an element convention for the provided element type.

The type of element to locate the convention for. The convention if found, null otherwise. Searches the class hierarchy for conventions.

Determines whether a particular dependency property already has a binding on the provided element.

Creates a binding and sets it on the element, guarding against pre-existing bindings.

Creates a binding and set it on the element, guarding against pre-existing bindings and pre-existing values.

Attempts to apply the default item template to the items control.

The items control. The collection property.

Configures the selected item convention.

The element that has a SelectedItem property. The SelectedItem property. The view model type. The property path.

Configures the SelectedItem binding for matched selection path.

The element that has a SelectedItem property. The SelectedItem property. The view model type. The property path. The binding to configure. A bool indicating whether to apply binding

Applies a header template based on

Gets a property by name, ignoring case and searching all interfaces.

The type to inspect. The property to search for. The property or null if not found.

Represents the conventions for a particular element type.

The type of element to which the conventions apply.

Gets the default property to be used in binding conventions.

The default trigger to be used when wiring actions on this element.

The default property to be used for parameters of this type in actions.

Applies custom conventions for elements of this type.

Pass the view model type, property path, property instance, framework element and its convention.

Generic extension methods used by the framework.

Get's the name of the assembly.

The assembly. The assembly's name.

Gets all the attributes of a particular type.

The type of attributes to get. The member to inspect for attributes. Whether or not to search for inherited attributes. The list of attributes found.

Gets the value for a key. If the key does not exist, return default(TValue);

The type of the keys in the dictionary. The type of the values in the dictionary. The dictionary to call this method on. The key to look up. The key value. default(TValue) if this key is not in the dictionary.

Indicates that a message is parameterized.

Represents the parameters of a message.

Host's attached properties related to routed UI messaging.

Places a message handler on this element.

The element. The message handler.

Gets the message handler for this element.

The element. The message handler.

A property definition representing attached triggers and messages.

Sets the attached triggers and messages.

The element to attach to. The parsable attachment text.

Gets the attached triggers and messages.

The element that was attached to. The parsable attachment text.

A service that is capable of properly binding values to a method's parameters and creating instances of .

The special parameter values recognized by the message binder along with their resolvers.

Custom converters used by the framework registered by destination type for which they will be selected. The converter is passed the existing value to convert and a "context" object.

Determines the parameters that a method should be invoked with.

The action execution context. The parameters required to complete the invocation. The actual parameter values.

Transforms the textual parameter into the actual parameter.

Coerces the provided value to the destination type.

The destination type. The provided value. An optional context value which can be used during conversion. The coerced value.

Gets the default value for a type.

The type. The default value.

Class for managing the list of rules for doing name transformation.

Flag to indicate if transformations from all matched rules are returned. Otherwise, transformations from only the first matched rule are returned.

Adds a transform using a single replacement value and a global filter pattern.

Regular expression pattern for replacing text The replacement value. Regular expression pattern for global filtering

Adds a transform using a list of replacement values and a global filter pattern.

Regular expression pattern for replacing text The list of replacement values Regular expression pattern for global filtering

Gets the list of transformations for a given name.

The name to transform into the resolved name list The transformed names.

Gets the list of transformations for a given name.

The name to transform into the resolved name list A function to do a transform on each item in the ReplaceValueList prior to applying the regular expression transform The transformed names.

A rule that describes a name transform.

Regular expression pattern for global filtering

Regular expression pattern for replacing text

The list of replacement values

A collection that can exist as part of a behavior.

The type of item in the attached collection.

Creates an instance of

Attached the collection.

The dependency object to attach the collection to.

Detaches the collection.

Called when an item is added from the collection.

The item that was added.

Called when an item is removed from the collection.

The item that was removed.

Represents a parameter of an .

A dependency property representing the parameter's value.

Gets or sets the value of the parameter.

The value.

Gets or sets the owner.

When implemented in a derived class, creates a new instance of the derived class.

The new instance.

Makes the parameter aware of the that it's attached to.

The action message.

A service that manages windows.

Shows a modal dialog for the specified model.

The root model. The context. The optional dialog settings. The dialog result.

Shows a non-modal window for the specified model.

The root model. The context. The optional window settings.

Shows a popup at the current mouse position.

The root model. The view context. The optional popup settings.

A service that manages windows.

Shows a modal dialog for the specified model.

The root model. The context. The dialog popup settings. The dialog result.

Shows a window for the specified model.

The root model. The context. The optional window settings.

Shows a popup at the current mouse position.

The root model. The view context. The optional popup settings.

Creates a popup for hosting a popup window.

The model. The optional popup settings. The popup.

Creates a window.

The view model. Whethor or not the window is being shown as a dialog. The view context. The optional popup settings. The window.

Makes sure the view is a window is is wrapped by one.

The view model. The view. Whethor or not the window is being shown as a dialog. The window.

Infers the owner of the window.

The window to whose owner needs to be determined. The owner.

Creates the page.

The root model. The context. The optional popup settings. The page.

Ensures the view is a page or provides one.

The model. The view. The page.

Parses text into a fully functional set of instances with .

Parses the specified message text.

The target. The message text. The triggers parsed from the text.

The function used to generate a trigger.

The parameters passed to the method are the the target of the trigger and string representing the trigger.

Creates an instance of by parsing out the textual dsl.

The target of the message. The textual message dsl. The created message.

Function used to parse a string identified as a message.

Function used to parse a string identified as a message parameter.

Creates a binding on a .

The target to which the message is applied. The parameter object. The name of the element to bind to. The path of the element to bind to. The binding mode to use.

Helper class for encoding strings to regular expression patterns

Regular expression pattern for valid name

Regular expression pattern for subnamespace (including dot)

Regular expression pattern for namespace or namespace fragment

Creates a named capture group with the specified regular expression

Name of capture group to create Regular expression pattern to capture Regular expression capture group with the specified group name

Converts a namespace (including wildcards) to a regular expression string

Source namespace to convert to regular expression Namespace converted to a regular expression

Creates a capture group for a valid name regular expression pattern

Name of capture group to create Regular expression capture group with the specified group name

Creates a capture group for a namespace regular expression pattern

Name of capture group to create Regular expression capture group with the specified group name

Helper class when splitting strings

Splits a string with a chosen separator. If a substring is contained in [...] it will not be splitted.

The message to split The separator to use when splitting

Splits a string with , as separator. Does not split within {},[],()

The string to split

Class to specify settings for configuring type mappings by the ViewLocator or ViewModelLocator

The default subnamespace for Views. Used for creating default subnamespace mappings. Defaults to "Views".

The default subnamespace for ViewModels. Used for creating default subnamespace mappings. Defaults to "ViewModels".

Flag to indicate whether or not the name of the Type should be transformed when adding a type mapping. Defaults to true.

The format string used to compose the name of a type from base name and name suffix

Flag to indicate if ViewModel names should include View suffixes (i.e. CustomerPageViewModel vs. CustomerViewModel)

List of View suffixes for which default type mappings should be created. Applies only when UseNameSuffixesInMappings = true. Default values are "View", "Page"

The name suffix for ViewModels. Applies only when UseNameSuffixesInMappings = true. The default is "ViewModel".

Hosts attached properties related to view models.

A dependency property which allows the framework to track whether a certain element has already been loaded in certain scenarios.

A dependency property which marks an element as a name scope root.

A dependency property which allows the override of convention application behavior.

A dependency property for assigning a context to a particular portion of the UI.

A dependency property for attaching a model to the UI.

Used by the framework to indicate that this element was generated.

Executes the handler immediately if the element is loaded, otherwise wires it to the Loaded event.

The element. The handler. true if the handler was executed immediately; false otherwise

Executes the handler when the element is unloaded.

The element. The handler.

Executes the handler the next time the elements's LayoutUpdated event fires.

The element. The handler.

Used to retrieve the root, non-framework-created view.

The view to search. The root element that was not created by the framework. In certain instances the services create UI elements. For example, if you ask the window manager to show a UserControl as a dialog, it creates a window to host the UserControl in. The WindowManager marks that element as a framework-created element so that it can determine what it created vs. what was intended by the developer. Calling GetFirstNonGeneratedView allows the framework to discover what the original element was.

Gets the convention application behavior.

The element the property is attached to. Whether or not to apply conventions.

Sets the convention application behavior.

The element to attach the property to. Whether or not to apply conventions.

Sets the model.

The element to attach the model to. The model.

Gets the model.

The element the model is attached to. The model.

Gets the context.

The element the context is attached to. The context.

Sets the context.

The element to attach the context to. The context.

Gets a value that indicates whether the process is running in design mode.

A strategy for determining which view to use for a given model.

Used to transform names.

Separator used when resolving View names for context instances.

Specifies how type mappings are created, including default type mappings. Calling this method will clear all existing name transformation rules and create new default type mappings according to the configuration.

An instance of TypeMappingConfiguration that provides the settings for configuration

Adds a default type mapping using the standard namespace mapping convention

Suffix for type name. Should be "View" or synonym of "View". (Optional)

This method registers a View suffix or synonym so that View Context resolution works properly. It is automatically called internally when calling AddNamespaceMapping(), AddDefaultTypeMapping(), or AddTypeMapping(). It should not need to be called explicitly unless a rule that handles synonyms is added directly through the NameTransformer.

Suffix for type name. Should be "View" or synonym of "View".

Adds a standard type mapping based on namespace RegEx replace and filter patterns

RegEx replace pattern for source namespace RegEx filter pattern for source namespace Array of RegEx replace values for target namespaces Suffix for type name. Should be "View" or synonym of "View". (Optional)

Adds a standard type mapping based on namespace RegEx replace and filter patterns

RegEx replace pattern for source namespace RegEx filter pattern for source namespace RegEx replace value for target namespace Suffix for type name. Should be "View" or synonym of "View". (Optional)

Adds a standard type mapping based on simple namespace mapping

Namespace of source type Namespaces of target type as an array Suffix for type name. Should be "View" or synonym of "View". (Optional)

Adds a standard type mapping based on simple namespace mapping

Namespace of source type Namespace of target type Suffix for type name. Should be "View" or synonym of "View". (Optional)

Adds a standard type mapping by substituting one subnamespace for another

Subnamespace of source type Subnamespaces of target type as an array Suffix for type name. Should be "View" or synonym of "View". (Optional)

Adds a standard type mapping by substituting one subnamespace for another

Subnamespace of source type Subnamespace of target type Suffix for type name. Should be "View" or synonym of "View". (Optional)

Retrieves the view from the IoC container or tries to create it if not found.

Pass the type of view as a parameter and recieve an instance of the view.

Modifies the name of the type to be used at design time.

Transforms a ViewModel type name into all of its possible View type names. Optionally accepts an instance of context object

Enumeration of transformed names Arguments: typeName = The name of the ViewModel type being resolved to its companion View. context = An instance of the context or null.

Locates the view type based on the specified model type.

The view. Pass the model type, display location (or null) and the context instance (or null) as parameters and receive a view type.

Locates the view for the specified model type.

The view. Pass the model type, display location (or null) and the context instance (or null) as parameters and receive a view instance.

Locates the view for the specified model instance.

The view. Pass the model instance, display location (or null) and the context (or null) as parameters and receive a view instance.

Transforms a view type into a pack uri.

When a view does not contain a code-behind file, we need to automatically call InitializeCompoent.

The element to initialize

Binds a view to a view model.

Gets or sets a value indicating whether to apply conventions by default.

true if conventions should be applied by default; otherwise, false.

Indicates whether or not the conventions have already been applied to the view.

Determines whether a view should have conventions applied to it.

The view to check. Whether or not conventions should be applied to the view.

Creates data bindings on the view's controls based on the provided properties.

Parameters include named Elements to search through and the type of view model to determine conventions for. Returns unmatched elements.

Attaches instances of to the view's controls based on the provided methods.

Parameters include the named elements to search through and the type of view model to determine conventions for. Returns unmatched elements.

Allows the developer to add custom handling of named elements which were not matched by any default conventions.

Binds the specified viewModel to the view.

Passes the the view model, view and creation context (or null for default) to use in applying binding.

A strategy for determining which view model to use for a given view.

Used to transform names.

The name of the capture group used as a marker for rules that return interface types