Share via


ModelingEditorFactory.IsDocDataSupported Method

Verifies whether a document of a specific format can be used in the modeling editor.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.10.0.dll)

Syntax

'Declaration
Protected Overridable Function IsDocDataSupported ( _
    data As ModelingDocData _
) As Boolean
protected virtual bool IsDocDataSupported(
    ModelingDocData data
)
protected:
virtual bool IsDocDataSupported(
    ModelingDocData^ data
)
abstract IsDocDataSupported : 
        data:ModelingDocData -> bool 
override IsDocDataSupported : 
        data:ModelingDocData -> bool 
protected function IsDocDataSupported(
    data : ModelingDocData
) : boolean

Parameters

Return Value

Type: System.Boolean
true if the document of a specific format can be used in the modeling editor; otherwise, false.

Remarks

You call this method if a user tries to open a document that is open in another Visual Studio editor. If the return value is true, the document in the modeling editor is re-used, and another document is not created. If the return value is false, the user is prompted to close the modeling editor. If the user closes the modeling editor, the standard creation sequence for modeling editors occurs (CreateDocData and then CreateDocView). By default, this method always returns false. You should override it to return a value of true if you want to support documents from other editors.

.NET Framework Security

See Also

Reference

ModelingEditorFactory Class

Microsoft.VisualStudio.Modeling.Shell Namespace