com.esri.arcgis.arcmapui
Class TableProperty

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

All Implemented Interfaces:

ITableProperty, ITableProperty2, ITableProperty3, ITableCharacteristics, ITableSelectionColor, ITableViewInfo, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class TableProperty
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITableProperty, ITableProperty2, ITableProperty3, ITableSelectionColor, ITableCharacteristics, IClone, IPersist, IPersistStream, Externalizable

Table window property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

TableProperty()
Constructs a TableProperty using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
Font	getCellFont() Table font.
IColor	getCellTextColor() Text color use in table window.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IFeatureLayer	getFeatureLayer() Feature class of table window (Overrides table setting).
String	getFieldOrder() Order of fields.
int	getFieldWidth(String fieldName) Field Width.
int	getFrozenFields() Number of frozen fields.
Font	getHeadingFont() Table font.
IColor	getHeadingTextColor() Text color use in table window.
String	getIndexFieldCharacter() Character placed to the right of the field name when a field is indexed.
ILayer	getLayer() Layer for table window (Overrides table and featurelayer setting).
IColor	getSelectedTableSelectionColor() Selection color use to highlight rows in the the selected tables and graphics.
IColor	getSelectionColor() Selection color use to highlight rows and graphics.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IStandaloneTable	getStandaloneTable() StandaloneTable for table window (Overrides table and layer setting).
ITable	getTable() Table of table window (Overrides feature class setting).
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	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSelectedTable() Indicates if the Selected table is shown.
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	load(IStream pstm) load
void	putPosition(int x1, int y1, int x2, int y2) Table window position.
void	queryPosition(int[] pX1, int[] pY1, int[] pX2, int[] pY2) Query table window position.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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	setFeatureLayerByRef(IFeatureLayer ppFeatureLayer) Feature class of table window (Overrides table setting).
void	setFieldOrder(String pFieldList) Order of fields.
void	setFieldWidth(String fieldName, int pFieldWidth) Field Width.
void	setFrozenFields(int pNumberOfFields) Number of frozen fields.
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	setLayerByRef(ILayer ppLayer) Layer for table window (Overrides table and featurelayer setting).
void	setSelectedTable(boolean pShowSelectedTable) Indicates if the Selected table is shown.
void	setSelectedTableSelectionColorByRef(IColor ppSelectionColor) Selection color use to highlight rows in the the selected tables and graphics.
void	setSelectionColorByRef(IColor ppSelectionColor) Selection color use to highlight rows and graphics.
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	setStandaloneTableByRef(IStandaloneTable ppStandaloneTable) StandaloneTable for table window (Overrides table and layer setting).
void	setTableByRef(ITable ppTable) Table of table window (Overrides feature class setting).
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

TableProperty

public TableProperty()
              throws IOException,
                     UnknownHostException

Constructs a TableProperty using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TableProperty

public TableProperty(Object obj)
              throws IOException

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

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

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

setSelectedTable

public void setSelectedTable(boolean pShowSelectedTable)
                      throws IOException,
                             AutomationException

Indicates if the Selected table is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSelectedTable in interface ITableProperty

Specified by:

setSelectedTable in interface ITableProperty2

Specified by:

setSelectedTable in interface ITableProperty3

Parameters:

pShowSelectedTable - The pShowSelectedTable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSelectedTable

public boolean isSelectedTable()
                        throws IOException,
                               AutomationException

Indicates if the Selected table is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isSelectedTable in interface ITableProperty

Specified by:

isSelectedTable in interface ITableProperty2

Specified by:

isSelectedTable in interface ITableProperty3

Returns:

The pShowSelectedTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITable ppTable)
                   throws IOException,
                          AutomationException

Table of table window (Overrides feature class setting).

Product Availability

Available with ArcGIS Desktop.

Specified by:

setTableByRef in interface ITableProperty

Specified by:

setTableByRef in interface ITableProperty2

Parameters:

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException

Table of table window (Overrides feature class setting).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTable in interface ITableProperty

Specified by:

getTable in interface ITableProperty2

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

public void setFeatureLayerByRef(IFeatureLayer ppFeatureLayer)
                          throws IOException,
                                 AutomationException

Feature class of table window (Overrides table setting).

Product Availability

Available with ArcGIS Desktop.

Specified by:

setFeatureLayerByRef in interface ITableProperty

Specified by:

setFeatureLayerByRef in interface ITableProperty2

