Click or drag to resize

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 (in TomsToolbox.Wpf.dll) Version: 1.0.64.0 (1.0.64.0)
Syntax
public abstract class VisualCompositionBehavior<T> : FrameworkElementBehavior<T>, 
	IVisualCompositionBehavior
where T : FrameworkElement

Type Parameters

T
The type the VisualCompositionBehavior can be attached to.

The VisualCompositionBehaviorT type exposes the following members.

Constructors
  NameDescription
Protected methodVisualCompositionBehaviorT
Initializes a new instance of the VisualCompositionBehaviorT class.
Top
Properties
  NameDescription
Public propertyCompositionContext
Gets or sets the composition context.
Public propertyCompositionContextBinding
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.
Protected propertyExportProvider
Gets or sets the export provider (IOC). The export provider must be registered with the ExportProviderLocator.
Protected propertyIsLoaded
Gets a value indicating whether the associated object is loaded.
(Inherited from FrameworkElementBehaviorT.)
Public propertyRegionId
Gets or sets the id of the region. The region id is used to select candidates for composition.
Public propertyRegionIdBinding
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
  NameDescription
Protected methodGetExports
Gets the visual composition exports for the specified region.
Protected methodGetTarget
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.
Protected methodOnAssociatedObjectLoaded
Called when the associated object is loaded.
(Inherited from FrameworkElementBehaviorT.)
Protected methodOnAssociatedObjectUnloaded
Called when the associated object is unloaded.
(Inherited from FrameworkElementBehaviorT.)
Protected methodOnAttached
Called after the behavior is attached to an AssociatedObject.
(Overrides FrameworkElementBehaviorTOnAttached.)
Protected methodOnDetaching
Called when the behavior is being detached from its AssociatedObject, but before it has actually occurred.
(Overrides FrameworkElementBehaviorTOnDetaching.)
Protected methodOnUpdate
Called when any of the constraints have changed and the target needs to be updated.
Protected methodUpdate
Called when any of the constraints have changed and the target needs to be updated.
Top
Fields
  NameDescription
Public fieldStatic memberCompositionContextProperty
Identifies the CompositionContext dependency property
Public fieldStatic memberRegionIdProperty
Identifies the RegionId dependency property
Top
Extension Methods
  NameDescription
Public Extension MethodAncestors
Returns an enumeration of the ancestor elements in the logical tree of this element.
(Defined by DependencyObjectExtensions.)
Public Extension MethodAncestorsAndSelf
Returns an enumeration of elements that contain this element, and the ancestors in the logical tree of this element.
(Defined by DependencyObjectExtensions.)
Public Extension MethodGetExportProvider
Gets the active export provider for the specified object.
(Defined by ExportProviderLocator.)
Public Extension MethodGetRootVisual
Gets the root visual for the item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodGetValueT (Defined by DependencyObjectExtensions.)
Public Extension MethodGetWindowHandle
Gets the window handle of the HwndSource hosting this item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodSafeCastT
Performs a cast from object to T, avoiding possible null violations if T is a value type.
(Defined by ObjectExtensions.)
Public Extension MethodSetExportProvider
Sets the export provider.
(Defined by ExportProviderLocator.)
Public Extension MethodTryFindAncestorTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions.)
Public Extension MethodTryGetExportProvider
Gets the active export provider for the specified object, or null if no export provider is registered.
(Defined by ExportProviderLocator.)
Public Extension MethodTryGetRootVisual
Gets the root visual for the item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestors
Returns an enumeration of the ancestor elements in the visual tree of this element.
(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestorsAndSelf
Returns an enumeration of elements that contains this element, and the ancestors in the visual tree of this element.
(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildren
Enumerates the immediate children of the specified item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildrenAndSelf
Enumerates the specified item and it's immediate children.
(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendants
Enumerates all visuals descendants of the specified item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendantsAndSelf
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.
Contracts
Invariants
_deferredUpdateThrottle != null
Learn more about contracts
See Also