com.esri.arcgis.globecore
Interface IKmlNode

All Superinterfaces:

Serializable

All Known Implementing Classes:

IKmlNodeProxy

public interface IKmlNode
extends Serializable

Properties of a of KML Node.

Product Availability

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

Method Summary

String	getDescription() Kml Node description.
String	getName() Kml Node name.
String	getSnippet() Kml Node Snippet.
boolean	isHasDescription() Does Kml Node have a description.
boolean	isHasName() Does Kml Node have a name.
boolean	isHasSnippet() Does Kml Node have a snippet.
boolean	isVisible() Is the Kml node is visible.
void	setVisible(boolean visible) Is the Kml node is visible.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Kml Node name.

Description

This property returns the name of the KML Node as a string

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnippet

String getSnippet()
                  throws IOException,
                         AutomationException

Kml Node Snippet.

Description

Snippet is a smaller description of the KML Node. This property returns the Snippet of the KML Node as a string

Product Availability

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

Returns:

The snippet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Kml Node description.

Description

This property would return any description (plain text or HTML) in the KML file. In a KML file the "<Description>" tag is used to store descriptive information.

Product Availability

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

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Is the Kml node is visible.

Description

This property returns a boolean value (true/false) indicating if the Node is visible or not.

If the visibility of a Node is changed it should be followed by a call to IKmlLayer.RefreshVisibleNodes in order for the change to be reflected on the display. Please see help for IKmlLayer.RefreshVisibleNodes for more information.

Product Availability

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

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Is the Kml node is visible.

Description

Use this property to set the visibility of the Node. The property takes in a boolean (true/false) as an argument.

If the visibility of a Node is changed it should be followed by a call to IKmlLayer.RefreshVisibleNodes in order for the change to be reflected on the display. Please see help for IKmlLayer.RefreshVisibleNodes for more information.

Product Availability

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

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasName

boolean isHasName()
                  throws IOException,
                         AutomationException

Does Kml Node have a name.

Description

This property returns a boolean value (true/false) indicating if the Node has a Name or not.

Product Availability

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

Returns:

The pHasName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasSnippet

boolean isHasSnippet()
                     throws IOException,
                            AutomationException

Does Kml Node have a snippet.

Description

This property returns a boolean value (true/false) indicating if the Node has a Snippet or not.

Product Availability

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

Returns:

The pHasSnippet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasDescription

boolean isHasDescription()
                         throws IOException,
                                AutomationException

Does Kml Node have a description.

Description

This property returns a boolean value (true/false) indicating if the Node has a Description or not.

Product Availability

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

Returns:

The pHasDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.