com.esri.arcgis.geoprocessing
Interface IMdDisplayNode

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMdDisplayNodeProxy

public interface IMdDisplayNode
extends Serializable

Provides access to properties/methods of a model display node.

Product Availability

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

Method Summary

int	getBackgroundColor() The background color of the display node object.
int	getHeight() The height of the display node object.
int	getOutlineColor() The outline color of the display node object.
int	getOutlineWidth() The outline width of the display node object.
int	getShape() The shape type of the display node object.
int	getTextColor() The text color of the display node object.
IFont	getTextFont() The text font of the display node object.
int	getWidth() The width of the display node object.
boolean	isShowShadow() Indicates whether or not to display a shadow for the node.
void	setBackgroundColor(int pColor) The background color of the display node object.
void	setHeight(int pHeight) The height of the display node object.
void	setOutlineColor(int pColor) The outline color of the display node object.
void	setOutlineWidth(int pWidth) The outline width of the display node object.
void	setShape(int pShape) The shape type of the display node object.
void	setShowShadow(boolean pShowShadow) Indicates whether or not to display a shadow for the node.
void	setTextColor(int pColor) The text color of the display node object.
void	setTextFontByRef(IFont ppFont) The text font of the display node object.
void	setWidth(int pWidth) The width of the display node object.

Method Detail

getShape

int getShape()
             throws IOException,
                    AutomationException

The shape type of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

A com.esri.arcgis.geoprocessing.esriModelDiagramNodeShape constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShape

void setShape(int pShape)
              throws IOException,
                     AutomationException

The shape type of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pShape - A com.esri.arcgis.geoprocessing.esriModelDiagramNodeShape constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException

The height of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

The pHeight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(int pHeight)
               throws IOException,
                      AutomationException

The height of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pHeight - The pHeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The width of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int pWidth)
              throws IOException,
                     AutomationException

The width of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pWidth - The pWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextFont

IFont getTextFont()
                  throws IOException,
                         AutomationException

The text font of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IFont

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextFontByRef

void setTextFontByRef(IFont ppFont)
                      throws IOException,
                             AutomationException

The text font of the display node object.

Product Availability

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

Parameters:

ppFont - A reference to a com.esri.arcgis.support.ms.stdole.IFont (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextColor

int getTextColor()
                 throws IOException,
                        AutomationException

The text color of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

The pColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextColor

void setTextColor(int pColor)
                  throws IOException,
                         AutomationException

The text color of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pColor - The pColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

int getBackgroundColor()
                       throws IOException,
                              AutomationException

The background color of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

The pColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(int pColor)
                        throws IOException,
                               AutomationException

The background color of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pColor - The pColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutlineColor

int getOutlineColor()
                    throws IOException,
                           AutomationException

The outline color of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

The pColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutlineColor

void setOutlineColor(int pColor)
                     throws IOException,
                            AutomationException

The outline color of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pColor - The pColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutlineWidth

int getOutlineWidth()
                    throws IOException,
                           AutomationException

The outline width of the display node object.

Product Availability

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

Supported Platforms

Windows

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutlineWidth

void setOutlineWidth(int pWidth)
                     throws IOException,
                            AutomationException

The outline width of the display node object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pWidth - The pWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowShadow

boolean isShowShadow()
                     throws IOException,
                            AutomationException

Indicates whether or not to display a shadow for the node.

Product Availability

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

Supported Platforms

Windows

Returns:

The pShowShadow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowShadow

void setShowShadow(boolean pShowShadow)
                   throws IOException,
                          AutomationException

Indicates whether or not to display a shadow for the node.

Product Availability

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

Supported Platforms

Windows

Parameters:

pShowShadow - The pShowShadow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.