ESRI.ArcGIS.ADF.Web.UI.WebControls
Toc Class Members
See Also  Fields  Properties  Methods  Events
ESRI.ArcGIS.ADF.Web.UI.WebControls Namespace : Toc Class




The following tables list the members exposed by Toc.

Public Constructors

 NameDescription
Public ConstructorToc Constructor Table of Contents class constructor.  
Top

Public Fields

 NameDescription
Public FieldStateManager All state management is done through this property. (Inherited from CompositeControl)
Top

Protected Fields

 NameDescription
Protected Field_callbackArg Property for the callback event argument sent in from the calling page. Use CallbackEventArgument instead. (Inherited from CompositeControl)
Top

Public Properties

 NameDescription
Public PropertyAccessKey (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Public PropertyAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBackColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderWidth (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBuddyControlThe ID of the Map control from which the Toc derives its information.  
Public PropertyCallbackFunctionString Gets the callbackfunction string for this control instance. (Inherited from CompositeControl)
Public PropertyCallbackResults A collection of CallbackResult objects for passing information from the server to the client during a callback. (Inherited from CompositeControl)
Public PropertyClearImage The image to display to remove a node when the ShowClearButton property on the TreeViewPlusNode is true (Inherited from TreeViewPlus)
Public PropertyClientID (Inherited from System.Web.UI.Control)
Public PropertyCollapsedImage URL of the image to display at a node when the node is collapsed to hide its children. (Inherited from TreeViewPlus)
Public PropertyControls (Inherited from System.Web.UI.WebControls.CompositeControl)
Public PropertyControlStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreated (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCssClass (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyDepth Read-only property for the depth of a node. Since the TreeViewPlus is always at the root, this value is always zero (0). (Inherited from TreeViewPlus)
Public PropertyDisabledColor Color to display disabled nodes, such as nodes for layers that are not visible at the current scale.  
Public PropertyDisplayImageUrlThe URL of the image displayed in this TOC control.  
Public PropertyEnabled (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableTheming (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableViewState (Inherited from System.Web.UI.Control)
Public PropertyExpandDepthNumber of levels of the tree to display. (Inherited from TreeViewPlus)
Public PropertyExpandedImage URL of the image to display at a node when the node is expanded to show its children. (Inherited from TreeViewPlus)
Public PropertyFont (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyForeColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHasAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHeight (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHoverColorOverridden. Hover color for the tree.  
Public PropertyID (Inherited from System.Web.UI.Control)
Public PropertyIsAsync Returns true if this control is in a partial postback or a callback. (Inherited from CompositeControl)
Public PropertyNamingContainer (Inherited from System.Web.UI.Control)
Public PropertyNodes The nodes of the tree. These contain the data to display for the TreeViewPlus control. (Inherited from TreeViewPlus)
Public PropertyNonInteractive Show only text (and legend image if any) (Inherited from TreeViewPlus)
Public PropertyOffset Read-only property for the horizontal offset of the node from its StartingPosition due to collapse/expand image, check-box, etc. Since the root-level TreeViewPlus has no such items, this property always returns zero (0). (Inherited from TreeViewPlus)
Public PropertyOffsetWidthThe number of pixels to offset child nodes in the tree. (Inherited from TreeViewPlus)
Public PropertyPage (Inherited from System.Web.UI.Control)
Public PropertyPageSizeMaximum number of items to display per page in the control. (Inherited from TreeViewPlus)
Public PropertyPagingTextFormatString The format string that defines how paging text appears. The fields are page starting record, page ending record, total record count, current page number and number of pages. (Inherited from TreeViewPlus)
Public PropertyParent (Inherited from System.Web.UI.Control)
Public PropertyRenderOnDemandOverridden.  Property that determines whether collapsed nodes render children nodes to the browser on initial page load, or only when expanded.  
Public PropertySelectedColorThe color to use for selections in the tree. (Inherited from TreeViewPlus)
Public PropertySelectedNodeThe node that is selected in the tree. (Inherited from TreeViewPlus)
Public PropertyShowClearAllButtonWhether to include a button on the control to clear all nodes in the tree. (Inherited from TreeViewPlus)
Public PropertyShowLayerCheckBoxes Whether to display check-boxes for each layer in the map, which enables users to turn layers on and off.  
Public PropertyShowResourceCheckBoxes Whether to display check-boxes for each resource in the map, which enables users to turn resources on and off.  
Public PropertySite (Inherited from System.Web.UI.Control)
Public PropertySkinID (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyStartingPosition Read-only property for the starting horizontal offset of the node. Since the TreeViewPlus is at the root of the tree, this property always returns zero (0). (Inherited from TreeViewPlus)
Public PropertyStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySwatchPageSizeNumber of legend swatches per page in the Toc.  
Public PropertyTabIndex (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTemplateControl (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Public PropertyTocType The Toc renders a layer list or a swatch list (along with the layer list) based on the TocType enum.  
Public PropertyToolTip (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyUniqueID (Inherited from System.Web.UI.Control)
Public PropertyUseDefaultWebResources The ADF Web Controls will use the internal web resources unless the user wants to use a modified version of the ESRI Javascript Library. (Inherited from CompositeControl)
Public PropertyValueThe value of the root node of the tree. (Inherited from TreeViewPlus)
Public PropertyValuePathThe full path to the root node of the tree. (Inherited from TreeViewPlus)
Public PropertyValuePathSeparator Character to recognize for separation of values when specifying node paths. Default is forward slash (/). (Inherited from TreeViewPlus)
Public PropertyVisible (Inherited from System.Web.UI.Control)
Public PropertyWebResourceLocation The location of the web resources for use by the ADF Web Controls if the default Web resources are not used." (Inherited from CompositeControl)
Public PropertyWidth (Inherited from System.Web.UI.WebControls.WebControl)
Top

Protected Properties

 NameDescription
Protected PropertyAdapter (Inherited from System.Web.UI.Control)
Protected PropertyCallbackEventArgument Property for the callback event argument sent in from the calling page. (Inherited from CompositeControl)
Protected PropertyChildControlsCreated (Inherited from System.Web.UI.Control)
Protected PropertyClearAllLinkID The ID of the HTML anchor element used for clearing all nodes. (Inherited from TreeViewPlus)
Protected PropertyClientIDSeparator (Inherited from System.Web.UI.Control)
Protected PropertyContentDivID The ID of the HTML div element that contains all nodes on the client. (Inherited from TreeViewPlus)
Protected PropertyContext (Inherited from System.Web.UI.Control)
Protected PropertyDesignMode (Inherited from System.Web.UI.Control)
Protected PropertyEvents (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewState (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparator (Inherited from System.Web.UI.Control)
Protected PropertyIsAtRenderStage Returns true if this control is called through an asynchronous callback, or the refresh flag has been set and the page is in partial postback mode. (Inherited from CompositeControl)
Protected PropertyIsChildControlStateCleared (Inherited from System.Web.UI.Control)
Protected PropertyIsEnabled (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyIsTrackingViewState (Inherited from System.Web.UI.Control)
Protected PropertyIsViewStateEnabled (Inherited from System.Web.UI.Control)
Protected PropertyLoadViewStateByID (Inherited from System.Web.UI.Control)
Protected PropertyScriptManager Gets a reference to the scriptmanager of the page (Inherited from CompositeControl)
Protected PropertyTagKey Gets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from TreeViewPlus)
Protected PropertyTagName (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyViewState (Inherited from System.Web.UI.Control)
Protected PropertyViewStateIgnoresCase (Inherited from System.Web.UI.Control)
Top

Public Methods

 NameDescription
Public MethodApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
Public MethodBindToDataSetUsing this member, an ADO.NET Dataset can be used to create the Tree. (Inherited from TreeViewPlus)
Public MethodContextMenuDismissed Call this method to reset the background of the node when context menu is dismissed. (Inherited from TreeViewPlus)
Public MethodCopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public Methodstatic (Shared in Visual Basic)CreateLegendNodeTree Generate The Tree of nodes for TOC  
Public MethodDataBindOverloaded.  (Inherited from System.Web.UI.WebControls.CompositeControl)
Public MethodDispose (Inherited from System.Web.UI.Control)
Public MethodFindControlOverloaded.  (Inherited from System.Web.UI.Control)
Public MethodFindNodeByValuePathSearches for a node in the tree with a specified value path. (Inherited from TreeViewPlus)
Public MethodFocus (Inherited from System.Web.UI.Control)
Public MethodGetCallbackResultReturns the results of the client callback. (Inherited from TreeViewPlus)
Public MethodGetFunctionalitiesRetrieves the collection of table-of-contents functionalities for the map.  
Public MethodGetFunctionalityOverloaded. Retrieves the IMapTocFunctionality at the index specified.  
Public MethodGetScriptDescriptors Defines the collection of parameters and their associated values used when instantiating the Javascript object related to this control. (Inherited from TreeViewPlus)
Public MethodGetScriptReferences Returns a list of required clientside scripts for this webcontrol, based on the class' script attributes (Inherited from CompositeControl)
Public MethodGetSupportedBuddyControlTypes The method supports the .NET ADF infrastructure and is not intended to be used directly from your code.  
Public MethodHasControls (Inherited from System.Web.UI.Control)
Public MethodInitializeFunctionalities Initializes the Toc functionalities of the data sources associated with the Toc.  
Public MethodInitializeFunctionalityCreates and initializes a functionality for the resource item passed in.  
Public MethodMergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRaiseCallbackEvent As part of the callback implementation for the control, stores the event argument passed to the control by the client. (Inherited from CompositeControl)
Public MethodRaisePostBackEvent Processes a postback event that targets a control and returns the result. (Inherited from CompositeControl)
Public MethodRefreshOverridden. Refreshes the Toc nodes. Call if functionalities have changed.  
Public MethodRenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControlOverloaded.  (Inherited from System.Web.UI.Control)
Public MethodRenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
Public Methodstatic (Shared in Visual Basic)RenderLegendHtml Generate HTML for TOC as a legend. All enabled child nodes will be expanded so the swatches will appear along with textual representation.  
Public MethodResolveClientUrl (Inherited from System.Web.UI.Control)
Public MethodResolveUrl (Inherited from System.Web.UI.Control)
Public MethodSetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Public MethodSetupContextMenuAssigns the context menu for the node. (Inherited from TreeViewPlus)
Top

Protected Methods

 NameDescription
Protected MethodAddAttributesToRenderOverridden.  Adds additional attributes to the Toc webcontrol both at design time as well as runtime.  
Protected MethodAddedControl (Inherited from System.Web.UI.Control)
Protected MethodAddParsedSubObject (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTree (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlState (Inherited from System.Web.UI.Control)
Protected MethodClearChildState (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewState (Inherited from System.Web.UI.Control)
Protected MethodCreateChildControls Adds the child controls of this control. (Inherited from TreeViewPlus)
Protected MethodCreateControlCollection (Inherited from System.Web.UI.Control)
Protected MethodCreateControlStyle (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodDataBindChildren (Inherited from System.Web.UI.Control)
Protected MethodEnsureChildControls (Inherited from System.Web.UI.Control)
Protected MethodEnsureID (Inherited from System.Web.UI.Control)
Protected MethodGetDataRowHtmlTableReturns the formatted HTML table for the data row. (Inherited from TreeViewPlus)
Protected MethodGetDataRowHtmlTableConvertedReturns the formatted HTML table for the data row. (Inherited from TreeViewPlus)
Protected MethodGetDesignModeState (Inherited from System.Web.UI.Control)
Protected MethodGetDesignModeWarningsOverridden.  Returns a list of warning messages to be displayed at design time.  
Protected MethodGetHeaderFormatStringGets the title format string for the data table. (Inherited from TreeViewPlus)
Protected MethodHasEvents (Inherited from System.Web.UI.Control)
Protected MethodIsLiteralContent (Inherited from System.Web.UI.Control)
Protected MethodLoadControlState (Inherited from System.Web.UI.Control)
Protected MethodLoadViewState (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodMapPathSecure (Inherited from System.Web.UI.Control)
Protected MethodOnBubbleEvent (Inherited from System.Web.UI.Control)
Protected MethodOnDataBinding (Inherited from System.Web.UI.Control)
Protected MethodOnInit Raises the System.Web.UI.Control.Init event. (Inherited from TreeViewPlus)
Protected MethodOnLoadOverridden. Occurs when the control is loaded.  
Protected MethodOnNodeAddedRaises the NodeAdded event. (Inherited from TreeViewPlus)
Protected MethodOnNodeCheckOccurs when a node's checkbox is checked. (Inherited from TreeViewPlus)
Protected MethodOnNodeClearOccurs when a node's contents is cleared. (Inherited from TreeViewPlus)
Protected MethodOnNodeClickOccurs when a node in the treeview is clicked. (Inherited from TreeViewPlus)
Protected MethodOnNodeCollapseOccurs when a node in the treeview is collapsed. (Inherited from TreeViewPlus)
Protected MethodOnNodeExpandOccurs then a node is expanded in the treeview. (Inherited from TreeViewPlus)
Protected MethodOnNodeLegendClickOccurs when the legend node is clicked. (Inherited from TreeViewPlus)
Protected MethodOnNodePageChangeOccurs when the node page is changed. (Inherited from TreeViewPlus)
Protected MethodOnNodeRemovedRaises the NodeRemoved event. (Inherited from TreeViewPlus)
Protected MethodOnNodeRemoving Raises the NodeRemoving event. (Inherited from TreeViewPlus)
Protected MethodOnNodeSelectOccurs when a node in the treeview is selected. (Inherited from TreeViewPlus)
Protected MethodOnNodesPopulatedOccurs when the nodes of the Toc are populated.  
Protected MethodOnPreRenderOverridden. Raises the PreRender event.  
Protected MethodOnUnload On unload. (Inherited from TreeViewPlus)
Protected MethodOpenFile (Inherited from System.Web.UI.Control)
Protected MethodRaiseBubbleEvent (Inherited from System.Web.UI.Control)
Protected MethodRecreateChildControls (Inherited from System.Web.UI.WebControls.CompositeControl)
Protected MethodRemovedControl (Inherited from System.Web.UI.Control)
Protected MethodRender Renders the control to the specified HTML writer. (Inherited from TreeViewPlus)
Protected MethodRenderAjaxControl Registers start up script to create javascript controls. Called by the Render method. (Inherited from TreeViewPlus)
Protected MethodRenderChildren (Inherited from System.Web.UI.Control)
Protected MethodRenderContentsOverridden.  Renders the contents of the webcontrol both at design time as well as run time.  
Protected MethodRenderDesignModeWarnings If design mode is active and the derived class has configuration errors, then a standard template will be used to show these errors to the user and True is returned, else no warnings are displayed and false is returned. (Inherited from CompositeControl)
Protected MethodResolveAdapter (Inherited from System.Web.UI.Control)
Protected MethodSaveControlState (Inherited from System.Web.UI.Control)
Protected MethodSaveViewState (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodSetDesignModeState (Inherited from System.Web.UI.Control)
Protected MethodsetExpandDepthVisibilityOverloaded.  Sets the the visibility for nodes to the specified expand depth. (Inherited from TreeViewPlus)
Protected MethodSetRefreshFlagSetRefreshFlag. (Inherited from CompositeControl)
Protected MethodTrackViewState (Inherited from System.Web.UI.WebControls.WebControl)
Top

Public Events

 NameDescription
Public EventDataBinding (Inherited from System.Web.UI.Control)
Public EventDisposed (Inherited from System.Web.UI.Control)
Public EventInit (Inherited from System.Web.UI.Control)
Public EventLoad (Inherited from System.Web.UI.Control)
Public EventNodeAddedEvent that is called when a node has been added. (Inherited from TreeViewPlus)
Public EventNodeCheckedEvent that is called when a node is checked on the tree. (Inherited from TreeViewPlus)
Public EventNodeClearedEvent that is called when a node is cleared on the tree. (Inherited from TreeViewPlus)
Public EventNodeClickedEvent that is called when a node is clicked on the tree. (Inherited from TreeViewPlus)
Public EventNodeCollapsedEvent that is called when a node is collapsed on the tree. (Inherited from TreeViewPlus)
Public EventNodeExpandedEvent that is called when a node is expanded on the tree. (Inherited from TreeViewPlus)
Public EventNodeLegendClickedEvent that is called when a node legend is clicked on the tree. (Inherited from TreeViewPlus)
Public EventNodePageChangedEvent that is called when a node page is changed on the tree. (Inherited from TreeViewPlus)
Public EventNodeRemovedEvent that is called when a node has been removed. (Inherited from TreeViewPlus)
Public EventNodeRemovingEvent that is called when a node is about to be removed. (Inherited from TreeViewPlus)
Public EventNodeSelectedEvent that is called when a node is selected on the tree. (Inherited from TreeViewPlus)
Public EventNodesPopulatedEvent that is called when the nodes of the Toc are populated.  
Public EventPreRender (Inherited from System.Web.UI.Control)
Public EventUnload (Inherited from System.Web.UI.Control)
Top

See Also

© 2010 All Rights Reserved.