com.esri.arcgis.arcmapui
Interface IMetadataViewWindow

All Superinterfaces:
Serializable
All Known Subinterfaces:
IMetadataViewWindow2
All Known Implementing Classes:
MetadataViewWindow

public interface IMetadataViewWindow
extends Serializable

Provides access to members setting the Metadata View Window.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 IMetadataViewWindow findViaLayer(ILayer pLayer)
          Is Metadata (of a layer's data source) already being displayed.
 IMetadataViewWindow findViaStandaloneTable(IStandaloneTable pStandaloneTable)
          Is Metadata (of a standalone table) already being displayed.
 int getHWnd()
          HWND of the Metadata View Window.
 ILayer getLayer()
          The stored layer.
 IPropertySet getMetadata()
          The Metadata of the selected layer's data source.
 IMetadataHelper getMetadataHelper()
          The Metadata helper to get stylesheet path and metadata.
 String getSelectedStylesheet()
          Selected Stylesheet from Metadata helper.
 IStandaloneTable getStandaloneTable()
          The standalone table to view/edit.
 String getStylesheetPath()
          Stylesheet path from Metadata helper.
 void refresh()
          Refresh the metadata view.
 void setApplicationByRef(Object rhs1)
          Provides the window with a reference to the application.
 void setDataSourceByRef(IDatasetName rhs1)
          Pass the data source name of the selected layer to Metadata View window.
 void setLayerByRef(ILayer pLayer)
          The stored layer.
 void setStandaloneTableByRef(IStandaloneTable table)
          The standalone table to view/edit.
 void show(boolean show)
          Show MetadataViewWindow of the selected layer's data source.
 

Method Detail

setApplicationByRef

void setApplicationByRef(Object rhs1)
                         throws IOException,
                                AutomationException
Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Parameters:
rhs1 - A reference to another Automation Object (IDispatch) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer()
                throws IOException,
                       AutomationException
The stored layer.

Product Availability

Available with ArcGIS Desktop.

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.

setLayerByRef

void setLayerByRef(ILayer pLayer)
                   throws IOException,
                          AutomationException
The stored layer.

Product Availability

Available with ArcGIS Desktop.

Parameters:
pLayer - 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.

setStandaloneTableByRef

void setStandaloneTableByRef(IStandaloneTable table)
                             throws IOException,
                                    AutomationException
The standalone table to view/edit.

Product Availability

Available with ArcGIS Desktop.

Parameters:
table - 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

IStandaloneTable getStandaloneTable()
                                    throws IOException,
                                           AutomationException
The standalone table to view/edit.

Product Availability

Available with ArcGIS Desktop.

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.

setDataSourceByRef

void setDataSourceByRef(IDatasetName rhs1)
                        throws IOException,
                               AutomationException
Pass the data source name of the selected layer to Metadata View window.

Product Availability

Available with ArcGIS Desktop.

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findViaLayer

IMetadataViewWindow findViaLayer(ILayer pLayer)
                                 throws IOException,
                                        AutomationException
Is Metadata (of a layer's data source) already being displayed.

Product Availability

Available with ArcGIS Desktop.

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A reference to a com.esri.arcgis.arcmapui.IMetadataViewWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findViaStandaloneTable

IMetadataViewWindow findViaStandaloneTable(IStandaloneTable pStandaloneTable)
                                           throws IOException,
                                                  AutomationException
Is Metadata (of a standalone table) already being displayed.

Product Availability

Available with ArcGIS Desktop.

Parameters:
pStandaloneTable - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Returns:
A reference to a com.esri.arcgis.arcmapui.IMetadataViewWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException
HWND of the Metadata View 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.

getStylesheetPath

String getStylesheetPath()
                         throws IOException,
                                AutomationException
Stylesheet path from Metadata helper.

Product Availability

Available with ArcGIS Desktop.

Returns:
The pStylesheetPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedStylesheet

String getSelectedStylesheet()
                             throws IOException,
                                    AutomationException
Selected Stylesheet from Metadata helper.

Product Availability

Available with ArcGIS Desktop.

Returns:
The pSelectedStylesheet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

IPropertySet getMetadata()
                         throws IOException,
                                AutomationException
The Metadata of the selected layer's data source.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadataHelper

IMetadataHelper getMetadataHelper()
                                  throws IOException,
                                         AutomationException
The Metadata helper to get stylesheet path and metadata.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.catalogUI.IMetadataHelper
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

show

void show(boolean show)
          throws IOException,
                 AutomationException
Show MetadataViewWindow of the selected layer's data source.

Product Availability

Available with ArcGIS Desktop.

Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException
Refresh the metadata view.

Product Availability

Available with ArcGIS Desktop.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.