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


ControlsMapSwipeTool CoClass (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

ControlsMapSwipeTool CoClass

Interactively reveals layers on a map.

Product Availability

Available with ArcGIS Engine.

Description

The CLSID of this command is: {867C6BDC-DB38-485C-B56C-BD912D0CAD74}.

This command works with the ToolbarControl, MapControl and ArcMap (it does not work with focus map in the PageLayoutControl).

This command must be used in conjunction with CommandsEnvironment singleton object. Failure to instantiate the CommandsEnvironment singleton object results in this command internally using it's own instance of the CommandsEnvironment object and appearing disabled to the end user.

This command gets the layer to be swiped from the ILayerEffectProperties::SwipeLayer property on the CommandsEnvironment singleton. This can be set programmatically or interactively by the end user selecting a layer from the ControlsLayerListToolControl.

Interfaces

Interfaces Description
ICommand (esriSystemUI) Provides access to members that define a COM command.
ITool (esriSystemUI) Provides access to members that define a tool.
[C#]
using ESRI.ArcGIS.Controls;
using ESRI.ArcGIS.SystemUI;

public partial class Form1 : Form
{
    private CommandsEnvironmentClass m_CommandsEnvironment=new CommandsEnvironmentClass();

    private void Form1_Load(object sender, System.EventArgs e)
    {
        //Set buddy control
        axToolbarControl1.SetBuddyControl(axMapControl1);
        //Add items to ToolbarControl
        axToolbarControl1.AddItem("esriControls.ControlsOpenDocCommand", -1, -1, false, 0, esriCommandStyles.esriCommandStyleIconOnly);
        axToolbarControl1.AddItem("esriControls.ControlsMapSwipeTool", -1, -1, true, 0, esriCommandStyles.esriCommandStyleIconOnly);
        axToolbarControl1.AddItem("esriControls.ControlsLayerListToolControl", -1, -1, false, 0, esriCommandStyles.esriCommandStyleIconOnly);
    }
}
[Visual Basic .NET]

Imports ESRI.ArcGIS.Controls
Imports ESRI.ArcGIS.SystemUI

Public Class Form1

    Private m_CommandsEnvironment As New CommandsEnvironmentClass

    Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        'Set buddy control
        AxToolbarControl1.SetBuddyControl(AxMapControl1)
        'Add items to ToolbarControl
        AxToolbarControl1.AddItem("esriControls.ControlsOpenDocCommand", -1, -1, False, 0, esriCommandStyles.esriCommandStyleIconOnly)
        AxToolbarControl1.AddItem("esriControls.ControlsMapSwipeTool", -1, -1, True, 0, esriCommandStyles.esriCommandStyleIconOnly)
        AxToolbarControl1.AddItem("esriControls.ControlsLayerListToolControl", -1, -1, False, 0, esriCommandStyles.esriCommandStyleIconOnly)
    End Sub

End Class