ContextAttributes.Add(String, String, vsContextAttributeType) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 attribute name/value pair to the ContextAttributes collection.

public:
 EnvDTE::ContextAttribute ^ Add(System::String ^ AttributeName, System::String ^ AttributeValue, EnvDTE::vsContextAttributeType Type);

public:
 EnvDTE::ContextAttribute ^ Add(Platform::String ^ AttributeName, Platform::String ^ AttributeValue, EnvDTE::vsContextAttributeType Type);

EnvDTE::ContextAttribute Add(std::wstring const & AttributeName, std::wstring const & AttributeValue, EnvDTE::vsContextAttributeType Type);

[System.Runtime.InteropServices.DispId(4)]
public EnvDTE.ContextAttribute Add (string AttributeName, string AttributeValue, EnvDTE.vsContextAttributeType Type);

[<System.Runtime.InteropServices.DispId(4)>]
abstract member Add : string * string * EnvDTE.vsContextAttributeType -> EnvDTE.ContextAttribute

Public Function Add (AttributeName As String, AttributeValue As String, Type As vsContextAttributeType) As ContextAttribute

Parameters

AttributeName: String

Required. The name of the new attribute.

AttributeValue: String

Required. The value of the new attribute.

Type: vsContextAttributeType

Required. A vsContextAttributeType constant specifying the type of new attribute.

Returns

ContextAttribute

A ContextAttribute object.

Attributes: DispIdAttribute

Examples

Sub AddExample()  
   ' Get a reference to Solution Explorer.  
   Dim SolnEx As Window = DTE.Windows.Item _  
   (Constants.vsWindowKindSolutionExplorer)  
   Dim CA As ContextAttribute  

   ' List the current attributes associated with Solution Explorer.  
   ListAttr(SolnEx, CA)  

   ' Associate a new F1 keyword with Solution Explorer.  
   SolnEx.ContextAttributes.Add("ANewKeyword", 900, _  
   vsContextAttributeType.vsContextAttributeLookupF1)  
   ListAttr(SolnEx, CA)  

   ' Delete the new F1 keyword from Solution Explorer.  
   SolnEx.ContextAttributes.Item(3).Remove()  
   ListAttr(SolnEx, CA)  
End Sub  

Sub ListAttr(ByVal SolnEx As Object, ByVal CA As ContextAttribute)  
   ' Support function for CATest(). Lists the current attributes   
   ' associated with Solution Explorer.  
   Dim msg As String  

   MsgBox("Number of context attributes in Solution Explorer: " & _  
   SolnEx.ContextAttributes.Count)  
   For Each CA In SolnEx.ContextAttributes  
      msg = msg & CA.Name & Chr(13)  
   Next  
   MsgBox(msg)  
   msg = ""  
End Sub

Remarks

Add allows you to add a new attribute to the collection (context bag) or create keywords.

Note

If the collection object on which you are calling the method has Type set to vsContextAttributesGlobal, then this method fails with E_NOTIMPL.

Applies to

Compartilhar via