ESRI.ArcGIS.ADF.Web.UI.WebControls
ClientAction Property
See Also  Send Feedback
ESRI.ArcGIS.ADF.Web.UI.WebControls Namespace > InteractiveToolbarItem Class : ClientAction Property




Javascript action to invoke on the client-side. Required for a Tool. Optional for Command and DropDownBox.

Syntax

Visual Basic (Declaration) 
<EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ESRI.ArcGIS.ADF.Web.UI.WebControls.Design.ClientToolActionEditor, ESRI.ArcGIS.ADF.Web.UI.WebControls, Version=10.1.0.0, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86")>
<ResCategoryAttribute("Client Action")>
<ResDefaultValueAttribute()>
<ResDescriptionAttribute("Javascript action to invoke on the client-side.  Required for Tools. Optional for Commands and Selects.")>
<NotifyParentPropertyAttribute(True)>
Public Property ClientAction As String
Visual Basic (Usage)Copy Code
Dim instance As InteractiveToolbarItem
Dim value As String
 
instance.ClientAction = value
 
value = instance.ClientAction
C# 
[EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ESRI.ArcGIS.ADF.Web.UI.WebControls.Design.ClientToolActionEditor, ESRI.ArcGIS.ADF.Web.UI.WebControls, Version=10.1.0.0, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86")]
[ResCategoryAttribute("Client Action")]
[ResDefaultValueAttribute()]
[ResDescriptionAttribute("Javascript action to invoke on the client-side.  Required for Tools. Optional for Commands and Selects.")]
[NotifyParentPropertyAttribute(true)]
public string ClientAction {get; set;}

Remarks

A tool, command or drop-down box may perform actions on the client, either prior to a server action or as an independent client-side action. ClientAction specifies this client action. This property may specify one of the built-in client actions that perform standard actions on the map or page layout. These use one of the values in the MapClientToolAction enumeration (such as Point or DragRectangle) or the PageClientToolAction enumeration.

If using a custom action, you can specify just the name of the javascript function to call. That function can pass the name of the toolbar and the name of the tool. The value Toolbar will be replaced with the toolbar name, and ToolbarItem will be replaced with the Name of the toolbar item. For example, if ClientAction is set like this:

myToolItem.ClientAction = "myClientFunction('Toolbar', 'ToolbarItem')";
Then a JavaScript function may be included on the page that uses these values, like this: 
function myClientFunction(toolbarName, toolbarItemName) {
               alert("You clicked tool " + toolbarItemName + " on toolbar " + toolbarName);
            }

The custom action may operate on the map or page layout, or may perform some other action on the page.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2011 All Rights Reserved.