ProjectItem.FileCodeModel - свойство

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает объект FileCodeModel для элемента проекта.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
ReadOnly Property FileCodeModel As FileCodeModel
'Применение
Dim instance As ProjectItem
Dim value As FileCodeModel

value = instance.FileCodeModel

FileCodeModel FileCodeModel { get; }

property FileCodeModel^ FileCodeModel {
    FileCodeModel^ get ();
}

function get FileCodeModel () : FileCodeModel

Значение свойства

Тип: EnvDTE.FileCodeModel
Объект FileCodeModel.

Заметки

Объект FileCodeModel возвращается только для элементов проекта, являющихся файлами кода, и в проектах, реализующих модель кода Visual Studio.

Примеры

Sub FileCodeModelExample()
   ' This goes through the current document using the Visual Studio 
   ' Code Model to add documentation style comments to each function 
   ' similar to  the Visual C# documenation comments.
   Dim projitem As ProjectItem = DTE.ActiveDocument.ProjectItem
   Dim filecm As FileCodeModel = projitem.FileCodeModel
   Dim celt As CodeElement = filecm.CodeElements.Item(1)
   Dim celttype As CodeType = CType(celt, CodeType)
   Dim ep As EditPoint = celttype.GetStartPoint(vsCMPart.vsCMPartHeader).CreateEditPoint()

   For Each celt In celttype.Members
      If (celt.Kind = vsCMElement.vsCMElementFunction) Then
         ' Get Params.
         Dim codefun As CodeFunction = celt
         ep.MoveToPoint(codefun.GetStartPoint(vsCMPart.vsCMPartHeader))
         Dim params As CodeElements = codefun.Parameters

         ' Do comment.
         ep.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
         ep.LineUp()
         ' ep.Indent(Nothing) ' shouldn't need to pass Nothing.
         ep.Insert(Microsoft.VisualBasic.Constants.vbTab & "''' <summary>")
         ep.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
         ep.Insert(Microsoft.VisualBasic.Constants.vbTab & "''' Summary of this sub.")
         ep.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
         ep.Insert(Microsoft.VisualBasic.Constants.vbTab & "''' <summary>")
         ep.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
         ep.Insert(Microsoft.VisualBasic.Constants.vbTab & "''' ")

         Dim celt2 As CodeElement
         Dim cp As CodeParameter
         For Each celt2 In params
            cp = celt2
            ep.Insert("<param name=" & cp.Name & "></param>")
            ep.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
            ep.Insert(Microsoft.VisualBasic.Constants.vbTab & "''' ")
         Next
      End If
   Next
End Sub

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.