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





Draws a specified shape and feathers it to the image.

Syntax

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

VignnetCommandBitmapEffect ...

Example

Run the VignnetCommandBitmapEffect on an image.

Visual BasicCopy Code
Public Sub VignnetCommandBitmapEffectExample(ByVal element As FrameworkElement)
   Dim effect As VignnetCommandBitmapEffect = New VignnetCommandBitmapEffect()
   effect.Origin = New System.Windows.Point((CInt(element.ActualWidth) / 2), (CInt(element.ActualHeight) / 2))
   effect.Fading = 100
   effect.FadingRate = 100
   effect.Width = CInt(element.ActualWidth / 2)
   effect.Height = CInt(element.ActualHeight / 2)
   effect.VignetteColor = System.Windows.Media.Color.FromRgb(0, 0, 0)
   effect.Flags = VignnetCommandBitmapEffectsFlags.Ellipse Or VignnetCommandBitmapEffectsFlags.FillOut
   element.BitmapEffect = effect

   Dim storyboard As Storyboard = New Storyboard()

   Dim animation1 As Int32Animation = New Int32Animation()
   animation1.From = 1
   animation1.To = 100
   animation1.Duration = New Duration(TimeSpan.Parse("0:0:5"))
   animation1.RepeatBehavior = RepeatBehavior.Forever
   animation1.AutoReverse = True

   storyboard.SetTargetName(animation1, "AnimatedBitmapEffect")
   storyboard.SetTargetProperty(animation1, New PropertyPath(VignnetCommandBitmapEffect.WidthProperty))
   element.RegisterName("AnimatedBitmapEffect", effect)
   storyboard.Children.Add(animation1)

   storyboard.Begin(element)
End Sub
C#Copy Code
public void VignnetCommandBitmapEffectExample(FrameworkElement element) 

   VignnetCommandBitmapEffect effect = new VignnetCommandBitmapEffect(); 
   effect.Origin = new System.Windows.Point(((int)element.ActualWidth / 2), ((int)element.ActualHeight / 2)); 
   effect.Fading = 100; 
   effect.FadingRate = 100; 
   effect.Width = (int)element.ActualWidth / 2; 
   effect.Height = (int)element.ActualHeight / 2; 
   effect.VignetteColor = System.Windows.Media.Color.FromRgb(0, 0, 0); 
   effect.Flags = VignnetCommandBitmapEffectsFlags.Ellipse | VignnetCommandBitmapEffectsFlags.FillOut; 
   element.BitmapEffect = effect; 
 
   Storyboard storyboard = new Storyboard(); 
 
   Int32Animation animation1 = new Int32Animation(); 
   animation1.From = 1; 
   animation1.To = 100; 
   animation1.Duration = new Duration(TimeSpan.Parse("0:0:5")); 
   animation1.RepeatBehavior = RepeatBehavior.Forever; 
   animation1.AutoReverse = true; 
 
   Storyboard.SetTargetName(animation1, "AnimatedBitmapEffect"); 
   Storyboard.SetTargetProperty(animation1, new PropertyPath(VignnetCommandBitmapEffect.WidthProperty)); 
   element.RegisterName("AnimatedBitmapEffect", effect); 
   storyboard.Children.Add(animation1); 
 
   storyboard.Begin(element); 
}
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.SpecialEffects;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:VignnetCommandBitmapEffect x:Name="AnimatedBitmapEffect" VignetteColor="Black" Fading="50" FadingRate="100" Flags="Circle" Origin="140, 105" Width="10" /> 
      </Image.BitmapEffect> 
      <Image.Triggers> 
        <EventTrigger RoutedEvent="Image.Loaded"> 
          <BeginStoryboard> 
            <Storyboard> 
              <Int32Animation Storyboard.TargetName="AnimatedBitmapEffect" Storyboard.TargetProperty="Width" From="1" To="100" Duration="0:0:5" RepeatBehavior="Forever" AutoReverse="true" /> 
            </Storyboard> 
          </BeginStoryboard> 
        </EventTrigger> 
      </Image.Triggers> 
    </Image> 
  </Grid> 
</Page>

Remarks

  • This method can be used to draw a circle, ellipse, rectangle or square to create a vignette shape and then a color is feathered to the image, filling either the inside or the outside of the vignette shape.
  • 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.SpecialEffects.VignnetCommandBitmapEffect

Requirements

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

See Also