OuterGlowBitmapEffect Class

Reference

Definition

Namespace:: System.Windows.Media.Effects

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Creates a halo of color around objects or areas of color.

public ref class OuterGlowBitmapEffect sealed : System::Windows::Media::Effects::BitmapEffect

public sealed class OuterGlowBitmapEffect : System.Windows.Media.Effects.BitmapEffect

type OuterGlowBitmapEffect = class
    inherit BitmapEffect

Public NotInheritable Class OuterGlowBitmapEffect
Inherits BitmapEffect

Inheritance: Object

DispatcherObject

DependencyObject

Freezable

Animatable

BitmapEffect
OuterGlowBitmapEffect

Remarks

Note

WPF bitmap effects are software rendered. Any object that applies an effect will also be rendered in software. Bitmap effects should not be applied to large visuals or animations because this can degrade performance.

OuterGlowBitmapEffect is one of several effects that are shipped with the Windows SDK. Other effects include:

The following illustration shows an OuterGlowBitmapEffect applied to a visual object (in this case applied to a TextBox).

Screenshot: OuterGlowBitmapEffect bitmap effect

The following illustrations show the effect of several basic properties of OuterGlowBitmapEffect.

The GlowSize property specifies the size of the halo glow:

Screenshot: OuterGlowBitmapEffect bitmap effect

The Noise property specifies the level of noise in the glow:

Screenshot: Compare Noise property values

The Opacity property specifies how transparent the glow is:

Screenshot: Compare glow opacity property values

Constructors

OuterGlowBitmapEffect()

Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Initializes a new instance of the OuterGlowBitmapEffect class.

Fields

GlowColorProperty	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Identifies the GlowColor dependency property.
GlowSizeProperty	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Identifies the GlowSize dependency property.
NoiseProperty	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Identifies the Noise dependency property.
OpacityProperty	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Identifies the Opacity dependency property.

Properties

CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable)
DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
GlowColor	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Gets or sets the color of the halo glow.
GlowSize	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Gets or sets the thickness of the halo glow.
HasAnimatedProperties	Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable)
IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable)
IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject)
Noise	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Gets or sets the graininess of the halo glow.
Opacity	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Gets or sets the degree of opacity of the halo glow.

Methods

ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable)
CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject)
Clone()	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Creates a modifiable clone of this OuterGlowBitmapEffect, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
CloneCore(Freezable)	Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable)
CloneCurrentValue()	Note: This API is now obsolete. The non-obsolete alternative is BlurEffect. Creates a modifiable clone of this OuterGlowBitmapEffect object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
CloneCurrentValueCore(Freezable)	Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable)
CoerceValue(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)
CreateInstance()	Initializes a new instance of the Freezable class. (Inherited from Freezable)
CreateInstanceCore()	When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable)
CreateUnmanagedEffect()	Obsolete. When overridden in a derived class, creates a clone of the unmanaged effect. (Inherited from BitmapEffect)
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to `true`. (Inherited from Freezable)
FreezeCore(Boolean)	Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable. (Inherited from Animatable)
GetAnimationBaseValue(DependencyProperty)	Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable)
GetAsFrozen()	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable)
GetAsFrozenCore(Freezable)	Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable)
GetCurrentValueAsFrozen()	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable)
GetCurrentValueAsFrozenCore(Freezable)	Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable)
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject)
GetOutput(BitmapEffectInput)	Obsolete. Returns the BitmapSource that results when the effect is applied to the specified BitmapEffectInput. (Inherited from BitmapEffect)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject)
InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnChanged()	Called when the current Freezable object is modified. (Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject)
ReadPreamble()	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable)
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
UpdateUnmanagedPropertyState(SafeHandle)	Obsolete. When overridden in a derived class, updates the property states of the unmanaged properties of the effect. (Inherited from BitmapEffect)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
WritePostscript()	Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable)
WritePreamble()	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable)

Events

Changed

Occurs when the Freezable or an object it contains is modified.

(Inherited from Freezable)

Applies to

Del via