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 matching any of - no generic parameters - a bool return type - no parameters or a set of parameters corresponding to the action method

The execution context Method names to look for. A MethodInfo, if found; null otherwise

Returns the list of possible names of guard methods / properties for the given method.

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.

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.

Gets the parent of the given object in the Visual Tree.

The parent of the given object in the Visual Tree

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.

An which converts to .

Converts a boolean value to a value.

The value produced by the binding source. The type of the binding target property. The converter parameter to use. The culture to use in the converter. A converted value. If the method returns null, the valid null value is used.

Converts a value value to a boolean value.

The value that is produced by the binding target. The type to convert to. The converter parameter to use. The culture to use in the converter. A converted value. If the method returns null, the valid null value is used.

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.

Represents a resolver that takes a control and returns it's children

Creates the ChildResolver using the given anonymous methods.

The filter The resolver

Can this resolve appy to the given type.

The visual tree type. Returns true if this resolver applies.

The element from the visual tree for the children to resolve.

Generic strongly typed child resolver

The type to filter on

Creates a

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.

Accounts for the lack of UpdateSourceTrigger in silverlight.

The element to wire for change events on. The property that is being bound. Gets the the binding expression that needs to be updated. The property being bound to if available. The binding if available.

Class that abstracts the differences in creating a DepedencyProperty / BindableProperty on the different platforms.

The property name The property type The owner type The default value Callback to executed on property changed The registred attached dependecy property

The property name The property type The owner type The default value Callback to executed on property changed The registred dependecy property

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.

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. Parameter names are case insensitive so the specified names are unique and can be used with different case variations

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.

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.

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.

A mouse helper utility.

The current position of the mouse.

Initializes the mouse helper with the UIElement to use in mouse tracking.

The UIElement to use for mouse tracking.

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.

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

The action message.

Stores data in the application settings.

Initializes a new instance of the class.

The container.

Indicates what storage modes this mechanism provides.

The storage mode to check. Whether or not it is supported.

Begins the storage transaction.

Stores the value with the specified key.

The key. The data.

Ends the storage transaction.

Tries to get the data previously stored with the specified key.

The key. The value. true if found; false otherwise

Deletes the data with the specified key.

The key.

Clears the data stored in the last storage transaction.

Registers service with the storage mechanism as a singleton.

The service. The key. The implementation.

Defines an interface through which the storage system can communicate with an IoC container.

Occurs when a new instance is created.

Registers the service as a singleton stored in the phone state.

The service. The phone state key. The implementation.

Registers the service as a singleton stored in the app settings.

The service. The app settings key. The implementation.

Handles the storage of an object instance.

Gets or sets the coordinator.

The coordinator.

Overrided by inheritors to configure the handler for use.

Indicates whether the specified instance can be stored by this handler.

The instance.

Saves the specified instance.

The instance. The mode.

Restores the specified instance.

The instance. The mode.

Implemented by classes that know how to store data.

Indicates what storage modes this mechanism provides.

The storage mode to check. Whether or not it is supported.

Begins the storage transaction.

Stores the value with the specified key.

The key. The data.

Ends the storage transaction.

Tries to get the data previously stored with the specified key.

The key. The value. true if found; false otherwise

Deletes the data with the specified key.

The key.

Clears the data stored in the last storage transaction.

Registers service with the storage mechanism as a singleton.

The service. The key. The implementation.

Extension methods related to navigation.

Creates a Uri builder based on a view model type.

The type of the view model. The navigation service. The builder.

Creates a Uri builder based on a view model type.

The type of the view model. The navigation service. The builder.

Builds a Uri in a strongly typed fashion, based on a ViewModel.

Adds a query string parameter to the Uri.

The type of the value. The property. The property value. Itself

Attaches a navigation servies to this builder.

The navigation service. Itself

Navigates to the Uri represented by this builder.

Builds the URI.

A uri constructed with the current configuration information.

A custom IoC container which integrates with the phone and properly registers all Caliburn.Micro services.

Registers the service as a singleton stored in the phone state.

The service. The phone state key. The implementation.

Registers the service as a singleton stored in the app settings.

The service. The app settings key. The implementation.

Registers the Caliburn.Micro services with the container.

The root frame of the application. if set to true [treat view as loaded].

Enable the .

Stores data in the phone state.

Initializes a new instance of the class.

The container. The phone service.

Indicates what storage modes this mechanism provides.

The storage mode to check. Whether or not it is supported.

Begins the storage transaction.

Stores the value with the specified key.

The key. The data.

Ends the storage transaction.

Tries to get the data previously stored with the specified key.

The key. The value. true if found; false otherwise

Deletes the data with the specified key.

The key.

Clears the data stored in the last storage transaction.

Registers service with the storage mechanism as a singleton.

The service. The key. The implementation.

