VCCodeNamespace Interface

An object representing a namespace element in the source code of a solution.

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

'Declaration
<GuidAttribute("4853EB51-640F-4A98-A6CF-B43C3ECFA8A5")> _
Public Interface VCCodeNamespace

[GuidAttribute("4853EB51-640F-4A98-A6CF-B43C3ECFA8A5")]
public interface VCCodeNamespace

[GuidAttribute(L"4853EB51-640F-4A98-A6CF-B43C3ECFA8A5")]
public interface class VCCodeNamespace

[<GuidAttribute("4853EB51-640F-4A98-A6CF-B43C3ECFA8A5")>]
type VCCodeNamespace =  interface end

public interface VCCodeNamespace

The VCCodeNamespace type exposes the following members.

Properties

	Name	Description
	BodyText	Gets or sets the body text of the object.
	Children	Gets a collection of objects contained within this code construct.
	Classes	Gets a collection of classes for the object.
	CodeModel	Gets the VCCodeModel object for the project.
	Collection	Gets the collection containing the object supporting this property or contained within this code construct.
	Comment	Gets or sets the comment associated with the code element.
	DeclarationText	Gets or sets the declaration of the object.
	DisplayName	Gets the name used in the user interface for this output group.
	DocComment	Gets the document comment for the current code model element.
	DTE	Gets the top-level extensibility object.
	EndPoint	Gets the edit point that is the location of the end of the code item.
	EndPointOf	Returns the end point of the parent object.
	Enums	Gets a collection of enumerations for the object.
	Extender	Returns the requested Extender object if it is available for this object.
	ExtenderCATID	Gets the Extender category ID (CATID) for the object.
	ExtenderNames	Gets a list of available Extenders for the object.
	File	Gets the file in which the object is declared.
	FullName	Gets the full path and name of the object's file.
	Functions	Gets a collection of functions for the object.
	InfoLocation	Gets the capabilities of the code model.
	Interfaces	Gets the collection of interfaces for the object.
	IsCaseSensitive	Gets whether a code element is case-sensitive.
	IsCodeType	Gets a value indicating whether a CodeType object can be obtained from this object.
	IsInjected	Gets whether a code element has been injected by an attribute or macro expansion.
	IsReadOnly	Gets whether the file containing the object is read-only.
	IsZombie	Gets whether the object exists.
	Kind	Gets an enumeration indicating the type of object.
	Language	Gets the programming language used to author the code.
	Location	Returns the location of the object declaration.
	Macros	Gets the collection of macros (#define statements) for the object.
	Maps	Gets the collection of maps for the object.
	Members	Gets a collection of items contained by this element.
	Name	Gets or sets the name of the object.
	Namespaces	Gets the collection of namespaces for the object.
	Parent	Gets the immediate parent object of a given object.
	Picture	Gets a picture automation object to be used as an icon in the user interface.
	Project	Gets the Project object associated with the object.
	ProjectItem	Gets the ProjectItem object associated with the given object.
	References	Not currently implemented.
	StartPoint	Gets a TextPoint object that defines the beginning of the code item.
	StartPointOf	Gets the start point of the object.
	Structs	Gets the collection of structure elements for the object.
	Typedefs	Gets the collection of Typedef elements for the object.
	Unions	Gets the collection of union elements for the object.
	Variables	Gets the collection of variables for the object.

Top

Methods

	Name	Description
	AddClass	Creates a new class code construct and inserts the code in the correct location.
	AddDelegate	Creates a new delegate code construct and inserts the code in the correct location.
	AddEnum	Creates a new enumeration code construct and inserts the code in the correct location.
	AddFunction	Creates a new function code construct and inserts the code in the correct location.
	AddInterface	Creates a new interface code construct and inserts the code in the correct location.
	AddMap	Adds a map to the object.
	AddNamespace	Creates a new namespace code construct and inserts the code in the correct location.
	AddStruct	Creates a new structure code construct and inserts the code in the correct location.
	AddTypedef	Adds a typedef statement to the object.
	AddUnion	Adds a union statement to the object.
	AddVariable	Creates a new variable code construct and inserts the code in the correct location.
	GetEndPoint	Gets a TextPoint object that marks the end of the code element definition.
	GetStartPoint	Gets a TextPoint object that defines the beginning of the code element definition.
	IsSelf	Determines if the specified code element is the same as another code element.
	Remove	Removes the specified project from the solution.
	ValidateMember	Validates that the proposed name is a valid C++ name for the kind given in the context of the object.

Top

Remarks

The VCCodeNamespace object represents namespace declarations and is a superset of the VCCodeElement object.

Note

A large part of the functionality of this object is provided by the Visual Studio CodeNamespace object. For more information, see CodeNamespace object.

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

Examples

This example retrieves the namespaces of the current solution and displays each name in a message box.

Sub AllNamespaces()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim namespace As VCCodeNamespace
    For Each namespace In codeModel.Namespaces
        MsgBox(namespace.DisplayName)
    Next
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace