ContainerVisual Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Manages a collection of Visual objects.

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Media.Visual
        System.Windows.Media.ContainerVisual
          System.Windows.Media.DrawingVisual
          System.Windows.Media.HostVisual

C#
C++
F#
VB
Copy 
Public Class ContainerVisual
	Inherits Visual

NameDescription
System_CAPS_pubmethodContainerVisual()

Creates a new instance of the ContainerVisual class.

NameDescription
System_CAPS_pubpropertyBitmapEffect

Obsolete. Gets or sets a BitmapEffect value for the ContainerVisual.

System_CAPS_pubpropertyBitmapEffectInput

Obsolete. Gets or sets a BitmapEffectInput value for the ContainerVisual.

System_CAPS_pubpropertyCacheMode

Gets or sets a cached representation of the ContainerVisual.

System_CAPS_pubpropertyChildren

Gets the child collection of the ContainerVisual.

System_CAPS_pubpropertyClip

Gets or sets the clipping region of the ContainerVisual.

System_CAPS_pubpropertyContentBounds

Gets the bounding box for the contents of the ContainerVisual.

System_CAPS_pubpropertyDependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubpropertyDescendantBounds

Gets the union of all the content bounding boxes for all of the descendants of the ContainerVisual, but not including the contents of the ContainerVisual.

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyEffect

Gets or sets the bitmap effect to apply to the ContainerVisual.

System_CAPS_pubpropertyIsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

System_CAPS_pubpropertyOffset

Gets or sets the offset value of the ContainerVisual from its reference point.

System_CAPS_pubpropertyOpacity

Gets or sets the opacity of the ContainerVisual, based on 0=transparent, 1=opaque.

System_CAPS_pubpropertyOpacityMask

Gets or sets a brush that specifies a possible opacity mask for the ContainerVisual.

System_CAPS_pubpropertyParent

Gets the parent Visual for the ContainerVisual.

System_CAPS_pubpropertyTransform

Gets or sets the transform that is applied to the ContainerVisual.

System_CAPS_protpropertyVisualBitmapEffect

Obsolete. Gets or sets the BitmapEffect value for the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualBitmapEffectInput

Obsolete. Gets or sets the BitmapEffectInput value for the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualBitmapScalingMode

Gets or sets the BitmapScalingMode for the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualCacheMode

Gets or sets a cached representation of the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualChildrenCount

Gets the number of children for the ContainerVisual.(Overrides Visual.VisualChildrenCount.)

System_CAPS_protpropertyVisualClearTypeHint

Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualClip

Gets or sets the clip region of the Visual as a Geometry value.(Inherited from Visual.)

System_CAPS_protpropertyVisualEdgeMode

Gets or sets the edge mode of the Visual as an EdgeMode value.(Inherited from Visual.)

System_CAPS_protpropertyVisualEffect

Gets or sets the bitmap effect to apply to the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualOffset

Gets or sets the offset value of the visual object.(Inherited from Visual.)

System_CAPS_protpropertyVisualOpacity

Gets or sets the opacity of the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualOpacityMask

Gets or sets the Brush value that represents the opacity mask of the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualParent

Gets the visual tree parent of the visual object.(Inherited from Visual.)

System_CAPS_protpropertyVisualScrollableAreaClip

Gets or sets a clipped scrollable area for the Visual. (Inherited from Visual.)

System_CAPS_protpropertyVisualTextHintingMode

Gets or sets the TextHintingMode of the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualTextRenderingMode

Gets or sets the TextRenderingMode of the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualTransform

Gets or sets the Transform value for the Visual.(Inherited from Visual.)

System_CAPS_protpropertyVisualXSnappingGuidelines

Gets or sets the x-coordinate (vertical) guideline collection.(Inherited from Visual.)

System_CAPS_protpropertyVisualYSnappingGuidelines

Gets or sets the y-coordinate (horizontal) guideline collection.(Inherited from Visual.)

System_CAPS_pubpropertyXSnappingGuidelines

Gets or sets the X (horizontal) guideline for the ContainerVisual.

System_CAPS_pubpropertyYSnappingGuidelines

Gets or sets the Y (vertical) guideline for the ContainerVisual.

NameDescription
System_CAPS_protmethodAddVisualChild(Visual)

Defines the parent-child relationship between two visuals.(Inherited from Visual.)

System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodClearValue(DependencyProperty)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodClearValue(DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethodCoerceValue(DependencyProperty)

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindCommonVisualAncestor(DependencyObject)

Returns the common ancestor of two visual objects.(Inherited from Visual.)

System_CAPS_pubmethodGetHashCode()

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty)

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_protmethodGetVisualChild(Int32)

