Leadtools.Windows.Media.Effects Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.02.15
DesaturateCommandBitmapEffect Class
See Also  Members   Example 
Leadtools.Windows.Media.Effects.Color Namespace : DesaturateCommandBitmapEffect Class





Converts the image to a grayscale level by reducing the saturation of each color to zero. The conversion will not change the color resolution.

Syntax

Visual Basic (Declaration) 
Public Class DesaturateCommandBitmapEffect 
   Inherits RasterCommandBitmapEffect
Visual Basic (Usage)Copy Code
Dim instance As DesaturateCommandBitmapEffect
C# 
public class DesaturateCommandBitmapEffect : RasterCommandBitmapEffect
Managed Extensions for C++ 
public __gc class DesaturateCommandBitmapEffect : public RasterCommandBitmapEffect
C++/CLI 
public ref class DesaturateCommandBitmapEffect : public RasterCommandBitmapEffect
XAML Property Element Usage 

DesaturateCommandBitmapEffect ...

Example

Run the DesaturateCommandBitmapEffect on an image.

Visual BasicCopy Code
Public Sub DesaturateCommandBitmapEffectExample(ByVal element As FrameworkElement)

   ' Initialize Effect
   Dim effect As DesaturateCommandBitmapEffect = New DesaturateCommandBitmapEffect()
   element.BitmapEffect = effect
End Sub
C#Copy Code
public void DesaturateCommandBitmapEffectExample(FrameworkElement element) 
{ 
 
   // Initialize Effect 
   DesaturateCommandBitmapEffect effect = new DesaturateCommandBitmapEffect(); 
   element.BitmapEffect = effect; 
}
XAMLCopy Code
<Page Title="CSAnimateEffect" Height="391" Width="300" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:lteffects="clr-namespace:Leadtools.Windows.Media.Effects.Color;assembly=Leadtools.Windows.Media.Effects"> 
  <Grid> 
    <Image Margin="10,10,10,10" HorizontalAlignment="Center" VerticalAlignment="Center" Source="C:\Program Files\LEAD Technologies, Inc\LEADTOOLS 15\Images\slave.jpg"> 
      <Image.BitmapEffect> 
        <lteffects:DesaturateCommandBitmapEffect x:Name="MyBitmapEffect" /> 
      </Image.BitmapEffect> 
    </Image> 
  </Grid> 
</Page>

Remarks

  • The image is converted to a grayscale level by reducing the saturation of each color to zero.
  • This class supports only RGB images. It does not support grayscale images.
  • This command does not support signed data images.

Inheritance Hierarchy

System.Object
   System.Windows.Threading.DispatcherObject
      System.Windows.DependencyObject
         System.Windows.Freezable
            System.Windows.Media.Animation.Animatable
               System.Windows.Media.Effects.BitmapEffect
                  Leadtools.Windows.Media.Effects.RasterCommandBitmapEffect
                     Leadtools.Windows.Media.Effects.Color.DesaturateCommandBitmapEffect

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Vista, and Windows Server 2003

See Also