com.esri.arcgis.controls
Class ISymbologyControlDefaultProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.ISymbologyControlDefaultProxy
All Implemented Interfaces:
ISymbologyControlDefault, Externalizable, Serializable

public class ISymbologyControlDefaultProxy
extends com.esri.arcgis.interop.Dispatch
implements ISymbologyControlDefault, Serializable

Provides access to members that control the SymbologyControl.

Description

The ISymbologyControlDefault interface is the default dispatch interface that most development environments will automatically expose. For example, placing the SymbologyControl in a container will typically generate an object called SymbologyControl1. The properties and methods available directly on this object correspond to this interface, together with container specific properties and methods.

The ISymbologyControlDefault interface is a 'pure' dispatch interface, so can be extended with new properties and methods at future releases of ArcGIS. The methods and properties are identical to the highest numbered main interface on the SymbologyControl. For example, ISymbologySelectorDefault is equivalent to ISymbologyControl, but at future releases this could become ISymbologyControl2. By using the ISymbologySelectorDefault interface you are guaranteed to always have access to the latest SymbologyControl.

There is a small performance overhead in making calls through to a pure dispatch interface, but to avoid this you can QI to a specific interface. In some development environments it is not possible to QI directly on the control to other COM interfaces, because the control is contained within a wrapper object. Use the Object property to get the real control before performing the QI.

Product Availability

Available with ArcGIS Engine.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ISymbologyControlDefaultProxy()
           
  ISymbologyControlDefaultProxy(Object obj)
           
protected ISymbologyControlDefaultProxy(Object obj, String iid)
           
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the SymbologyControl.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void clear()
          Clears all symbols and files from the SymbologyControl.
 boolean esri_isEnabled()
          Indicates whether the SymbologyControl can respond to user generated events.
 void esri_setEnabled(boolean rhs1)
          Indicates whether the SymbologyControl can respond to user generated events.
 int getAppearance()
          The appearance of the SymbologyControl.
 int getBackColor()
          Background color of the SymbologyControl.
 int getBorderStyle()
          The border style of the SymbologyControl.
 Object getCustomProperty()
          A property to associate data with the SymbologyControl.
 int getDisplayStyle()
          The display style of the SymbologyControl.
 int getHWnd()
          Handle to the window associated with the SymbologyControl.
 int getKeyIntercept()
          A property that specifies interception of key strokes that are normally handled by the container.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the SymbologyControl.
 Object getObject()
          A property that returns the underlying control.
 int getStyleClass()
          The style class used by the SymbologyControl.
 ISymbologyStyleClass getStyleClass2(int styleClass)
          Returns the specified style class from the SymbologyControl.
 IStyleGalleryItem hitTest(int x, int y)
          Returns the item at the specified x and y coordinates.
 boolean isShowContextMenu()
          Indicates if the SymbologyControl displays a context menu.
 void loadDesktopStyleFile(String fileName)
          Loads a desktop style file into the SymbologyControl.
 void loadStyleFile(String fileName)
          Loads a server style file into the SymbologyControl.
 void readExternal(ObjectInput in)
           
 void removeFile(String fileName)
          Removes a file from the SymbologyControl.
 void removeListener(String iidStr, Object theListener)
           
 void setAppearance(int rhs1)
          The appearance of the SymbologyControl.
 void setBackColor(int rhs1)
          Background color of the SymbologyControl.
 void setBorderStyle(int rhs1)
          The border style of the SymbologyControl.
 void setCustomProperty(Object rhs1)
          A property to associate data with the SymbologyControl.
 void setDisplayStyle(int rhs1)
          The display style of the SymbologyControl.
 void setKeyIntercept(int rhs1)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setMouseIconByRef(Picture rhs1)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int rhs1)
          The mouse pointer displayed over the SymbologyControl.
 void setShowContextMenu(boolean rhs1)
          Indicates if the SymbologyControl displays a context menu.
 void setStyleClass(int rhs1)
          The style class used by the SymbologyControl.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ISymbologyControlDefaultProxy

public ISymbologyControlDefaultProxy()

ISymbologyControlDefaultProxy

public ISymbologyControlDefaultProxy(Object obj)
                              throws IOException
Throws:
IOException

ISymbologyControlDefaultProxy

protected ISymbologyControlDefaultProxy(Object obj,
                                        String iid)
                                 throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

setBackColor

public void setBackColor(int rhs1)
                  throws IOException,
                         AutomationException
Background color of the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setBackColor in interface ISymbologyControlDefault
Parameters:
rhs1 - The rhs1 (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackColor

public int getBackColor()
                 throws IOException,
                        AutomationException
Background color of the SymbologyControl.

Description

Returns or sets the Background Color of the SymbologyControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:

OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)

Where Red, Green and Blue are Long Integers within the range 0 - 255.

Product Availability

Available with ArcGIS Engine.

Specified by:
getBackColor in interface ISymbologyControlDefault
Returns:
The returnValue (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int rhs1)
                     throws IOException,
                            AutomationException
The mouse pointer displayed over the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setMousePointer in interface ISymbologyControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws IOException,
                           AutomationException
The mouse pointer displayed over the SymbologyControl.

Description

Use this property when you want to indicate changes in functionality as the mouse pointer passes over the SymbologyControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.

Product Availability

Available with ArcGIS Engine.

Specified by:
getMousePointer in interface ISymbologyControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsMousePointer constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture rhs1)
                       throws IOException,
                              AutomationException
Custom mouse icon used if MousePointer is 99.

Product Availability

Available with ArcGIS Engine.

Specified by:
setMouseIconByRef in interface ISymbologyControlDefault
Parameters:
rhs1 - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Description

The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).

Remarks

In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.

To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.

Product Availability

Available with ArcGIS Engine.

Specified by:
getMouseIcon in interface ISymbologyControlDefault
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws IOException,
                           AutomationException
The border style of the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setBorderStyle in interface ISymbologyControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorderStyle

public int getBorderStyle()
                   throws IOException,
                          AutomationException
The border style of the SymbologyControl.

Description

Returns or sets the border style of a SymbologyControl. By default a border is drawn.

Product Availability

Available with ArcGIS Engine.

Specified by:
getBorderStyle in interface ISymbologyControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsBorderStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws IOException,
                            AutomationException
Indicates whether the SymbologyControl can respond to user generated events.

Product Availability

Available with ArcGIS Engine.

Specified by:
esri_setEnabled in interface ISymbologyControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws IOException,
                              AutomationException
Indicates whether the SymbologyControl can respond to user generated events.

Product Availability

Available with ArcGIS Engine.

Specified by:
esri_isEnabled in interface ISymbologyControlDefault
Returns:
The returnValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int rhs1)
                   throws IOException,
                          AutomationException
The appearance of the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setAppearance in interface ISymbologyControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws IOException,
                         AutomationException
The appearance of the SymbologyControl.

Description

Returns or sets the paint style of a SymbologyControl to either Flat or 3D. By default the appearance is flat.

Product Availability

Available with ArcGIS Engine.

Specified by:
getAppearance in interface ISymbologyControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsAppearance constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException
Handle to the window associated with the SymbologyControl.

Description

The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.

Product Availability

Available with ArcGIS Engine.

Specified by:
getHWnd in interface ISymbologyControlDefault
Returns:
The returnValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

aboutBox

public void aboutBox()
              throws IOException,
                     AutomationException
Displays a dialog of information about the SymbologyControl.

Description

The AboutBox method causes a modal dialog box to display on top of the SymbologyControl, containing information about the version and creation date of the SymbologyControl as well as listing relevant legal and copyright information from ESRI.

Product Availability

Available with ArcGIS Engine.

Specified by:
aboutBox in interface ISymbologyControlDefault
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyleClass

public void setStyleClass(int rhs1)
                   throws IOException,
                          AutomationException
The style class used by the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setStyleClass in interface ISymbologyControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriSymbologyStyleClass constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyleClass

public int getStyleClass()
                  throws IOException,
                         AutomationException
The style class used by the SymbologyControl.

Description

The SymbologyStyleClass currently displayed in the SymbologyControl. By default marker symbols are displayed.

The end user can set the StyleClass by interacting with the 'Style Class' context menu. The end user can display the 'Style Class' context menu by right clicking on the SymbologyControl when ShowContextMenu is true.

