com.esri.arcgis.cartoUI
Interface ISymbolLevelsDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

SymbolLevelsDialog

public interface ISymbolLevelsDialog
extends Serializable

Provides access to members that control a dialog for setting symbol levels.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	doModal(int parentHWnd) Displays the dialog.
void	enableApplyButton(boolean bEnable, IMap pMap) Enable apply button in dialog and pass map to refresh if apply is pressed.
IArray	getSymbolArray() Provides access to the modified symbols from the dialog.
boolean	isUseSymbolLevels() Indicates if symbol levels are used.
void	setControlLayer(ILayer rhs1) Inform the dialog about a layer that controls the symbol levels at a more global scope.
void	setLayer(ILayer rhs1) The Layer for which the symbol levels should be displayed.
void	setSymbols(Object vSymbols, Object vLabelNames, Object vLayerNames, Object rhs4) Add data to populate the symbol level list control.
void	setUseSymbolLevels(boolean pbUsesLevels) Indicates if symbol levels are used.

Method Detail

setLayer

void setLayer(ILayer rhs1)
              throws IOException,
                     AutomationException

The Layer for which the symbol levels should be displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - 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.

setSymbols

void setSymbols(Object vSymbols,
                Object vLabelNames,
                Object vLayerNames,
                Object rhs4)
                throws IOException,
                       AutomationException

Add data to populate the symbol level list control.

Product Availability

Available with ArcGIS Desktop.

Parameters:

vSymbols - A Variant (in)

vLabelNames - A Variant (in)

vLayerNames - A Variant (in)

rhs4 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolArray

IArray getSymbolArray()
                      throws IOException,
                             AutomationException

Provides access to the modified symbols from the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSymbolLevels

void setUseSymbolLevels(boolean pbUsesLevels)
                        throws IOException,
                               AutomationException

Indicates if symbol levels are used.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pbUsesLevels - The pbUsesLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSymbolLevels

boolean isUseSymbolLevels()
                          throws IOException,
                                 AutomationException

Indicates if symbol levels are used.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pbUsesLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableApplyButton

void enableApplyButton(boolean bEnable,
                       IMap pMap)
                       throws IOException,
                              AutomationException

Enable apply button in dialog and pass map to refresh if apply is pressed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

bEnable - The bEnable (in)

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setControlLayer

void setControlLayer(ILayer rhs1)
                     throws IOException,
                            AutomationException

Inform the dialog about a layer that controls the symbol levels at a more global scope.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - 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.

doModal

boolean doModal(int parentHWnd)
                throws IOException,
                       AutomationException

Displays the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.