com.esri.arcgis.schematic
Interface INgRasterImage

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgRasterImageProxy, NgRasterImage

public interface INgRasterImage
extends Serializable

Provides access to members that control the raster image.

Description

A raster image is a BMP format image placed in a view background.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

INgVectorImage

Method Summary

void	delete() Removes the raster image.
Object	getEffect(int effect) Returns the effect 'effect' set for the raster image (see esriNgRasterImageEffect).
String	getName() Name of the raster image.
INgView	getView() View the raster image is associated with.
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the raster image is set (see esriNgRasterImageEffect).
void	move(double x, double y, int moveMode) Moves the raster image to the (x,y) relative or absolute position.
void	removeEffect(int effect) Restores the default effect 'effect' set for the raster image.
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the raster image (see esriNgRasterImageEffect).

Method Detail

getView

INgView getView()
                throws IOException,
                       AutomationException

View the raster image is associated with.

Description

This view is set when the raster image is created using the INgView CreateRasterImage method in the project code or when the predefined ViewRasterImages attribute for the diagram type related to this view has been defined.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.schematic.INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

getName

String getName()
               throws IOException,
                      AutomationException

Name of the raster image.

Description

It is the name given to the raster image when it is created.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

getEffect

Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the raster image (see esriNgRasterImageEffect).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

effect - A com.esri.arcgis.schematic.esriNgRasterImageEffect constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.isEffectSet(int), INgRasterImage.removeEffect(int), INgRasterImage.setEffect(int, java.lang.Object)

setEffect

void setEffect(int effect,
               Object effValue)
               throws IOException,
                      AutomationException

Modifies the effect 'effect' set for the raster image (see esriNgRasterImageEffect).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

effect - A com.esri.arcgis.schematic.esriNgRasterImageEffect constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.isEffectSet(int), INgRasterImage.getEffect(int), INgRasterImage.removeEffect(int)

removeEffect

void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Restores the default effect 'effect' set for the raster image.

Description

Note that when removing an effect that is always set, the raster image default effect value is automatically restored; and removing an effect that is not set by default, really removes the raster image effect.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

effect - A com.esri.arcgis.schematic.esriNgRasterImageEffect constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.isEffectSet(int), INgRasterImage.getEffect(int), INgRasterImage.setEffect(int, java.lang.Object)

delete

void delete()
            throws IOException,
                   AutomationException

Removes the raster image.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.move(double, double, int), INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

isEffectSet

boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the raster image is set (see esriNgRasterImageEffect).

Description

By default, Schematics automatically sets default values for some raster image effects (see the List of the INgRasterImage effect default values, below). For all these effects, the IsEffectSet method returns True.

For the others effects (those that are not automatically set by default), the IsEffectSet method returns True only if the effect has been set by calling the SetEffect method in the project.

List of the INgRasterImage effect default values

esriNgRasterImageVisibility: esriNgVisible

esriNgRasterImagePriority: 0

esriNgRasterImageHeight: the image's height

esriNgRasterImageWidth: the image's width

For more details, see Raster Image Effects Definitions

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

effect - A com.esri.arcgis.schematic.esriNgRasterImageEffect constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.getEffect(int), INgRasterImage.removeEffect(int), INgRasterImage.setEffect(int, java.lang.Object)

move

void move(double x,
          double y,
          int moveMode)
          throws IOException,
                 AutomationException

Moves the raster image to the (x,y) relative or absolute position.

Description

The values taken by the moveMode parameter are detailed in the esriNgMoveMode list.

The default value for moveMode is esriNgAbsoluteMove, which means that, by default, the background raster image is moved to the (X,Y) absolute position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

x - The x (in)

y - The y (in)

moveMode - A com.esri.arcgis.schematic.esriNgMoveMode constant (in, optional, pass 2085 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.delete(), INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)