Share via


LanguageService.CreateDocumentProperties Method

Instantiates a DocumentProperties class.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
Public Overridable Function CreateDocumentProperties ( _
    mgr As CodeWindowManager _
) As DocumentProperties
public virtual DocumentProperties CreateDocumentProperties(
    CodeWindowManager mgr
)
public:
virtual DocumentProperties^ CreateDocumentProperties(
    CodeWindowManager^ mgr
)
abstract CreateDocumentProperties : 
        mgr:CodeWindowManager -> DocumentProperties  
override CreateDocumentProperties : 
        mgr:CodeWindowManager -> DocumentProperties
public function CreateDocumentProperties(
    mgr : CodeWindowManager
) : DocumentProperties

Parameters

Return Value

Type: Microsoft.VisualStudio.Package.DocumentProperties
If successful, returns a DocumentProperties object; otherwise, returns a null value.

Remarks

The base method always returns a null value (that is, the base implementation does not support extra document properties). If you wish to support additional properties for source files that contain your language, you must create a class derived from DocumentProperties and return an instance of your class.

This method is called from the CodeWindowManager constructor so a new DocumentProperties object is associated with each code window.

.NET Framework Security

See Also

Reference

LanguageService Class

Microsoft.VisualStudio.Package Namespace