com.esri.arcgis.schematic
Interface INgBoundedProperty

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgBoundedPropertyProxy, NgBoundedProperty

public interface INgBoundedProperty
extends Serializable

Provides access to members that control the bounded property.

Description

A bounded property lets you specify the graphic effects matching different value ranges.

To associate graphic effects with a bounded property, the possible value ranges of the property must be specified; that is, you will have to define the bounded filters of the property (AddFilter method).

Product Availability

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

See Also:
INgDiscreteProperty, INgDirectProperty, INgTextualProperty, INgProperty, INgElementType.createProperty(String, int, int, int)

Method Summary
 INgBoundedFilter addFilter(int filterNum, String name, Object lowerBound, Object upperBound)
          Creates the filter 'filterNum' named 'name' for the property values ranging between the 'lowerBound' and 'upperBound' values.
 void deleteFilter(int filterNum)
          Deletes the bounded filter 'filterNum'.
 INgElements getElementsByFilter(INgDiagram diagram, int filterNum, int mode)
          Returns all the elements contained in the diagram 'Diagram' whose property value is equal or not equal (see esriNgFilterSelectionMode) to a value in the value range of the filter 'filterNum' defined for that same property.
 INgElementType getElementType()
          Element type the bounded property applies to.
 INgBoundedFilters getFilters()
          Collection of bounded filters defined for the bounded property.
 String getName()
          Name of the bounded property.
 void setName(String pVal)
          Name of the bounded property.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the bounded property.

Description

This name is defined when the bounded property is created:

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

- or through ArcGIS Schematics Designer, when the bounded 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 bounded 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

INgBoundedFilters getFilters()
                             throws IOException,
                                    AutomationException
Collection of bounded filters defined for the bounded property.

Product Availability

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

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

getElementsByFilter

INgElements getElementsByFilter(INgDiagram diagram,
                                int filterNum,
                                int mode)
                                throws IOException,
                                       AutomationException
Returns all the elements contained in the diagram 'Diagram' whose property value is equal or not equal (see esriNgFilterSelectionMode) to a value in the value range of the filter 'filterNum' defined for that same property.

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

INgBoundedFilter addFilter(int filterNum,
                           String name,
                           Object lowerBound,
                           Object upperBound)
                           throws IOException,
                                  AutomationException
Creates the filter 'filterNum' named 'name' for the property values ranging between the 'lowerBound' and 'upperBound' values.

Product Availability

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

Parameters:
filterNum - The filterNum (in)
name - The name (in)
lowerBound - A Variant (in)
upperBound - A Variant (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgBoundedFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgBoundedProperty.deleteFilter(int)

deleteFilter

void deleteFilter(int filterNum)
                  throws IOException,
                         AutomationException
Deletes the bounded 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:
INgBoundedProperty.addFilter(int, String, java.lang.Object, java.lang.Object)

getElementType

INgElementType getElementType()
                              throws IOException,
                                     AutomationException
Element type the bounded 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.