The OnStyleClassChanged event will fire when the StyleClass is set.

Remarks

The following style classes are only supported with an ArcGIS Desktop installation:

Product Availability

Available with ArcGIS Engine.

Specified by:
getStyleClass in interface ISymbologyControlDefault
Returns:
A com.esri.arcgis.controls.esriSymbologyStyleClass constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayStyle

public void setDisplayStyle(int rhs1)
                     throws IOException,
                            AutomationException
The display style of the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setDisplayStyle in interface ISymbologyControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriSymbologyDisplayStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayStyle

public int getDisplayStyle()
                    throws IOException,
                           AutomationException
The display style of the SymbologyControl.

Description

Returns or sets the style the items are displayed in the SymbologyControl. By default the DisplayStyle is Icon.

esriDisplayStyleIcon

esriDisplayStyleSmallIcon

esriDisplayStyleReport

esriDisplayStyleList

Product Availability

Available with ArcGIS Engine.

Specified by:
getDisplayStyle in interface ISymbologyControlDefault
Returns:
A com.esri.arcgis.controls.esriSymbologyDisplayStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int rhs1)
                     throws IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Product Availability

Available with ArcGIS Engine.

Specified by:
setKeyIntercept in interface ISymbologyControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Description

Returns or sets keys on the keyboard that will be intercepted by the SymbologyControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the SymbologyControl by the development environment container. By default the KeyIntercept is set to esriKeyInterceptNone.

Many development environment containers use the up, down, left and right arrow keys to change control focus on a form. These keys can also be useful for navigating around the display. To intercept the arrow keys and the Tab key combine the enum values using a logical OR operation (esriKeyInterceptArrowKeys OR esriKeyInterceptTabKey, which is 1 OR 4 = 5).

Product Availability

Available with ArcGIS Engine.

Specified by:
getKeyIntercept in interface ISymbologyControlDefault
Returns:
The returnValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with the SymbologyControl.

Description

Use the CustomProperty to associate any useful data with the SymbologyControl. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

Product Availability

Available with ArcGIS Engine.

Specified by:
getCustomProperty in interface ISymbologyControlDefault
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object rhs1)
                       throws IOException,
                              AutomationException
A property to associate data with the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
setCustomProperty in interface ISymbologyControlDefault
Parameters:
rhs1 - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowContextMenu

public void setShowContextMenu(boolean rhs1)
                        throws IOException,
                               AutomationException
Indicates if the SymbologyControl displays a context menu.

Product Availability

Available with ArcGIS Engine.

Specified by:
setShowContextMenu in interface ISymbologyControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowContextMenu

public boolean isShowContextMenu()
                          throws IOException,
                                 AutomationException
Indicates if the SymbologyControl displays a context menu.

Description

Determines whether the 'Style Class' context menu will popup when the user right clicks on the control. This property is false by default.

The OnStyleClassChanged event will fire if the user interactively sets the StyleClass property using the 'Style Class' context menu.

Product Availability

Available with ArcGIS Engine.

Specified by:
isShowContextMenu in interface ISymbologyControlDefault
Returns:
The returnValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Description

In some development environments it is not possible to query interface directly on the control to other COM interfaces, beacuse the control is contained within a wrapper object. To get the real control use the Object property.

Product Availability

Available with ArcGIS Engine.

Specified by:
getObject in interface ISymbologyControlDefault
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTest

public IStyleGalleryItem hitTest(int x,
                                 int y)
                          throws IOException,
                                 AutomationException
Returns the item at the specified x and y coordinates.

Description

Returns the item at the specified x and y coordinates (in pixels). If no item is found, returns Nothing.

Product Availability

Available with ArcGIS Engine.

Specified by:
hitTest in interface ISymbologyControlDefault
Parameters:
x - The x (in)
y - The y (in)
Returns:
A reference to a com.esri.arcgis.display.IStyleGalleryItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadStyleFile

public void loadStyleFile(String fileName)
                   throws IOException,
                          AutomationException
Loads a server style file into the SymbologyControl.

Description

Loads the contents of the specified server style file (*.ServerStyle) into the SymbologyControl. Each ServerStyleGalleryItem within the server style file is added to a SymbologyStyleClass based on its type. For example, a SimpleFillSymbol will be added to the esriStyleClassFillSymbols SymbologyStyleClass.

