com.esri.arcgis.carto
Interface IDimensionStyles

All Superinterfaces:
Serializable
All Known Implementing Classes:
DimensionStyles

public interface IDimensionStyles
extends Serializable

Provides access to members that control a collection of dimension styles for a dimension feature class.

Description

The IDimensionStyles interface provides methods and properties for managing DimensionStyle objects.

Remarks

In order to add a new DimensionStyle object, create a new DimensionStyle, modifying it, and call the Add method. When a style is added, a StyleID is automatically assigned to that Style. The DefaultStyleID property specifies which style should be used by default in ArcMap. DimensionStyle objects can be retrieved by ID or name using the GetStyle and FindStyle methods. Existing DimensionStyle objects can be renamed using the Rename method. Styles can only be deleted and not modified. If a DimensionStyle is deleted, it is important to reassign a new DimensionStyle to existing dimension features that reference the deleted style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addStyle(IDimensionStyle style)
          Adds a style to the collection.
 void deleteStyle(int iD)
          Deletes a dimension style.
 IDimensionStyle findStyle(String name)
          Find a dimension style by name.
 int getDefaultStyleID()
          The ID of the defualt dimension style.
 IDimensionStyle getStyle(int iD)
          A dimension style.
 IEnumDimensionStyle getStyles()
          All the dimension styles in the collection.
 void renameStyle(int iD, String name)
          Renames a dimension style.
 void setDefaultStyleID(int iD)
          The ID of the defualt dimension style.
 

Method Detail

addStyle

void addStyle(IDimensionStyle style)
              throws IOException,
                     AutomationException
Adds a style to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getStyle

IDimensionStyle getStyle(int iD)
                         throws IOException,
                                AutomationException
A dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

findStyle

IDimensionStyle findStyle(String name)
                          throws IOException,
                                 AutomationException
Find a dimension style by name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getStyles

IEnumDimensionStyle getStyles()
                              throws IOException,
                                     AutomationException
All the dimension styles in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultStyleID

int getDefaultStyleID()
                      throws IOException,
                             AutomationException
The ID of the defualt dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultStyleID

void setDefaultStyleID(int iD)
                       throws IOException,
                              AutomationException
The ID of the defualt dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deleteStyle

void deleteStyle(int iD)
                 throws IOException,
                        AutomationException
Deletes a dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

renameStyle

void renameStyle(int iD,
                 String name)
                 throws IOException,
                        AutomationException
Renames a dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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