LanguageService.CreateDocumentProperties(CodeWindowManager) Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

Instantiates a Microsoft.Office.Core.DocumentProperties class.

public:
 virtual Microsoft::VisualStudio::Package::DocumentProperties ^ CreateDocumentProperties(Microsoft::VisualStudio::Package::CodeWindowManager ^ mgr);

public virtual Microsoft.VisualStudio.Package.DocumentProperties CreateDocumentProperties (Microsoft.VisualStudio.Package.CodeWindowManager mgr);

abstract member CreateDocumentProperties : Microsoft.VisualStudio.Package.CodeWindowManager -> Microsoft.VisualStudio.Package.DocumentProperties
override this.CreateDocumentProperties : Microsoft.VisualStudio.Package.CodeWindowManager -> Microsoft.VisualStudio.Package.DocumentProperties

Public Overridable Function CreateDocumentProperties (mgr As CodeWindowManager) As DocumentProperties

Parameters

mgr

CodeWindowManager

[in] A CodeWindowManager object that the document properties can refer to.

Returns

DocumentProperties

If successful, returns a Microsoft.Office.Core.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 Microsoft.Office.Core.DocumentProperties and return an instance of your class.

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