Items are 'demand loaded' to the end of a SymbologyStyleClass item collection. This is done to increase performance and means items are only loaded into a SymbologyStyleClass when it is the current StyleClass or when the SymbologyStyleClass is being accessed programmatically. To force items to be loaded into a SymbologyStyleClass, when it is not the current StyleClass use the ISymbologyStyleClass::Update method.

Passing the same server style file to the LoadStyleFile method multiple times within the lifetime of an application, causes the contents of the server style file to be re-loaded into the SymbologyControl.

Remarks

Server Styles are collections of symbols and map elements that are often grouped by functionality. For example, symbols and map elements used by the transportation industry maybe grouped into Transportation Server Style.

Server Styles are stored in files that have a .ServerStyle extension. ESRI provides several styles for you to use out of the box. These styles are found under \\install_location\ArcGIS\Styles. You will find commonly used symbols and map elements in ESRI.ServerStyle, and more domain specific style items in relevantly named .ServerStyle files (for example, Transportation.ServerStyle).

A style is composed of several style items. These style items provide access to individual map elements and symbols. Style items are organized into style classes, which are types of style items. A style class may have several groups of items organized into categories. For example, Precipitation is style item that belongs to the Color Ramps style class and the Default Ramps category.

Product Availability

Available with ArcGIS Engine.

Specified by:
loadStyleFile in interface ISymbologyControlDefault
Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadDesktopStyleFile

public void loadDesktopStyleFile(String fileName)
                          throws IOException,
                                 AutomationException
Loads a desktop style file into the SymbologyControl.

Description

Loads the contents of the specified style file (*.Style) into the SymbologyControl. Where possible always use the LoadStyleFile method to load the contents of server style files (*.ServerStyle) into the SymbologyControl, as style files are only supported with an ArcGIS Desktop installation.

Each StyleGalleryItem within the style file is added to a SymbologyStyleClass based on its type. For example, a SimpleFillSymbol will be added to the esriStyleClassFillSymbols SymbologyStyleClass .

Items are 'demand loaded' to the end of a SymbologyStyleClass item collection. This is done to increase performance and means items are only loaded into a SymbologyStyleClass when it is the current StyleClass or when the SymbologyStyleClass is being accessed programmatically. To force items to be loaded into a SymbologyStyleClass, when it is not the current StyleClass use the ISymbologyStyleClass::Update method.

Passing the same style file to the LoadDesktopStyleFile method multiple times within the lifetime of an application, causes the contents of the style file to be re-loaded into the SymbologyControl.

Remarks

A 'desktop' Style file is similar to a Server Style file, except is has a .Style extension rather than a .ServerStyle extension. Style files are available to ArcGIS Desktop products only, whereas Server Style files are available to all ArcGIS products.

Product Availability

Available with ArcGIS Engine.

Specified by:
loadDesktopStyleFile in interface ISymbologyControlDefault
Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyleClass2

public ISymbologyStyleClass getStyleClass2(int styleClass)
                                    throws IOException,
                                           AutomationException
Returns the specified style class from the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Specified by:
getStyleClass2 in interface ISymbologyControlDefault
Parameters:
styleClass - A com.esri.arcgis.controls.esriSymbologyStyleClass constant (in)
Returns:
A reference to a com.esri.arcgis.controls.ISymbologyStyleClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeFile

public void removeFile(String fileName)
                throws IOException,
                       AutomationException
Removes a file from the SymbologyControl.

Description

Removes the contents of the specified server style file (*.ServerStyle) or style file (*.Style) from the SymbologyControl. Corresponding items are removed from each SymbologyStyleClass.

Product Availability

Available with ArcGIS Engine.

Specified by:
removeFile in interface ISymbologyControlDefault
Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException
Clears all symbols and files from the SymbologyControl.

Description

Clears all items from the SymbologyControl. Items are removed from each SymbologyStyleClass regardless of whether they were loaded using the LoadStyleFile, LoadDesktopStyleFile or ISymbologyStyleClass::AddItem methods.

Product Availability

Available with ArcGIS Engine.

Specified by:
clear in interface ISymbologyControlDefault
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException