ControlLocale Property
Collapse the table of content
Expand the table of content
This documentation is archived and is not being maintained.

ControlLocale Property

Visual Studio .NET 2003

Sets or returns the locale for the selected ActiveX reference.

[Visual Basic .NET]
Public Property ControlLocale() As Integer
[Visual Basic 6]
Property Get ControlLocale() As Long
Property Let ControlLocale( _
   ByVal NewValue As Long _
HRESULT __stdcall get_ControlLocale(
   /* [out, retval] */ long* retVal
HRESULT __stdcall put_ControlLocale(
   /* [in] */ long NewValue
public int ControlLocale {get; set;}
[JScript .NET]
public function get ControlLocale() : int
public function set ControlLocale(
   NewValue : int


The new locale value for the selected ActiveX reference.

Return Value

An int or a long (depending on the programming language) representing the locale value for the selected ActiveX reference.


Although this property is settable, you should not do so. It is settable only for internal purposes.


Loops through each project in your solution and lists the locale ID of each ActiveX (COM) control.

' Add a reference to Microsoft.VisualStudio.VCProjectEngine and have a 
' Visual C++ .NET project loaded before running this example. Also, you 
' should have at least one ActiveX (COM) reference in a project.
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine

Public Module Module1
    Sub Test()
        Dim proj As Project
        Dim vcproj As VCProject
        Dim ref As VCReference
        Dim axref As VCActiveXReference
        On Error Resume Next

        ' Loop each project in the solution
        For Each proj In DTE.Solution.Projects
            vcproj = Nothing
            vcproj = CType(proj.Object, VCProject)
            ' If this project is a Visual C++.NET project
            If Not vcproj Is Nothing Then
                ' Loop the references for this Visual C++.NET project
                For Each ref In vcproj.VCReferences
                    axref = Nothing
                    axref = CType(ref, VCActiveXReference)
                    ' If this reference is an ActiveX reference
                    If Not axref Is Nothing Then
                        MsgBox("Control locale: " & axref.ControlLocale)
                    End If
            End If
    End Sub
End Module

See Samples for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

See Also

ControlFullPath Property | ControlGUID Property | ControlVersion Property

Applies To: VCActiveXReference Object

© 2016 Microsoft