ImageFilter Property (Device)

In This Topic

Gets or sets the image filter for current scan session.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Property ImageFilter As ImageFilter

public ImageFilter ImageFilter { get; set; }

public: __property ImageFilter get_ImageFilter();
public: __property void set_ImageFilter(
   ImageFilter value
);

public:
property ImageFilter ImageFilter {
   ImageFilter get();
   void set(ImageFilter value);
}

Exceptions

Exception	Description
TwainInvalidStateException	Thrown if device is in wrong state.
TwainDeviceCapabilityException	Thrown if device does not support capability.
DebuggerException	Thrown if the .NET debugger is used and the function evaluation requires all threads to run.

Remarks

Call this property only when device is opened (State == DeviceState.Opened).

Supported pixel types can be received by the GetSupportedImageFilters method.

Example

This C#/VB.NET code shows how to apply Green filter to images acquired from the device.

VB.NET


Public Sub ScanColorImageWithImageFilter(device As Vintasoft.Twain.Device)
        device.ShowUI = False
        device.DisableAfterAcquire = True

        device.Open()
        device.PixelType = Vintasoft.Twain.PixelType.RGB
        device.UnitOfMeasure = Vintasoft.Twain.UnitOfMeasure.Inches
        device.Resolution = New Vintasoft.Twain.Resolution(300F, 300F)
        device.ImageFilter = Vintasoft.Twain.ImageFilter.Green

        device.Acquire()
End Sub


public void ScanColorImageWithImageFilter(Vintasoft.Twain.Device device)
{
    device.ShowUI = false;
    device.DisableAfterAcquire = true;

    device.Open();
    device.PixelType = Vintasoft.Twain.PixelType.RGB;
    device.UnitOfMeasure = Vintasoft.Twain.UnitOfMeasure.Inches;
    device.Resolution = new Vintasoft.Twain.Resolution(300f, 300f);
    device.ImageFilter = Vintasoft.Twain.ImageFilter.Green;

    device.Acquire();
}

Requirements

Target Platforms: .NET 8, .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

Device Class
Device Members

GetSupportedImageFilters
Open

Send Feedback