com.esri.arcgis.catalogUI
Interface IDescriptionWindow

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DescriptionWindow, IDescriptionWindowProxy

public interface IDescriptionWindow
extends java.io.Serializable

COM Interface 'IDescriptionWindow'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description: 'Provides access to members of Item Descrition Window.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID65f86c2e_40e4_4135_8ebc_364a0ef7e9ae
static int	xxDummy Deprecated. Internal use only

Method Summary

IDescriptionWindow	findViaItemInfo(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(java.lang.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.
IItemInfo	getTargetItemInfo() Pass the target ItemInfo to item description window.
IGxObject	getTargetObject() Pass the editing target object to item description window.
java.lang.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(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(java.lang.String path) Pass the editing target path to item description window.
void	show(boolean rePosition) Show tem Description Window of select object.

Field Detail

IID65f86c2e_40e4_4135_8ebc_364a0ef7e9ae

static final int IID65f86c2e_40e4_4135_8ebc_364a0ef7e9ae

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setApplicationByRef

void setApplicationByRef(IApplication rhs1)
                         throws java.io.IOException,
                                AutomationException

Provides the window with a reference to the application.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetObjectByRef

void setTargetObjectByRef(IGxObject ppGxObject)
                          throws java.io.IOException,
                                 AutomationException

Pass the editing target object to item description window.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetObject

IGxObject getTargetObject()
                          throws java.io.IOException,
                                 AutomationException

Pass the editing target object to item description window.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetPath

void setTargetPath(java.lang.String path)
                   throws java.io.IOException,
                          AutomationException

Pass the editing target path to item description window.

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetPath

java.lang.String getTargetPath()
                               throws java.io.IOException,
                                      AutomationException

Pass the editing target path to item description window.

Returns:

The path

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetItemInfoByRef

void setTargetItemInfoByRef(IItemInfo ppItemInfo)
                            throws java.io.IOException,
                                   AutomationException

Pass the target ItemInfo to item description window.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetItemInfo

IItemInfo getTargetItemInfo()
                            throws java.io.IOException,
                                   AutomationException

Pass the target ItemInfo to item description window.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaItemInfo

IDescriptionWindow findViaItemInfo(IItemInfo pItemInfo)
                                   throws java.io.IOException,
                                          AutomationException

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

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaPath

IDescriptionWindow findViaPath(java.lang.String path)
                               throws java.io.IOException,
                                      AutomationException

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

Parameters:

path - The path (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaObject

IDescriptionWindow findViaObject(IGxObject pGxObject)
                                 throws java.io.IOException,
                                        AutomationException

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

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException

HWND of the Item Description Window.

Returns:

The hWnd (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show(boolean rePosition)
          throws java.io.IOException,
                 AutomationException

Show tem Description Window of select object.

Parameters:

rePosition - The rePosition (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws java.io.IOException,
                    AutomationException

Refresh the Item Description Window.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentationView

IGxDocumentationView getDocumentationView()
                                          throws java.io.IOException,
                                                 AutomationException

The documentation view in item description window.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.