This document is archived and information here might be outdated.  Recommended version.


SchematicControls

SchematicControls


Supported with:
  • Engine with Schematics
  • ArcGIS for Desktop Basic with Schematics
  • ArcGIS for Desktop Standard with Schematics
  • ArcGIS for Desktop Advanced with Schematics
Library dependencies: Version, System, SystemUI, Geometry, GraphicsCore, Display, Server, Output, Geodatabase, GISClient, DataSourcesFile, DataSourcesGDB, DataSourcesOleDB, DataSourcesRaster, DataSourcesNetCDF, GeoDatabaseDistributed, GeoDatabaseExtensions, Carto, NetworkAnalysis, Location, GeoAnalyst, Animation, Maplex, Geoprocessing, NetworkAnalyst, Schematic

Additional library information: Contents, Object Model Diagram

The SchematicControls library contains the schematic control commands, which are a set of commands that works with the ArcGIS Engine controls and that enable you to build Schematic applications.
The SchematicControls library also contains schematic interfaces common to the SchematicUI library (such as ISchematicTarget).

See the following sections for more information about this namespace:

Schematic commands

Schematic commands work with ArcGIS Engine controls to perform specific schematic actions. They are typically used in conjunction with the ToolbarControl framework and can be hosted on a ToolbarControl, ToolbarMenu, or ToolbarPalette.
The Schematics extension license is required to work with these commands.
Approximately 22 schematic controls and commands are provided, which can be grouped into five categories. These controls and categories are described as follows:
  • General schematic commands
    • ControlsSchematicEditTargetControl—Selects the schematic diagram target.
    • ControlsSchematicCreateDiagramCommand—Generates a new schematic diagram.
    • ControlsSchematicUpdateDiagramCommand—Updates the schematic diagram target.
    • ControlsSchematicSaveAsDiagramCommand—Saves the schematic diagram target under another name.
  • Commands to manage the editing session on a schematic diagram
    • ControlsSchematicSaveEditsCommand—Saves the edits on the schematic diagram target.
    • ControlsSchematicStartEditCommand—Starts editing the schematic diagram target.
    • ControlsSchematicStopEditCommand—Stops the edits on the schematic diagram target.
  • Commands to edit the schematic diagram content and lay it out
    • ControlsSchematicMoveElementTool—Edits and moves the schematic elements tool.
    • ControlsSchematicRemoveLinkPointsCommand—Removes link points (vertices) along schematic links.
    • ControlsSchematicSquareLinksCommand—Squares the schematic links.
    • ControlsSchematicSelectEndTool—Sets the schematic end node tool.
    • ControlsSchematicSelectRootTool—Sets the schematic root node tool.
    • ControlSchematicLayoutPropertiesCommand—Shows the selected schematic layout algorithm properties form.
    • ControlsSchematicLayoutToolControl—Selects the schematic layout algorithm to apply.
    • ControlsSchematicLayoutExecuteCommand—Applies the selected schematic layout algorithm to the target schematic diagram.
  • Commands to manage the layer properties of the schematic diagrams
    • ControlsSchematicImportLayerPropertiesCommand—Imports layer properties from a file.
    • ControlsSchematicPropagateLayerPropertiesCommand—Propagates layer properties to all diagrams of the same template.
    • ControlsSchematicRestoreDefaultLayerPropertiesCommand—Restores the default layer properties.
  • Commands to manage label and symbol size
    • ControlsSchematicDecreaseLabelSizeCommand—Decreases the label size.
    • ControlsSchematicDecreaseSymbolSizeCommand—Decreases the symbol size.
    • ControlsSchematicIncreaseLabelSizeCommand—Increases the label size.
    • ControlsSchematicIncreaseSymbolSizeCommand—Increases the symbol size.

For further information see:

Sample: Schematics Engine application

Interfaces

The following interfaces common to the SchematicUI library are defined in this library:
  • ISchematicBuilderUI—Controls the Schematic Builder user interface (UI). This interface is only needed when developing a new builder.
  • ISchematicCreateDiagramDialog—Controls the dialog boxes that open when a user generates a new schematic diagram. This interface is only needed when developing a new graphical user interface (GUI) for creating diagrams.
  • ISchematicDisplayDiagramHelper—Helps to display a schematic diagram.
  • ISchematicLayoutMgr—Controls the schematic layout algorithms drop-down list.
  • ISchematicNetworkAnalystMgr—Controls the schematic trace tasks drop-down list.
  • ISchematicTarget—Controls the schematic layer target; that is, the current schematic diagram on which all schematic commands apply.

For further information see:

SchematicUI

See Also:

Controls