ISymbologyControlDefault Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IS > ISymbologyControlDefault Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Controls)  

ISymbologyControlDefault Interface

Provides access to members that control the SymbologyControl.

Product Availability

Available with ArcGIS Engine.

Description

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

The ISymbologyControlDefault 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 SymbologyControl. For example, ISymbologySelectorDefault is equivalent to ISymbologyControl, but at future releases this could become ISymbologyControl2. By using the ISymbologySelectorDefault interface you are guaranteed to always have access to the latest SymbologyControl.

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 SymbologyControl.
Read/write property Appearance The appearance of the SymbologyControl.
Read/write property BackColor Background color of the SymbologyControl.
Read/write property BorderStyle The border style of the SymbologyControl.
Method Clear Clears all symbols and files from the SymbologyControl.
Read/write property CustomProperty A property to associate data with the SymbologyControl.
Read/write property DisplayStyle The display style of the SymbologyControl.
Read/write property Enabled Indicates whether the SymbologyControl can respond to user generated events.
Method GetStyleClass Returns the specified style class from the SymbologyControl.
Method HitTest Returns the item at the specified x and y coordinates.
Read-only property hWnd Handle to the window associated with the SymbologyControl.
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.
Method LoadDesktopStyleFile Loads a desktop style file into the SymbologyControl.
Method LoadStyleFile Loads a server style file into the SymbologyControl.
Read/write property MouseIcon Custom mouse icon used if MousePointer is 99.
Read/write property MousePointer The mouse pointer displayed over the SymbologyControl.
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 RemoveFile Removes a file from the SymbologyControl.
Read/write property ShowContextMenu Indicates if the SymbologyControl displays a context menu.
Read/write property StyleClass The style class used by the SymbologyControl.

CoClasses that implement ISymbologyControlDefault

CoClasses and Classes Description
SymbologyControl Provides access to the Esri SymbologyControl.
[C#]

When querying interface to ISymbologyControlDefault 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.

ISymbologyControlDefault symbologyControl=axSymbologyControl1.Object as ISymbologyControlDefault;

[Visual Basic .NET]

When querying interface to ISymbologyControlDefault 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 symbologyControl As ISymbologyControlDefault=AxSymbologyControl1.Object