com.esri.arcgis.arcmapui
Class TableProperties

java.lang.Object
  com.esri.arcgis.arcmapui.TableProperties

All Implemented Interfaces:

IDocumentEvents, IEnumTableProperties, ITableProperties, IActiveViewEvents, IDefaultTableProperty, ITableCalculator, ITableCharacteristics, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable, EventListener

public class TableProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITableProperties, IDefaultTableProperty, ITableCharacteristics, ITableCalculator, IEnumTableProperties, IClone, IPersist, IPersistStream, IDocumentEvents, IActiveViewEvents, Externalizable

Table window properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

TableProperties()
Constructs a TableProperties using ArcGIS Engine.

TableProperties(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableProperties theTableProperties = (TableProperties) obj;

Method Summary

void	activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
void	add(ITableProperty pTableProperty) Add a table property.
void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
void	closeDocument(IDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
Font	getCellFont() Table font.
IColor	getCellTextColor() Text color use in table window.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Font	getHeadingFont() Table font.
IColor	getHeadingTextColor() Text color use in table window.
IEnumTableProperties	getIEnumTableProperties() Table Property Enum.
String	getIndexFieldCharacter() Character placed to the right of the field name when a field is indexed.
IColor	getSelectionColor() Selection color use to highlight rows.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isAutoValidateEdits() Indicates if the table window should validate any changes to the data during editing.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFireRowChangedEventsForJoins() Indicates if row changed events should be fires for join tables.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isShowCodedValueDomainDescriptions() Indicates if the table window shows coded value domain descriptions or values.
boolean	isShowIndexFieldCharacter() Indicates whether table window should show field index character.
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
void	load(IStream pstm) load
void	mapsChanged(IDocumentEventsMapsChangedEvent theEvent) Fired when a change is made to the map collection.
void	newDocument(IDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
ITableProperty	next() Get the next table property.
void	onContextMenu(IDocumentEventsOnContextMenuEvent theEvent) Indicates if a context menu should be displayed at the given xy location.
void	openDocument(IDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.
void	readExternal(ObjectInput in)
void	remove(ITableProperty pTableProperty) Remove a table property.
void	removeAll() Remove all table properties.
void	reset() Reset.
void	save(IStream pstm, int fClearDirty) save
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	setAutoValidateEdits(boolean autoValidateEdits) Indicates if the table window should validate any changes to the data during editing.
void	setCellFontByRef(Font ppFont) Table font.
void	setCellTextColorByRef(IColor ppTextColor) Text color use in table window.
void	setFireRowChangedEventsForJoins(boolean pFireRowEvents) Indicates if row changed events should be fires for join tables.
void	setHeadingFontByRef(Font ppFont) Table font.
void	setHeadingTextColorByRef(IColor ppTextColor) Text color use in table window.
void	setIndexFieldCharacter(String pIndexChar) Character placed to the right of the field name when a field is indexed.
void	setSelectionColorByRef(IColor ppSelectionColor) Selection color use to highlight rows.
void	setShowCodedValueDomainDescriptions(boolean showCodedValueDomainDescriptions) Indicates if the table window shows coded value domain descriptions or values.
void	setShowIndexFieldCharacter(boolean pShowIndexCharacter) Indicates whether table window should show field index character.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TableProperties

public TableProperties()
                throws IOException,
                       UnknownHostException

Constructs a TableProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TableProperties

public TableProperties(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableProperties theTableProperties = (TableProperties) obj;

Construct a TableProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TableProperties.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getIEnumTableProperties

public IEnumTableProperties getIEnumTableProperties()
                                             throws IOException,
                                                    AutomationException

Table Property Enum.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getIEnumTableProperties in interface ITableProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(ITableProperty pTableProperty)
         throws IOException,
                AutomationException

Add a table property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

add in interface ITableProperties

Parameters:

pTableProperty - A reference to a com.esri.arcgis.arcmapui.ITableProperty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(ITableProperty pTableProperty)
            throws IOException,
                   AutomationException

Remove a table property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

remove in interface ITableProperties

Parameters:

pTableProperty - A reference to a com.esri.arcgis.arcmapui.ITableProperty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Remove all table properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

removeAll in interface ITableProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws IOException,
                                AutomationException

Selection color use to highlight rows.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectionColor in interface IDefaultTableProperty

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor ppSelectionColor)
                            throws IOException,
                                   AutomationException

Selection color use to highlight rows.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSelectionColorByRef in interface IDefaultTableProperty

Parameters:

ppSelectionColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingFont

public Font getHeadingFont()
                    throws IOException,
                           AutomationException

Table font.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHeadingFont in interface ITableCharacteristics

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellFont

public Font getCellFont()
                 throws IOException,
                        AutomationException

Table font.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCellFont in interface ITableCharacteristics

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingTextColor

public IColor getHeadingTextColor()
                           throws IOException,
                                  AutomationException

Text color use in table window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHeadingTextColor in interface ITableCharacteristics

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellTextColor

public IColor getCellTextColor()
                        throws IOException,
                               AutomationException

Text color use in table window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCellTextColor in interface ITableCharacteristics

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexFieldCharacter

public String getIndexFieldCharacter()
                              throws IOException,
                                     AutomationException

Character placed to the right of the field name when a field is indexed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getIndexFieldCharacter in interface ITableCharacteristics

Returns:

The pIndexChar

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowIndexFieldCharacter

public boolean isShowIndexFieldCharacter()
                                  throws IOException,
                                         AutomationException

Indicates whether table window should show field index character.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isShowIndexFieldCharacter in interface ITableCharacteristics

Returns:

The pShowIndexCharacter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingFontByRef

public void setHeadingFontByRef(Font ppFont)
                         throws IOException,
                                AutomationException

Table font.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setHeadingFontByRef in interface ITableCharacteristics

Parameters:

ppFont - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellFontByRef

public void setCellFontByRef(Font ppFont)
                      throws IOException,
                             AutomationException

Table font.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setCellFontByRef in interface ITableCharacteristics

Parameters:

ppFont - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingTextColorByRef

public void setHeadingTextColorByRef(IColor ppTextColor)
                              throws IOException,
                                     AutomationException

Text color use in table window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setHeadingTextColorByRef in interface ITableCharacteristics

Parameters:

ppTextColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellTextColorByRef

public void setCellTextColorByRef(IColor ppTextColor)
                           throws IOException,
                                  AutomationException

Text color use in table window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setCellTextColorByRef in interface ITableCharacteristics

Parameters:

ppTextColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexFieldCharacter

public void setIndexFieldCharacter(String pIndexChar)
                            throws IOException,
                                   AutomationException

Character placed to the right of the field name when a field is indexed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setIndexFieldCharacter in interface ITableCharacteristics

Parameters:

pIndexChar - The pIndexChar (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowIndexFieldCharacter

public void setShowIndexFieldCharacter(boolean pShowIndexCharacter)
                                throws IOException,
                                       AutomationException

Indicates whether table window should show field index character.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setShowIndexFieldCharacter in interface ITableCharacteristics

Parameters:

pShowIndexCharacter - The pShowIndexCharacter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoValidateEdits

public boolean isAutoValidateEdits()
                            throws IOException,
                                   AutomationException

Indicates if the table window should validate any changes to the data during editing.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAutoValidateEdits in interface ITableCharacteristics

Returns:

The autoValidateEdits

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoValidateEdits

public void setAutoValidateEdits(boolean autoValidateEdits)
                          throws IOException,
                                 AutomationException

Indicates if the table window should validate any changes to the data during editing.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAutoValidateEdits in interface ITableCharacteristics

Parameters:

autoValidateEdits - The autoValidateEdits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowCodedValueDomainDescriptions

public boolean isShowCodedValueDomainDescriptions()
                                           throws IOException,
                                                  AutomationException

Indicates if the table window shows coded value domain descriptions or values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isShowCodedValueDomainDescriptions in interface ITableCharacteristics

Returns:

The showCodedValueDomainDescriptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowCodedValueDomainDescriptions

public void setShowCodedValueDomainDescriptions(boolean showCodedValueDomainDescriptions)
                                         throws IOException,
                                                AutomationException

Indicates if the table window shows coded value domain descriptions or values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setShowCodedValueDomainDescriptions in interface ITableCharacteristics

Parameters:

showCodedValueDomainDescriptions - The showCodedValueDomainDescriptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFireRowChangedEventsForJoins

public boolean isFireRowChangedEventsForJoins()
                                       throws IOException,
                                              AutomationException

Indicates if row changed events should be fires for join tables.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isFireRowChangedEventsForJoins in interface ITableCalculator

Returns:

The pFireRowEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFireRowChangedEventsForJoins

public void setFireRowChangedEventsForJoins(boolean pFireRowEvents)
                                     throws IOException,
                                            AutomationException

Indicates if row changed events should be fires for join tables.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFireRowChangedEventsForJoins in interface ITableCalculator

Parameters:

pFireRowEvents - The pFireRowEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public ITableProperty next()
                    throws IOException,
                           AutomationException

Get the next table property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

next in interface IEnumTableProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Reset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

reset in interface IEnumTableProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activeViewChanged

public void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Fired when the active view changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activeViewChanged in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapsChanged

public void mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a change is made to the map collection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

mapsChanged in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onContextMenu

public void onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
                   throws IOException,
                          AutomationException

Indicates if a context menu should be displayed at the given xy location. Return true if handled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onContextMenu in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(IDocumentEventsNewDocumentEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a new document is created.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

newDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(IDocumentEventsOpenDocumentEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when a document is opened.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

openDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

public boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws IOException,
                                   AutomationException

Fired before a document is closed. Return True to abort the close process.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

beforeCloseDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

public void closeDocument(IDocumentEventsCloseDocumentEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a document is closed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

closeDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view changes.

Remarks

The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.

The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IActiveView.contentsChanged()

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws IOException,
                      AutomationException

Fired when an item is added to the view.

Remarks

The Map fires the event every time a new layer is added.

The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an item is deleted from the view.

Remarks

The PageLayout object fires this event whenever elements are deleted from the layout.

The Map object fires this event when a layer is removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a view item is reordered.

Remarks

The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.

The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Call this function to fire the selection changed event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Description

Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.

Remarks

This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.

The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.

If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.

In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException

Fired after the specified phase is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Remarks

AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when a new map is made active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException