com.esri.arcgis.schematic
Interface INgVectorImage

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgVectorImageProxy, NgVectorImage

public interface INgVectorImage
extends Serializable

Provides access to members that control the vector image.

Description

A vector image is a DXF format image placed in a view background.

Product Availability

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

See Also:

INgRasterImage, INgView.createVectorImage(String, String)

Method Summary

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

Method Detail

getView

INgView getView()
                throws IOException,
                       AutomationException

View the vector image is associated with.

Description

This view is set when the vector image is created using the INgView CreateVectorImage method in the project code or when the predefined ViewVectorImages 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.createVectorImage(String, String)

getName

String getName()
               throws IOException,
                      AutomationException

Name of the vector image.

Description

It is the name given to the vector 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.

getEffect

Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the vector image (see esriNgVectorImageEffect).

Product Availability

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

Parameters:

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

setEffect

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

Modifies the effect 'effect' set for the vector image (see esriNgVectorImageEffect).

Product Availability

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

Parameters:

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

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

removeEffect

void removeEffect(int effect)
                  throws IOException,
                         AutomationException

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

Description

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

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

delete

void delete()
            throws IOException,
                   AutomationException

Removes the vector 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:

INgVectorImage.move(double, double, int), INgView.createVectorImage(String, String)

move

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

Moves the vector 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 vector 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:

INgView.createVectorImage(String, String), INgVectorImage.delete()

isEffectSet

boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the vector image is set (see esriNgVectorImageEffect).

Description

By default, Schematics automatically sets default values for some vector image effects (see the List of the INgVectorImage default effects 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 INgVectorImage effect default values

esriNgVectorImageVisibility: esriNgVisible

esriNgVectorImagePriority: 0

For more details, see Vector Image Effects Definitions.

Product Availability

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

Parameters:

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

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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