com.esri.arcgis.arcmapui
Interface ILayerEffectsEnvironment3

All Superinterfaces:

Serializable

All Known Implementing Classes:

LayerEffectsEnvironment

public interface ILayerEffectsEnvironment3
extends Serializable

Provides access to members that control the Layer Effects Environment.

Description

This interface is new at ArcGIS 9.3. It supersedes ILayerEffectsEnvironment and ILayerEffectsEnvironment2.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IActiveView	getActiveView() The IActiveView interface of the view to be refreshed.
IMxDocument	getDocument() Current document.
ILayerEffects	getEffectsLayer() The ILayerEffects interface of the current effects layer.
ILayer	getSelectedLayer() Currenttly selected layer.
void	setActiveViewByRef(IActiveView activeView) The IActiveView interface of the view to be refreshed.
void	setDocumentByRef(IMxDocument doc) Current document.
void	setEffectsLayerByRef(ILayerEffects effects) The ILayerEffects interface of the current effects layer.
void	setSelectedLayerByRef(ILayer layer) Currenttly selected layer.

Method Detail

getEffectsLayer

ILayerEffects getEffectsLayer()
                              throws IOException,
                                     AutomationException

The ILayerEffects interface of the current effects layer.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.carto.ILayerEffects

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEffectsLayerByRef

void setEffectsLayerByRef(ILayerEffects effects)
                          throws IOException,
                                 AutomationException

The ILayerEffects interface of the current effects layer.

Product Availability

Available with ArcGIS Desktop.

Parameters:

effects - A reference to a com.esri.arcgis.carto.ILayerEffects (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

The IActiveView interface of the view to be refreshed.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.carto.IActiveView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveViewByRef

void setActiveViewByRef(IActiveView activeView)
                        throws IOException,
                               AutomationException

The IActiveView interface of the view to be refreshed.

Product Availability

Available with ArcGIS Desktop.

Parameters:

activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedLayer

ILayer getSelectedLayer()
                        throws IOException,
                               AutomationException

Currenttly selected layer.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedLayerByRef

void setSelectedLayerByRef(ILayer layer)
                           throws IOException,
                                  AutomationException

Currenttly selected layer.

Product Availability

Available with ArcGIS Desktop.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocument

IMxDocument getDocument()
                        throws IOException,
                               AutomationException

Current document.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.arcmapui.IMxDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentByRef

void setDocumentByRef(IMxDocument doc)
                      throws IOException,
                             AutomationException

Current document.

Product Availability

Available with ArcGIS Desktop.

Parameters:

doc - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.