Service allowing to play a .wav sound effect

Plays a sound effect

The uri of the resource containing the .wav file

Default implementation, using Xna Framework. The sound effect is played without interrupting the music playback on the phone (which is required for the app certification in the WP7 Marketplace. Also note that using the Xna Framework in a WP7 Silverlight app is explicitly allowed for this very purpose.

Plays a sound effect

The uri of the resource containing the .wav file

Coordinates the saving and loading of objects based on application lifecycle events.

Initializes a new instance of the class.

The container. The phone service. The storage mechanisms. The handlers.

Starts monitoring application and container events.

Stops monitoring application and container events.

Gets the storage mechanism.

The type of storage mechanism to get. The storage mechanism.

Adds the storage mechanism.

The storage mechanism.

Adds the storage handler.

The handler. Itself

Gets the storage handler for a paricular instance.

The instance. The storage handler.

Saves all monitored instances according to the provided mode.

The save mode.

Restores the specified instance.

The instance. The restore mode.

Handles the storage of a pariticular class.

The type that this class handles.

Provides a mechanism for obtaining an instance's unique id.

The getter.

Gets or sets the coordinator.

The coordinator.

Overrided by inheritors to configure the handler for use.

Instructs the handler to store the entire object graph, rather than individual properties.

The type of the service. The optional storage key. The builder.

Instructs the handler to store a property.

The property. The builder.

Instructs the handler to store a child object's properties.

The property. The builder. This assumes that the parent instance provides the child instance, but that the child instance's properties are handled by a unique handler.

Adds a new storage instruction.

The builder.

Uses this handler to save a particular instance using instructions that support the provided mode.

The instance. The storage mode.

Uses this handler to restore a particular instance using instructions that support the provided mode.

The instance. The mode.

An instruction for saving/loading data.

The model type.

Gets or sets the owner.

The owner.

Gets or sets the storage mechanism.

The storage mechanism.

Gets or sets the persistence key.

The key.

Gets or sets the save action.

The save action.

Gets or sets the restore action.

The restore action.

Used to create a fluent interface for building up a storage instruction.

Initializes a new instance of the class.

The storage instruction.

Configures the instruction with the specified behavior.

The configuration callback. Itself

Extension methods for configuring storage instructions.

Stores the data in the transient phone State.

The model type. The builder. The builder.

Stores the data in the permanent ApplicationSettings.

The model type. The builder. The builder.

Restores the data when IActivate.Activated is raised.

The model type. The builder. The builder.

Restores the data after view's Loaded event is raised.

The model type. The builder. The builder.

Restores the data after view's LayoutUpdated event is raised.

The model type. The builder. The builder.

Stores the index of the Conductor's ActiveItem.

The model type. The handler. The builder.

The mode used to save/restore data.

Automatic Determine the Mode

Use Temporary storage.

Use Permenent storage.

Use any storage mechanism available.

A message which is published when a task completes.

The type of the task event args.

Optional state provided by the original sender.

The results of the task.

Handles messages and ensures that the property handler receives the completion message.

Initializes a new instance of the class.

The phone service. The event aggregator.

Starts monitoring for task requests and controlling completion messages.

Stops monitoring for task requests and controlling completion messages.

Called when the task is compled.

The sender. The instance containing the event data.

A message that is published to signify a components request for the execution of a particular task.

Optional state to be passed along to the task completion message.

The task instance.

Extension methods related to phone tasks.

Creates a task and publishes it using the .

The task to create. The event aggregator. Optional configuration for the task. Optional state to be passed along to the task completion message.

Allows applications to start and stop vibration on the device.

Starts vibration on the device.

A TimeSpan object specifying the amount of time for which the phone vibrates.

Stops vibration on the device.

The default implementation of , using the system controller.

Starts vibration on the device.

A TimeSpan object specifying the amount of time for which the phone vibrates.

Stops vibration on the device.

WindowManager extensions

Shows a modal dialog for the specified model, using vibrate and audio feedback

The WindowManager instance. The root model. The context. If not null, use the specified .wav as opening sound If true, use a vibration feedback on dialog opening

A implementation for the XAML platfrom.

Initializes a new instance of the class.

Indicates whether or not the framework is in design-time mode.

Executes the action on the UI thread asynchronously.

The action to execute.

Executes the action on the UI thread asynchronously.

The action to execute.

Executes the action on the UI thread.

The action to execute.

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.

Executes the handler the fist time the view is loaded.

The view. The handler.

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

The view. The handler.

Get the close action for the specified view model.

The view model to close. The associated views. The dialog result. An to close the view model.

Provides information about the characteristics for a component, such as its attributes, properties, and events. This class cannot be inherited.

Returns a type converter for the specified type.

The System.Type of the target component. A System.ComponentModel.TypeConverter for the specified type.

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.

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