Click or drag to resize

ScannerGetBrightness Method

This property is used to get or set the scan brightness value.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public int GetBrightness(
	[OptionalAttribute] bool Percent
)

Parameters

Percent (Optional)
Type: SystemBoolean

Return Value

Type: Int32
Remarks

The higher the value, the brighter the resulting image will be.

The Percent parameter is an optional Boolean parameter. If Percent is not specified or is False, the brightness value should be considered as brightness steps. In this case, the minimum value is 0 and the maximum value is BrightnessMax-1. The default value of this property equals the BrightnessDefault value.

If The Percent parameter is True, the brightness value should be considered as a percent value. In this case, the minimum value is 0, the maximum value is 100.

If the Brightness is set to the AUTOBRIGHTNESS constant, the automatic brightness control is switched on. This constant can only be switched on only if the scanner supports auto-brightness control, i.e. the value of the AvailableAutoBrightness property is True.

See Also