Parameters:

ppFeatureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureLayer

public IFeatureLayer getFeatureLayer()
                              throws IOException,
                                     AutomationException

Feature class of table window (Overrides table setting).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFeatureLayer in interface ITableProperty

Specified by:

getFeatureLayer in interface ITableProperty2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPosition

public void putPosition(int x1,
                        int y1,
                        int x2,
                        int y2)
                 throws IOException,
                        AutomationException

Table window position.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

putPosition in interface ITableViewInfo

Parameters:

x1 - The x1 (in)

y1 - The y1 (in)

x2 - The x2 (in)

y2 - The y2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPosition

public void queryPosition(int[] pX1,
                          int[] pY1,
                          int[] pX2,
                          int[] pY2)
                   throws IOException,
                          AutomationException

Query table window position.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryPosition in interface ITableViewInfo

Parameters:

pX1 - The pX1 (out: use single element array)

pY1 - The pY1 (out: use single element array)

pX2 - The pX2 (out: use single element array)

pY2 - The pY2 (out: use single element array)

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 and graphics.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectionColor in interface ITableSelectionColor

Specified by:

getSelectionColor in interface ITableViewInfo

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 and graphics.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSelectionColorByRef in interface ITableSelectionColor

Specified by:

setSelectionColorByRef in interface ITableViewInfo

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.

setFieldOrder

public void setFieldOrder(String pFieldList)
                   throws IOException,
                          AutomationException

Order of fields.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFieldOrder in interface ITableViewInfo

Parameters:

pFieldList - The pFieldList (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldOrder

public String getFieldOrder()
                     throws IOException,
                            AutomationException

Order of fields.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFieldOrder in interface ITableViewInfo

Returns:

The pFieldList

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldWidth

public void setFieldWidth(String fieldName,
                          int pFieldWidth)
                   throws IOException,
                          AutomationException

Field Width.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setFieldWidth in interface ITableViewInfo

Parameters:

fieldName - The fieldName (in)

pFieldWidth - The pFieldWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldWidth

public int getFieldWidth(String fieldName)
                  throws IOException,
                         AutomationException

Field Width.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getFieldWidth in interface ITableViewInfo

Parameters:

fieldName - The fieldName (in)

Returns:

The pFieldWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFrozenFields

public void setFrozenFields(int pNumberOfFields)
                     throws IOException,
                            AutomationException

Number of frozen fields.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFrozenFields in interface ITableViewInfo

Parameters:

pNumberOfFields - The pNumberOfFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFrozenFields

public int getFrozenFields()
                    throws IOException,
                           AutomationException

Number of frozen fields.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFrozenFields in interface ITableViewInfo

Returns:

The pNumberOfFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer ppLayer)
                   throws IOException,
                          AutomationException

Layer for table window (Overrides table and featurelayer setting).

Product Availability

Available with ArcGIS Desktop.

Specified by:

setLayerByRef in interface ITableProperty2

Specified by:

setLayerByRef in interface ITableProperty3

Parameters:

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

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException

Layer for table window (Overrides table and featurelayer setting).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLayer in interface ITableProperty2

Specified by:

getLayer in interface ITableProperty3

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.

setStandaloneTableByRef

public void setStandaloneTableByRef(IStandaloneTable ppStandaloneTable)
                             throws IOException,
                                    AutomationException

StandaloneTable for table window (Overrides table and layer setting).

Product Availability

Available with ArcGIS Desktop.

Specified by:

setStandaloneTableByRef in interface ITableProperty3

Parameters:

ppStandaloneTable - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

public IStandaloneTable getStandaloneTable()
                                    throws IOException,
                                           AutomationException

StandaloneTable for table window (Overrides table and layer setting).

Product Availability

Available with ArcGIS Desktop.

Specified by:

getStandaloneTable in interface ITableProperty3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedTableSelectionColor

public IColor getSelectedTableSelectionColor()
                                      throws IOException,
                                             AutomationException

Selection color use to highlight rows in the the selected tables and graphics.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectedTableSelectionColor in interface ITableSelectionColor

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.

setSelectedTableSelectionColorByRef

public void setSelectedTableSelectionColorByRef(IColor ppSelectionColor)
                                         throws IOException,
                                                AutomationException

Selection color use to highlight rows in the the selected tables and graphics.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSelectedTableSelectionColorByRef in interface ITableSelectionColor

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.

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.

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