CodeClass.AddBase(Object, Object) Method
Definition
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.
Adds an item to the list of inherited objects.
EnvDTE::CodeElement AddBase(winrt::Windows::Foundation::IInspectable const & Base, winrt::Windows::Foundation::IInspectable const & Position);
[System.Runtime.InteropServices.DispId(39)]
public EnvDTE.CodeElement AddBase (object Base, object Position);
[<System.Runtime.InteropServices.DispId(39)>]
abstract member AddBase : obj * obj -> EnvDTE.CodeElement
Public Function AddBase (Base As Object, Optional Position As Object) As CodeElement
Parameters
- Base
- Object
Required. The class from which to derive implementation.
For CodeClass objects, this is either a CodeClass or a fully qualified type name. Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.
- Position
- Object
Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.
If the value is a Long, then AddBase(Object, Object) indicates the element after which to add the new element.
Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.
Returns
A CodeElement object.
- Attributes
Examples
Sub AddBaseExample(ByVal dte As DTE2)
' Before running this example, open a code document from a project
' and place the insertion point inside a class definition.
Try
' Retrieve the CodeClass at the insertion point.
Dim sel As TextSelection = _
CType(dte.ActiveDocument.Selection, TextSelection)
Dim cls As CodeClass = _
CType(sel.ActivePoint.CodeElement( _
vsCMElement.vsCMElementClass), CodeClass)
Dim cm As CodeModel = _
cls.ProjectItem.ContainingProject.CodeModel
' Create a fully qualified base name.
Dim baseName As String = ConvertFullName(cm, _
"System.Collections.CollectionBase")
' Add a base to the class.
cls.AddBase(baseName)
Catch ex As Exception
MsgBox(ex.Message)
End Try
End Sub
Function ConvertFullName(ByVal cm As CodeModel, _
ByVal fullName As String) As String
' Convert a .NET type name into a C++ type name.
If (cm.Language = CodeModelLanguageConstants.vsCMLanguageVC) Or _
(cm.Language = CodeModelLanguageConstants.vsCMLanguageMC) Then
Return fullName.Replace(".", "::")
Else
Return fullName
End If
End Function
public void AddBaseExample(DTE2 dte)
{
// Before running this example, open a code document from a project
// and place the insertion point inside a class definition.
try
{
// Retrieve the CodeClass at the insertion point.
TextSelection sel =
(TextSelection)dte.ActiveDocument.Selection;
CodeClass cls =
(CodeClass)sel.ActivePoint.get_CodeElement(
vsCMElement.vsCMElementClass);
CodeModel cm = cls.ProjectItem.ContainingProject.CodeModel;
// Create a fully qualified base name.
string baseName = ConvertFullName(cm,
"System.Collections.CollectionBase");
// Add a base to the class.
cls.AddBase(baseName, -1);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
string ConvertFullName(CodeModel cm, string fullName)
{
// Convert a .NET type name into a C++ type name.
if ((cm.Language == CodeModelLanguageConstants.vsCMLanguageVC) ||
(cm.Language == CodeModelLanguageConstants.vsCMLanguageMC))
return fullName.Replace(".", "::");
else
return fullName;
}
Remarks
AddBase returns a CodeElement object rather than a CodeType to accommodate Visual C++, and the Kind of the returned object is vsCMElementVCBase for the implementation of Visual C++.
Note
The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).