ArcGIS Developer Help

ControlsFlickerRateToolControlClass Class

Controls the rate (in milliseconds) of the layer flicker.

Product Availability

Available with ArcGIS Engine.

Description

The CLSID of this command is: {9532F137-EECA-4158-8690-1DD93B286B73}.

This command works with the ToolbarControl, MapControl, PageLayoutControl and GlobeControl.

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.

When the end user selects a rate (in milliseconds) using this tool control they are setting the ILayerEffectProperties::FlickerRate property on the CommandsEnvironment singleton object. The property is used by the ControlsMapFlickerCommand and ControlsGlobeFlickerCommand to flicker the ILayerEffectProperties::FlickerLayer.

Interfaces

Interfaces	Description
ICommand (esriSystemUI)	Provides access to members that define a COM command.
IToolControl (esriSystemUI)	Provides access to members that define a toolcontrol.

[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.ControlsMapFlickerCommand", -1, -1, true, 0, esriCommandStyles.esriCommandStyleIconOnly);
        axToolbarControl1.AddItem("esriControls.ControlsFlickerRateToolControl", -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.ControlsMapFlickerCommand", -1, -1, True, 0, esriCommandStyles.esriCommandStyleIconOnly)
        AxToolbarControl1.AddItem("esriControls.ControlsFlickerRateToolControl", -1, -1, True, 0, esriCommandStyles.esriCommandStyleIconOnly)
        AxToolbarControl1.AddItem("esriControls.ControlsLayerListToolControl", -1, -1, False, 0, esriCommandStyles.esriCommandStyleIconOnly)
    End Sub

End Class