ArcObjects Library Reference (Schematic)  

ISchematicAlgoMainRing Interface

Provides access to members that control the Main Ring schematic algorithm.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.

Description

The Main Ring algorithm arranges the schematic nodes and links in a diagram around the main ring and lays out the schematic nodes and links that connect to the detected main ring nodes. The main ring is the loop formed by the largest number of links in the schematic diagram.

Members

Description
Read/write property AbsoluteParameters Indicates if the values set for the spacing and dimension parameters must be interpreted as absolute units.
Read-only property AlgorithmCLSID The CLSID of the algorithm.
Read/write property Available Indicates if the algorithm is currently available.
Read/write property BreakPoint Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
Read/write property DistanceAlongTheDirection Spacing between the nodes that display along the tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
Read/write property DistancePerpendicularToDirection Spacing between the nodes that display perpendicularly to the tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
Read-only property Enabled Indicates if the algorithm is currently enabled.
Method Execute Execute the schematic algorithm.
Read/write property Height Height of the main ring.
Read/write property Label The label of the algorithm.
Read/write property Length Width of the main ring.
Read/write property LockLinks Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.
Read/write property MainRingType Main Ring form type.
Read/write property Overridable Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
Read/write property PropertySet The property set of the algorithm contains a collection of its parameters and their values.
Read/write property SchematicDiagramClassName The diagram class object used to initialize the algorithm.
Read/write property TreeType Hierarchical trees layout type.
Read-only property UseEndNode Indicates if the algorithm use end nodes.
Read-only property UseRootNode Indicates if the algorithm use root nodes.

Inherited Interfaces

Interfaces Description
ISchematicAlgorithm Provides access to members that control the schematic algorithm.

CoClasses that implement ISchematicAlgoMainRing

CoClasses and Classes Description
SchematicAlgoMainRing Main Ring schematic algorithm object.