com.esri.arcgis.schematic
Interface INgDiscreteProperty

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgDiscretePropertyProxy, NgDiscreteProperty

public interface INgDiscreteProperty
extends Serializable

Provides access to members that control the discrete property.

Description

A discrete property lets you specify the graphic effects matching a final list of values for the property.

To associate graphic effects with a discrete property, the possible finite set of numbers or alphanumeric code of the property must be specified; that is, you will have to define the discrete filters of the property (AddFilter method).

Product Availability

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

See Also:

INgDirectProperty, INgTextualProperty, INgBoundedProperty, INgProperty, INgElementType.createProperty(String, int, int, int)

Method Summary

INgDiscreteFilter	addFilter(int filterNum, String name, Object value) Creates the filter 'filterNum' named 'name' for the property value 'value'.
void	deleteFilter(int filterNum) Deletes the discrete filter 'filterNum'.
INgElements	getElementsByFilter(INgDiagram diagram, int filterNum, int mode) Returns all the elements contained in the diagram 'Diagram' that match the 'filternum' discrete filter (mode=esriNgFilterEqual) or that do not match the 'filterNum' discrete filter (mode = esriNgFilterDifferent) (see esriNgFilterSelectionMode).
INgElementType	getElementType() Element type the discrete property applies to.
INgDiscreteFilters	getFilters() Collection of the discrete filters defined for the discrete property.
String	getName() Name of the discrete property.
void	setName(String pVal) Name of the discrete property.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the discrete property.

Description

This name is defined when the discrete property is created:

- either by calling the INgElementType CreateProperty method in the program code,

- or through ArcGIS Schematics Designer, when the discrete property has been created.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the discrete property.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilters

INgDiscreteFilters getFilters()
                              throws IOException,
                                     AutomationException

Collection of the discrete filters defined for the discrete property.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgDiscreteFilters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.addFilter(int, String, java.lang.Object)

getElementsByFilter

INgElements getElementsByFilter(INgDiagram diagram,
                                int filterNum,
                                int mode)
                                throws IOException,
                                       AutomationException

Returns all the elements contained in the diagram 'Diagram' that match the 'filternum' discrete filter (mode=esriNgFilterEqual) or that do not match the 'filterNum' discrete filter (mode = esriNgFilterDifferent) (see esriNgFilterSelectionMode).

Product Availability

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

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.INgDiagram (in)

filterNum - The filterNum (in)

mode - A com.esri.arcgis.schematic.esriNgFilterSelectionMode constant (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgElements

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFilter

INgDiscreteFilter addFilter(int filterNum,
                            String name,
                            Object value)
                            throws IOException,
                                   AutomationException

Creates the filter 'filterNum' named 'name' for the property value 'value'.

Product Availability

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

Parameters:

filterNum - The filterNum (in)

name - The name (in)

value - A Variant (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgDiscreteFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.getFilters(), INgDiscreteProperty.deleteFilter(int)

deleteFilter

void deleteFilter(int filterNum)
                  throws IOException,
                         AutomationException

Deletes the discrete filter 'filterNum'.

Product Availability

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

Parameters:

filterNum - The filterNum (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.addFilter(int, String, java.lang.Object)

getElementType

INgElementType getElementType()
                              throws IOException,
                                     AutomationException

Element type the discrete property applies to.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgElementType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.