VisualCompositionBehaviorT Class

Base class to implement visual composition behaviors.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        System.Windows.Media.AnimationAnimatable
          Behavior
            BehaviorT
              TomsToolbox.Wpf.InteractivityFrameworkElementBehaviorT
                TomsToolbox.Wpf.CompositionVisualCompositionBehaviorT
                  TomsToolbox.Wpf.CompositionContentControlCompositionBehavior
                  TomsToolbox.Wpf.CompositionItemsControlCompositionBehavior

Namespace: TomsToolbox.Wpf.Composition
Assembly: TomsToolbox.Wpf.Composition (in TomsToolbox.Wpf.Composition.dll) Version: 2.21.0+44d18b541fc9419ec3c549350a832394661b2a4d
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Copy

public abstract class VisualCompositionBehavior<T> : FrameworkElementBehavior<T>, 
	IVisualCompositionBehavior
where T : FrameworkElement

Public MustInherit Class VisualCompositionBehavior(Of T As FrameworkElement)
	Inherits FrameworkElementBehavior(Of T)
	Implements IVisualCompositionBehavior

Type Parameters

T: The type the VisualCompositionBehavior can be attached to.

The VisualCompositionBehaviorT type exposes the following members.

Constructors

	Name	Description
	VisualCompositionBehaviorT	Initializes a new instance of the VisualCompositionBehaviorT class.

Top

Properties

	Name	Description
	CompositionContext	Gets or sets the composition context.
	CompositionContextBinding	Gets or sets the composition context binding. the binding will be applied to the RegionId property only after the behavior is attached to the logical tree, so you don't get misleading binding errors.
	ExportProvider	Gets or sets the export provider (DI container). The export provider must be registered with the ExportProviderLocator.
	IsLoaded	Gets a value indicating whether the associated object is loaded. (Inherited from FrameworkElementBehaviorT)
	RegionId	Gets or sets the id of the region. The region id is used to select candidates for composition.
	RegionIdBinding	Gets or sets the region identifier binding; the binding will be applied to the RegionId property only after the behavior is attached to the logical tree, so you don't get misleading binding errors.

Top

Methods

	Name	Description
	GetExports	Gets the visual composition exports for the specified region.
	GetTarget	Gets the target object for the item. If the item implements IComposablePartFactory, the element returned by the factory is returned; otherwise the item itself is returned.
	OnAssociatedObjectLoaded	Called when the associated object is loaded. (Overrides FrameworkElementBehaviorTOnAssociatedObjectLoaded)
	OnAssociatedObjectUnloaded	Called when the associated object is unloaded. (Overrides FrameworkElementBehaviorTOnAssociatedObjectUnloaded)
	OnAttached	Called after the behavior is attached to an AssociatedObject. (Overrides FrameworkElementBehaviorTOnAttached)
	OnDetaching	Called when the behavior is being detached from its AssociatedObject, but before it has actually occurred. (Inherited from FrameworkElementBehaviorT)
	OnUpdate	Called when any of the constraints have changed and the target needs to be updated.
	Update	Called when any of the constraints have changed and the target needs to be updated.

Top

Fields

	Name	Description
	CompositionContextProperty	Identifies the CompositionContext dependency property
	RegionIdProperty	Identifies the RegionId dependency property

Top

Extension Methods

	Name	Description
	Ancestors	Returns an enumeration of the ancestor elements in the logical tree of this element. (Defined by DependencyObjectExtensions)
	AncestorsAndSelf	Returns an enumeration of elements that contain this element, and the ancestors in the logical tree of this element. (Defined by DependencyObjectExtensions)
	GetExportProvider	Gets the active export provider for the specified object. (Defined by ExportProviderLocator)
	GetMissingExportProviderMessage	Gets the message to show when an export provider could not be located in the visual tree. (Defined by ExportProviderLocator)
	GetRootVisual	Gets the root visual for the item. (Defined by DependencyObjectExtensions)
	GetValueT	Gets the value of a dependency property using SafeCastT(Object). (Defined by DependencyObjectExtensions)
	GetWindowHandle	Gets the window handle of the HwndSource hosting this item. (Defined by DependencyObjectExtensions)
	SafeCastT	Performs a cast from object to T, avoiding possible null violations if T is a value type. (Defined by ObjectExtensions)
	SetExportProvider	Sets the export provider. (Defined by ExportProviderLocator)
	TryFindAncestorT	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryFindAncestorT	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryFindAncestorOrSelfT	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryFindAncestorOrSelfT	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryGetExportProvider	Gets the active export provider for the specified object, or null if no export provider is registered. (Defined by ExportProviderLocator)
	TryGetRootVisual	Gets the root visual for the item. (Defined by DependencyObjectExtensions)
	VisualAncestors	Returns an enumeration of the ancestor elements in the visual tree of this element. (Defined by DependencyObjectExtensions)
	VisualAncestorsAndSelf	Returns an enumeration of elements that contains this element, and the ancestors in the visual tree of this element. (Defined by DependencyObjectExtensions)
	VisualChildren	Enumerates the immediate children of the specified item. (Defined by DependencyObjectExtensions)
	VisualChildrenAndSelf	Enumerates the specified item and it's immediate children. (Defined by DependencyObjectExtensions)
	VisualDescendants	Enumerates all visuals descendants of the specified item. (Defined by DependencyObjectExtensions)
	VisualDescendantsAndSelf	Enumerates the specified item and all it's visual descendants. (Defined by DependencyObjectExtensions)

Top

Remarks

ViewModels declare themselves as candidates for visual composition by adding the VisualCompositionExportAttribute, and the visual composition behaviors dynamically link the view models to the views with the matching region ids.

Reference

TomsToolbox.Wpf.Composition Namespace