VCActiveXReference.WrapperTool Property

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

Package:: Microsoft.VisualStudio.VCProjectEngine v17.11.40252

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the name of the tool to use when wrapping an ActiveX control reference.

public:
 property System::String ^ WrapperTool { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ WrapperTool { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(2063)]
public string WrapperTool { [System.Runtime.InteropServices.DispId(2063)] get; [System.Runtime.InteropServices.DispId(2063)] set; }

[<System.Runtime.InteropServices.DispId(2063)>]
[<get: System.Runtime.InteropServices.DispId(2063)>]
[<set: System.Runtime.InteropServices.DispId(2063)>]
member this.WrapperTool : string with get, set

Public Property WrapperTool As String

Property Value

String

The name of the tool to use when wrapping an ActiveX control reference.

Attributes: DispIdAttribute

Examples

[Visual Basic]

This example loops through each project in your solution and lists the wrapper name of each ActiveX (COM) control.

' Add a reference to Microsoft.VisualStudio.VCProjectEngine and have a   
' Visual C++ 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++ project.  
            If Not vcproj Is Nothing Then  
                ' Loop the references for this Visual C++ 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("Wrapper tool name: " & axref.WrapperTool)  
                    End If  
                Next  
            End If  
        Next  
    End Sub  
End Module

Remarks

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

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information about how to compile and run this sample.

Applies to

Share via