Returns a specified child Visual for the parent ContainerVisual.(Overrides Visual.GetVisualChild(Int32).)

System_CAPS_pubmethodHitTest(HitTestFilterCallback, HitTestResultCallback, HitTestParameters)

Initiates a hit test on the ContainerVisual by using the HitTestFilterCallback and HitTestResultCallback objects.

System_CAPS_pubmethodHitTest(Point)

Returns the top-most visual object of a hit test by specifying a Point.

System_CAPS_protmethodHitTestCore(GeometryHitTestParameters)

Determines whether a geometry value is within the bounds of the visual object.(Inherited from Visual.)

System_CAPS_protmethodHitTestCore(PointHitTestParameters)

Determines whether a point coordinate value is within the bounds of the visual object.(Inherited from Visual.)

System_CAPS_pubmethodInvalidateProperty(DependencyProperty)

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_pubmethodIsAncestorOf(DependencyObject)

Determines whether the visual object is an ancestor of the descendant visual object.(Inherited from Visual.)

System_CAPS_pubmethodIsDescendantOf(DependencyObject)

Determines whether the visual object is a descendant of the ancestor visual object.(Inherited from Visual.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnDpiChanged(DpiScale, DpiScale)

Called when the DPI at which this View is rendered changes.(Inherited from Visual.)

System_CAPS_protmethodOnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject.)

System_CAPS_protmethodOnVisualChildrenChanged(DependencyObject, DependencyObject)

Called when the VisualCollection of the visual object is modified.(Inherited from Visual.)

System_CAPS_protmethodOnVisualParentChanged(DependencyObject)

Called when the parent of the visual object is changed.(Inherited from Visual.)

System_CAPS_pubmethodPointFromScreen(Point)

Converts a Point in screen coordinates into a Point that represents the current coordinate system of the Visual.(Inherited from Visual.)

System_CAPS_pubmethodPointToScreen(Point)

Converts a Point that represents the current coordinate system of the Visual into a Point in screen coordinates.(Inherited from Visual.)

System_CAPS_pubmethodReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_protmethodRemoveVisualChild(Visual)

Removes the parent-child relationship between two visuals.(Inherited from Visual.)

System_CAPS_pubmethodSetCurrentValue(DependencyProperty, Object)

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethodShouldSerializeProperty(DependencyProperty)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodTransformToAncestor(Visual)

Returns a transform that can be used to transform coordinates from the Visual to the specified Visual ancestor of the visual object.(Inherited from Visual.)

System_CAPS_pubmethodTransformToAncestor(Visual3D)

Returns a transform that can be used to transform coordinates from the Visual to the specified Visual3D ancestor of the visual object.(Inherited from Visual.)

System_CAPS_pubmethodTransformToDescendant(Visual)

Returns a transform that can be used to transform coordinates from the Visual to the specified visual object descendant.(Inherited from Visual.)

System_CAPS_pubmethodTransformToVisual(Visual)

Returns a transform that can be used to transform coordinates from the Visual to the specified visual object.(Inherited from Visual.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

The ContainerVisual class is used as a container for a collection of Visual objects. The DrawingVisual class derives from the ContainerVisual class, such that the DrawingVisual class can also contain a collection of visual objects.

The following example shows how to create a ContainerVisual object that is used as the parent for two DrawingVisual objects. Objects that are added to the ContainerVisual object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the GetVisualChild method and VisualChildrenCount property.

C#
VB
Copy 
' Create a host visual derived from the FrameworkElement class.
' This class provides layout, event handling, and container support for
' the child visual objects.
Public Class MyContainerVisualHost
	Inherits FrameworkElement
	Private _containerVisual As ContainerVisual

	Public Sub New(ByVal border As DrawingVisual, ByVal text As DrawingVisual)
		' Create a ContainerVisual to hold DrawingVisual children.
		_containerVisual = New ContainerVisual()

		' Add children to ContainerVisual in reverse z-order (bottom to top).
		_containerVisual.Children.Add(border)
		_containerVisual.Children.Add(text)

		' Create parent-child relationship with host visual and ContainerVisual.
		Me.AddVisualChild(_containerVisual)
	End Sub

	' Provide a required override for the VisualChildrenCount property.
	Protected Overrides ReadOnly Property VisualChildrenCount() As Integer
		Get
			Return If(_containerVisual Is Nothing, 0, 1)
		End Get
	End Property

	' Provide a required override for the GetVisualChild method.
	Protected Overrides Function GetVisualChild(ByVal index As Integer) As Visual
		If _containerVisual Is Nothing Then
			Throw New ArgumentOutOfRangeException()
		End If

		Return _containerVisual
	End Function
End Class

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: