The IEImage type exposes the following properties.

Properties

 Public

 Protected
 Instance

 Static
 Declared

 Inherited
 XNA Framework Only

 .NET Compact Framework Only

 MemberDescription
Aborting

Assigning True to Aborting property, applications can abort save/load processing. On loading, the image will be truncated. On saving the file will be closed and truncated (will be unreadable).

Aborting doesn't grant that the input/output stop immediately (just it is possible).

You can also read Aborting property to know when aborting is in progress.

AcquireParams
AcquireParams is a powerful interface that provides generic access to all image acquistion APIs, Twain, WIA and DCIM Retrieval.
Annotations
Returns the IEAnnotations object. It contains all vectorial objects.
AsyncMode

Set AsyncMode to True to enable asynchronous input/output operations.

When asynchronous mode is enabled, each input/output method creates a new thread that executes the task then the called method returns without waiting for the end of the task.

AsyncRunning
AsyncRunning returns how many threads are running.
AutoAdjustDPI

When AutoAdjustDPI is True (default is False) and last loaded/scannered image has horizontal DPI not equal

to vertical DPI, IEImage resizes the image making DPIX=DPIY.

AutoConvertFormat

When true (default) all image processing functions converts automatically the source pixel format to the request one.

For example, Contrast method requires RGB24 pixel format. If your image is black/white or any other format, it is converted automatically to RGB24.

If you set AutoConvertFormat=False and call Contrast with a black/white image, Contrast just will don't work.

AutoUndo
If True all image processing and load operations automatically call SaveUndo method.
BackColor

Specifies the background color.

The background color is the color showed in non used area when the current image is less of control size. This color is used also in geometric processing (as rotation) to fill blank areas.

BitAlignment

Get/set the alignment in bits of each row. Default is 32, while 8 means no alignment used.

BitAlignment is valid only when Location is Memory and LegacyBitmap is False.

BlackValue
The initial black value. Used with WhiteValue to display only a range of gray scales.
CanRedo
CanRedo is True when the Redo buffer contains an image.
ChromaKeyOptions
Options for selection of images making use of a Chroma-Key background (e.g. green screen). A ChromaKey image contains a solid color block that is removed so that it can be applied to a background. E.g. in the following image the key color is neon green (R=0/G=254/B=0).
CurrentLayer
Gets access to the current layer info.
DefaultMinFileSize

Specifies the default value for MinFileSize property.

MinFileSize specifies the minimum memory needed by the image to allow use of memory mapped file.

If the memory needed by the image is less than MinFileSize, the image will be stored in memory (also if the Location is File).

If the global static variable DefaultMinFileSize is not -1, it overlaps the property MinFileSize value.

DisplayContrast

DisplayContrast specifies a dynamic contrast to apply.

It doesn’t changes the image but only how it is displayed. Allowed values are 0 to 100.

DpiX
Specified the horizontal DPI of the viewed image. This is not synchronized with the source image Dpi.
DpiY
Specified the vertical DPI of the viewed image. This is not synchronized with the source image Dpi.
EnableCMS

IEvolution includes a Color Management System (CMS) which if enabled allows to render the image with the original colors.

To enable the CMS you have to write:

IEImage.EnableCMS = True

Enabling the CMS the loading of images with a color profile will be slow.

IEvolution includes parts of Little cms by Marti Maria.

Format
Get/Set pixel format of the bitmap
Full
Full is true all pixels are 1 (or white).
HasAlphaChannel
Returns true if current image has the alpha channel.
Height
Get/Set the bitmap height
ImageLocation
Specifies where the image is located (memory, file or Windows object)
IOParams
The IOParams object contains the input/ouput file format parameters
IPDialogParams
Allows to get/set image processing dialog parameters.
Language
Specifies the language for Input/output previews dialog and image processing previews dialog.
LayerDefaults

Specifies a list of properties that are assigned to all new layers.

The properties are a list of Name=Value pairs, with names from the TIELayer Property Consts.

Notes:

- These properties apply to layers created programmatically (e.g. using LayersAdd) and by the user.

Properties:

'IELP_Width' -> Width

'IELP_Height' -> Height

'IELP_Visible' -> Visible

'IELP_VisibleBox' -> VisibleBox

'IELP_Selectable' -> Selectable

'IELP_Transparency' -> Transparency

'IELP_Opacity' -> Opacity

'IELP_PosX' -> PosX

'IELP_PosY' -> PosY

'IELP_Cropped' -> Cropped

'IELP_Locked' -> Locked

'IELP_Operation' -> Operation

'IELP_Name' -> Name

'IELP_IsMask' -> IsMask

'IELP_DrawOuter' -> DrawOuter

'IELP_AlphaEdgeFeathering,' -> AlphaEdgeFeathering

'IELP_GroupIndex' -> GroupIndex

'IELP_Selected' -> Selected

'IELP_AspectRatioLocked' -> AspectRatioLocked

'IELP_BorderColor' -> BorderColor

'IELP_BorderWidth' -> BorderWidth

'IELP_FillColor' -> FillColor

'IELP_FillColor2' -> FillColor2

'IELP_FillGradient' -> FillGradient

'IELP_Rotate' -> Rotate

'IELP_RotateCenterX' -> RotateCenterX

'IELP_RotateCenterY' -> RotateCenterY

'IELP_SoftShadowEnabled' -> SoftShadow.Enabled

'IELP_SoftShadowRadius' -> SoftShadow.Radius

'IELP_SoftShadowOffsetX' -> SoftShadow.OffsetX

'IELP_SoftShadowOffsetY' -> SoftShadow.OffsetY

'IELP_SoftShadowIntensity' -> SoftShadow.Intensity

'IELP_SoftShadowColor' -> SoftShadow.ShadowColor

'IELP_ImageResampleFilter' -> ResampleFilter

'IELP_ImageUseResampleFilter' -> UseResampleFilter

'IELP_Shape' -> Shape

'IELP_ShapeModifier' -> ShapeModifier

'IELP_LineColor' -> LineColor

'IELP_LineWidth' -> LineWidth

'IELP_LineFillColor' -> FillColor

'IELP_LabelText' -> LabelText

'IELP_LabelAlignment' -> LabelAlignment

'IELP_LabelPosition' -> LabelPosition

'IELP_LineEndShape' -> EndShape

'IELP_LineShapeSize' -> ShapeSize

'IELP_LineStartShape' -> StartShape

'IELP_LineLength' -> LineLength

'IELP_PolylinePoints' -> Points

'IELP_PolylineClosed' -> PolylineClosed

'IELP_FontName' -> Font.Name, LabelFont.Name

'IELP_FontSize' -> Font.Size, LabelFont.Size

'IELP_FontColor' -> Font.Color, LabelFont.Color

'IELP_BorderShape' -> BorderShape, LabelShape

'IELP_Text' -> Text

'IELP_AutoSize' -> AutoSize

'IELP_ReadOnly' -> ReadOnly, ReadOnly

'IELP_TextAlignment' -> Alignment

'IELP_TextLayout' -> Layout

'IELP_AntiAlias' -> AntiAlias

'IELP_SizeToFit' -> Calls either SizeToFit or SizeToText

'IELP_RestoreSize' -> Calls RestoreSize

'IELP_RestoreAspectRatio' -> Calls RestoreAspectRatio(False)

'IELP_RestorePreferredAspectRatio' -> Calls RestoreAspectRatio(True)

LayersAutoUndo
Allows auto undo for layers modifications made by user actions like moving and resizing.
LayersCount
LayersCount returns the number of layers.
LayersCurrent

LayersCurrent get/set the current layer. The first layer starts at 0, the last is LayersCount-1.

Making a layer current changes the bitmap properties, so it points to the current layer (allowing specification of which layer is active for input/output and image processing operations).

LayersMergeFilter

Specifies the quality that is used when merging layers.

Has no effect on image layers, if they have a custom UseResampleFilter.

LayersRotationFilter
Specifies the rotation filter to use when layers rotation has finished and stabilizied.
LayersSync
Deprecated
LegacyBitmap

If LegacyBitmap is True IEvolution uses a Windows Bitmap object (GDI object) to store the image, otherwise ImageEn uses an internal object.

The internal object handles images using memory mapped file (for large images) or main memory: this allows to handle large images and to include input/output and image processing in a multithreaded environment.

LoadChangesBackgroundColor

Set this property to True to change the control background color to the image background color (the default is False).

Not all file formats contains background color information.

LZWSupport
Enable LZW support for GIF and TIFF.
MagicWandMaxFilter

Set MagicWandMaxFilter to True (default is False) to apply a maximum filter to the magic wand selection (remove black hole).

MagicWandTolerance specifies the color diference of original point and region point (default 15).

MagicWandMode

MagicWandMode specifies how magic wand selection works. Allowed values:

Inclusive : the selection is a closed polygon (default)

Exclusive : the selection includes only points that mach initial pixel, like a flood-fill

Global : the selection includes all points that mach initial pixel, looking for all pixels in the image.

MagicWandTolerance

Set MagicWandMaxFilter to True (default is False) to apply a maximum filter to the magic wand selection (remove black hole).

MagicWandTolerance specifies the color diference of original point and region point (default 15).

MaxImageEMFSize
Specifies the maximum width or height of imported EMF/WMF image.
MaxLayerHeight

Returns the maximum height of all layers.

The result will include any layers outside the background layer (if LayersCropped and Cropped are not set).

MaxLayerWidth

Returns the maximum width of all layers.

The result will include any layers outside the background layer (if LayersCropped and Cropped are not set).

MinFileSize

Specifies the minimum memory needed by the image to allow use of memory mapped file.

If the memory needed by the image is less than MinFileSize, the image will be stored in memory (also if the Location is File).

If the global variable IEDefMinFileSize is not -1, it overlaps the property MinFileSize value.

NativePixelFormat

By setting this property to True, you disable the conversion of paletted images and gray scale to 24 bit.

By default, IEvolution converts all paletted images to 24 bit (true color).

Only black/white images are stored in the original format with 1 bit per pixel.

IEImage.LegacyBitmap must be False.

Note that setting NativePixelFormat=True, you will not be able to execute some image processing operations.

Origin

Specifies bitmap origin. Default is bottomleft, that is Windows compatible.

Other libraries could require topleft (like OpenCV).

PaletteLength
Returns the items count of palette (usually 256).
PaletteUsed
Get/set the number of used colors of palette.
PreviewFont
If PreviewFontEnabled is set to True then PreviewFont specifies the font used in the DoImageProcessingPreviews dialog. Ensure the size of the font matches the length of labels.
PreviewFontEnabled
If you set PreviewFontEnabled to True then you can use PreviewFont to specify a custom font for the DoImageProcessingPreviews dialogs.
PreviewParams
Specifies the previews options.
PreviewsLog
Returns a log of operations performed in the Image Processing Dialog (DoImageProcessingPreviews).
PrintCopies
Specifies the number of copies to print.
PrintDlgMeasureUnit
DialogsMeasureUnit specifies the measure unit used in print preview dialog.
PrinterIndex

Specifies which printer listed in the Printers property is the currently selected printer.

To select the default printer, set the value of PrinterIndex to -1.

PrintersGetCount
Returns the number of items in Printers method.
PrintingFilterOnSubsampling
Specifies a filter when the image needs to be printed and it must be resampled. Filtering enhances the image quality but slows processing.
PrintOrientation
Indicates the orientation of pages when printing.
PrintPreviewParams
Allows to get/set print preview parameters when PrintPreviewDialog is called.
ProxyAddress
ProxyAddress specifies the proxy address and port when using LoadFromURL method. The syntax is: ‘domain:port’.
ProxyPassword
ProxyPassword specifies the proxy password when using LoadFromURL method.
ProxyUser
ProxyUser specifies the proxy userid when using LoadFromURL method.
RedoCount
RedoCount returns the image count in Redo stack
ScaleFactor

Sets the scale factor (default 1). In the common representation X:Y (ex. 1:100000) is the Y value (100000).

This value, with DPIX and DPIY (and measure unit MeasureUnit), weight the measurements of areas and line lenghts.

SelectedBoundingBox
Returns the bounding box of the selected area
SelectionBase

Sets the selection coordinaties base.

If SelectionBase is ClientArea all coordinates depends from actual Zoom and scrolling.

Otherwise, if SelectionBase is Bitmap (the default) all coordinates refers bitmap pixels.

SelectionIntensity

The SelectionIntensity property allows specifying the selection intensity and it is valid only when SelectionMaskDepth is 8 (8 bit), otherwise this must be 1.

You can assign a value from 0 to 255 which will be applied to the next or current selection.

SelectionMaskDepth

The SelectionMaskDepth property allows specifying the selection depth in bits.

The default is 1 bit, then a pixel can be "unselected"=0 or "selected"=1.

With setting 8 (8 bit), a pixel can be unselected=0, "semi-selected" from 1 to 254, or fully selected =255.

This allows creating soft selections or feathering selections.

SimplifiedParamsDialogs

If the SimplifiedParamsDialogs property is True (the default), the "Advanced" button of open/save dialogs will show a simplified set of parameters.

Warning: the default is True, to allow old style "advanced" dialogs set it to False.

ThreadsCount
Returns the count of currently active threads. Valid only if AsyncMode is True.
TWainParams

Use TWainParams property to control scanner acqusition.

You can enable/disable standard user interface, set pixeltype (Grayscale, RGB...), DPI, or select the acquire scanner without user interaction.

UndoCount
UndoCount returns the image count in Undo stack
UndoLimit

UndoLimit specifies how much images can be saved using SaveUndo method. Default is 1.

When you call SaveUndo ImageEn pushes the current image in an image stack.

Calling Undo ImageEn restore last saved image. Calling ClearUndo ImageEn removes last saved image.

UseCMYKProfile
When true IEvolution uses an internal ICC profile to convert from CMYK to RGB and viceversa.
WhiteValue
The final white value. Used with BlackValue to display only a range of gray scales.
Width
Get/Set the bitmap width

See Also