com.esri.arcgis.catalogUI
Interface IDescriptionWindow

All Superinterfaces:

Serializable

All Known Implementing Classes:

DescriptionWindow

public interface IDescriptionWindow
extends Serializable

Provides access to members of Item Descrition Window.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IDescriptionWindow	findViaItemInfo(com.esri.arcgis.search.IItemInfo pItemInfo) Indicates whether the Item Description Window is already being displayed for the selected ItemInfo.
IDescriptionWindow	findViaObject(IGxObject pGxObject) Indicates whether the Item Description Window is already being displayed for the selected GxObject.
IDescriptionWindow	findViaPath(String path) Indicates whether the Item Description Window is already being displayed for the selected path.
IGxDocumentationView	getDocumentationView() The documentation view in item description window.
int	getHWnd() HWND of the Item Description Window.
com.esri.arcgis.search.IItemInfo	getTargetItemInfo() Pass the target ItemInfo to item description window.
IGxObject	getTargetObject() Pass the editing target object to item description window.
String	getTargetPath() Pass the editing target path to item description window.
void	refresh() Refresh the Item Description Window.
void	setApplicationByRef(IApplication rhs1) Provides the window with a reference to the application.
void	setTargetItemInfoByRef(com.esri.arcgis.search.IItemInfo ppItemInfo) Pass the target ItemInfo to item description window.
void	setTargetObjectByRef(IGxObject ppGxObject) Pass the editing target object to item description window.
void	setTargetPath(String path) Pass the editing target path to item description window.
void	show(boolean rePosition) Show tem Description Window of select object.

Method Detail

setApplicationByRef

void setApplicationByRef(IApplication rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - A reference to a com.esri.arcgis.framework.IApplication (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetObjectByRef

void setTargetObjectByRef(IGxObject ppGxObject)
                          throws IOException,
                                 AutomationException

Pass the editing target object to item description window.

Product Availability

Available with ArcGIS Desktop.

Parameters:

ppGxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetObject

IGxObject getTargetObject()
                          throws IOException,
                                 AutomationException

Pass the editing target object to item description window.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetPath

void setTargetPath(String path)
                   throws IOException,
                          AutomationException

Pass the editing target path to item description window.

Product Availability

Available with ArcGIS Desktop.

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetPath

String getTargetPath()
                     throws IOException,
                            AutomationException

Pass the editing target path to item description window.

Product Availability

Available with ArcGIS Desktop.

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetItemInfoByRef

void setTargetItemInfoByRef(com.esri.arcgis.search.IItemInfo ppItemInfo)
                            throws IOException,
                                   AutomationException

Pass the target ItemInfo to item description window.

Product Availability

Available with ArcGIS Desktop.

Parameters:

ppItemInfo - A reference to a com.esri.arcgis.search.IItemInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetItemInfo

com.esri.arcgis.search.IItemInfo getTargetItemInfo()
                                                   throws IOException,
                                                          AutomationException

Pass the target ItemInfo to item description window.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.search.IItemInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaItemInfo

IDescriptionWindow findViaItemInfo(com.esri.arcgis.search.IItemInfo pItemInfo)
                                   throws IOException,
                                          AutomationException

Indicates whether the Item Description Window is already being displayed for the selected ItemInfo.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pItemInfo - A reference to a com.esri.arcgis.search.IItemInfo (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaPath

IDescriptionWindow findViaPath(String path)
                               throws IOException,
                                      AutomationException

Indicates whether the Item Description Window is already being displayed for the selected path.

Product Availability

Available with ArcGIS Desktop.

Parameters:

path - The path (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaObject

IDescriptionWindow findViaObject(IGxObject pGxObject)
                                 throws IOException,
                                        AutomationException

Indicates whether the Item Description Window is already being displayed for the selected GxObject.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pGxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException

HWND of the Item Description Window.

Product Availability

Available with ArcGIS Desktop.

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show(boolean rePosition)
          throws IOException,
                 AutomationException

Show tem Description Window of select object.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rePosition - The rePosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Refresh the Item Description Window.

Product Availability

Available with ArcGIS Desktop.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentationView

IGxDocumentationView getDocumentationView()
                                          throws IOException,
                                                 AutomationException

The documentation view in item description window.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.catalogUI.IGxDocumentationView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.