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


ITOCControlDefault Interface (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IT > ITOCControlDefault Interface
ArcGIS Developer Help

ITOCControlDefault Interface

Provides access to members that control the TOCControl.

Product Availability

Available with ArcGIS Engine.

Description

The ITOCControlDefault interface is the default dispatch interface that most development environments will automatically expose. For example, placing the TOCControl in a container will typically generate an object called TOCControl1. The properties and methods available directly on this object correspond to this interface, together with container specific properties and methods.

The ITOCControlDefault interface is a 'pure' dispatch interface, so can be extended with new properties and methods at future releases of ArcGIS. The methods and properties are identical to the highest numbered main interface on the TOCControl. For example, ITOCControlDefault is equivalent to ITOCControl2, but at future releases this could become ITOCControl3. By using the ITOCControlDefault interface you are guaranteed to always have access to the latest TOCControl. 

There is a small performance overhead in making calls through to a pure dispatch interface, but to avoid this you can QI to a specific interface. In some development environments it is not possible to QI directly on the control to other COM interfaces, because the control is contained within a wrapper object. Use the Object property to get the real control before performing the QI.

Members

Name Description
Method AboutBox Displays a dialog of information about the TOCControl.
Read-only property ActiveView The ActiveView used to populate the TOCControl.
Read/write property Appearance The appearance of the TOCControl.
Read/write property BorderStyle The border style of the TOCControl.
Read-only property Buddy The object whose ActiveView is used to populate the TOCControl.
Read/write property CustomProperty A property to associate data with a control.
Read/write property Enabled Indicates whether the TOCControl can respond to user generated events.
Read/write property EnableLayerDragDrop Indicates if layers can be dragged and dropped in the control.
Method GetSelectedItem Returns the selected item in the TOCControl.
Method HitTest Returns the item in the TOCControl at the specified coordinates.
Read-only property hWnd Handle to the window associated with the TOCControl.
Read/write property KeyIntercept A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.
Read/write property LabelEdit Label editing state.
Read/write property LayerVisibilityEdit Layer visibility editing state.
Read/write property MouseIcon Custom mouse icon used if MousePointer is 99.
Read/write property MousePointer The mouse pointer displayed over the TOCControl.
Read-only property Object A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.
Method SelectItem Sets the selected item in the TOCControl.
Method SetActiveView Sets the ActiveView used to populate the TOCControl.
Method SetBuddyControl Sets a control to be a buddy of the toolbar, this control must support ITOCBuddy.
Method Update Updates the contents of the TOCControl to match its ActiveView.

Classes that implement ITOCControlDefault

Classes Description
TOCControl Esri TOCControl
[C#]

When querying interface to ITOCControlDefault in Visual Basic .NET or Visual C# .NET the Object property or container specific code must be used. This is because .NET contains the real control inside a wrapper object known as an host.

ITOCControlDefault tocControl = axTOCControl1.Object as ITOCControlDefault;

[Visual Basic .NET]

When querying interface to ITOCControlDefault in Visual Basic .NET or Visual C# .NET the Object property or container specific code must be used. This is because .NET contains the real control inside a wrapper object known as an host.

Dim tocControl As ITOCControlDefault = AxTOCControl1.Object