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

	Name	Description
	AbsoluteParameters	Indicates if the values set for the spacing and dimension parameters must be interpreted as absolute units.
	AlgorithmCLSID	The CLSID of the algorithm.
	Available	Indicates if the algorithm is currently available.
	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.
	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.
	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.
	Enabled	Indicates if the algorithm is currently enabled.
	Execute	Execute the schematic algorithm.
	Height	Height of the main ring.
	Label	The label of the algorithm.
	Length	Width of the main ring.
	LockLinks	Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.
	MainRingType	Main Ring form type.
	Overridable	Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
	PropertySet	The property set of the algorithm contains a collection of its parameters and their values.
	SchematicDiagramClassName	The diagram class object used to initialize the algorithm.
	TreeType	Hierarchical trees layout type.
	UseEndNode	Indicates if the algorithm use end nodes.
	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.