VCFileCodeModel Interface

 

An object representing the code elements in a source file.

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

[GuidAttribute("0624857C-D3E4-4DC1-9E8D-401434E07364")]
public interface VCFileCodeModel : FileCodeModel2

NameDescription
System_CAPS_pubpropertyAttributes

Gets a collection of all of the attributes for the object.

System_CAPS_pubpropertyClasses

Gets a collection of classes for the object.

System_CAPS_pubpropertyCodeElements

Gets a collection of code elements.

System_CAPS_pubpropertyDelegates

Gets a collection of delegates for the object.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyEndPoint

Gets the edit point that is the location of the end of the code item.

System_CAPS_pubpropertyEnums

Gets a collection of enumerations for the object.

System_CAPS_pubpropertyFunctions

Gets a collection of functions for the object.

System_CAPS_pubpropertyIDLImports

Gets the collection of Import statements from the .idl file of the object.

System_CAPS_pubpropertyIDLLibraries

Gets the collection of Library elements on the object.

System_CAPS_pubpropertyImports

Gets the collection of #import statements for the object.

System_CAPS_pubpropertyIncludes

Gets the collection of #include statements for the object.

System_CAPS_pubpropertyInterfaces

Gets the collection of interfaces for the object.

System_CAPS_pubpropertyIsBatchOpen

Not currently implemented.

System_CAPS_pubpropertyIsManaged

Gets true if the ref keyword is used.

System_CAPS_pubpropertyIsMCOldSyntax

Gets a value indicating whether the file was compiled using the old syntax.

System_CAPS_pubpropertyIsSynchronized

Not implemented.

System_CAPS_pubpropertyLanguage

Gets the programming language used to author the code.

System_CAPS_pubpropertyMacros

Gets the collection of macros (#define statements) for the object.

System_CAPS_pubpropertyMaps

Gets the collection of maps for the object.

System_CAPS_pubpropertyNamespaces

Gets the collection of namespaces for the object.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyParseStatus

Gets an enumeration defining the outcome of parsing the file for the code model.

System_CAPS_pubpropertyStartPoint

Gets a TextPoint object that defines the beginning of the code item.

System_CAPS_pubpropertyStructs

Gets the collection of structure elements for the object.

System_CAPS_pubpropertyTypedefs

Gets the collection of typedef elements for the object.

System_CAPS_pubpropertyUnions

Gets the collection of union elements for the object.

System_CAPS_pubpropertyUsingAliases

System_CAPS_pubpropertyUsings

Gets the collection of #using elements for the object.

System_CAPS_pubpropertyVariables

Gets the collection of variables for the object.

NameDescription
System_CAPS_pubmethodAbortTransaction()

Halts the current transaction.

System_CAPS_pubmethodAddAttribute(String, String, Object)

Creates a new attribute code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddClass(String, Object, Object, Object, vsCMAccess)

Creates a new class code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddDelegate(String, Object, Object, vsCMAccess)

Creates a new delegate code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddEnum(String, Object, Object, vsCMAccess)

Creates a new enumeration code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddFunction(String, vsCMFunction, Object, Object, vsCMAccess)

Creates a new function code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddIDLImport(String, Object)

Adds a new import statement to the .idl file of the VCFileCodeModel object.

System_CAPS_pubmethodAddIDLLibrary(String, Object)

Adds a new library statement to the .idl file of the VCFileCodeModel object.

System_CAPS_pubmethodAddImport(String, Object, String)

Adds a #import element to the VCFileCodeModel object.

System_CAPS_pubmethodAddImport_2(String, Object, String)

Adds a #import element to the VCFileCodeModel object.

System_CAPS_pubmethodAddInclude(String, Object)

Adds a #include element to the VCFileCodeModel object.

System_CAPS_pubmethodAddInterface(String, Object, Object, vsCMAccess)

Creates a new interface code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddMacro(String, String, Object)

Adds a #define element to the VCFileCodeModel object.

System_CAPS_pubmethodAddMap(String, String, Object)

Adds a map to the object.

System_CAPS_pubmethodAddNamespace(String, Object)

Creates a new namespace code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddStruct(String, Object, Object, Object, vsCMAccess)

Creates a new structure code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddTypedef(String, Object, Object, vsCMAccess)

Adds a typedef statement to the object.

System_CAPS_pubmethodAddUnion(String, Object, vsCMAccess)

Adds a union statement to the object.

System_CAPS_pubmethodAddUsing(String, Object)

Adds a #using element to the VCFileCodeModel object.

System_CAPS_pubmethodAddUsingAlias(String, Object, Object, vsCMAccess)

System_CAPS_pubmethodAddVariable(String, Object, Object, vsCMAccess)

Creates a new variable code construct and inserts the code in the correct location.

System_CAPS_pubmethodBeginBatch()

Not currently implemented.

System_CAPS_pubmethodCodeElementFromFullName(String)

Gets a collection of the specified code elements for the object.

System_CAPS_pubmethodCodeElementFromPoint(TextPoint, vsCMElement)

Gets a code element at a specific location in a source file.

System_CAPS_pubmethodCommitTransaction()

Commits the current transaction for the object.

System_CAPS_pubmethodElementFromID(String)

Not currently implemented.

System_CAPS_pubmethodEndBatch()

Not currently implemented.

System_CAPS_pubmethodRemove(Object)

Removes the specified project from the solution.

System_CAPS_pubmethodRemoveEx(Object, Int32)

Removes the specified project from the solution with an option to delete.

System_CAPS_pubmethodStartTransaction(String)

Begins a transaction.

System_CAPS_pubmethodSynchronize()

Synchronizes all code model objects in the solution with edits made to source files.

System_CAPS_pubmethodValidateMember(String, vsCMElement, String)

Validates that the proposed name is a valid C++ name for the kind given in the context of the parent object.

System_CAPS_pubmethodValidateMemberName(String, vsCMElement, vcCMNameValidationOption)

The VCFileCodeModel object is used to modify an existing source file and the code elements contained within.

System_CAPS_noteNote

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

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

This example retrieves the VCFileCodeModel for the first project item of the current solution. It assumes a default MFC project is open.

Sub GetSourceFile()
    Dim vcFile as VCFileCodeModel
    Dim project as Project
    project = DTE.Solution.Item(1)
    vcFile = project.ProjectItems.Item(1).FileCodeModel
End Sub
Return to top
Show: