ModelingEditorFactory Class

 

Provides support for the modeling editor factory, which enables the Visual Studio shell to obtain an editor for a specific file type.

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

System::Object
  Microsoft.VisualStudio.Modeling.Shell::ModelingEditorFactory

[CLSCompliantAttribute(false)]
public ref class ModelingEditorFactory abstract : IVsEditorFactory, 
	IVsSolutionEvents

NameDescription
System_CAPS_protmethodModelingEditorFactory(IServiceProvider^)

Initializes a new instance of the ModelingEditorFactory class.

NameDescription
System_CAPS_protpropertyCancelEditorCreate

Gets the value of the cancelEditorCreate flag. If this value is larger than 0, this property prevents the modeling editor from being created and sets this flag to 0.

System_CAPS_protpropertyFlags

Gets a list of flags, which define how the modeling editor is created.

System_CAPS_protpropertyServiceProvider

Gets the service provider that retrieves Visual Studio services.

NameDescription
System_CAPS_pubmethodClose()

Releases all cached interface pointers and unregisters any event synchronizations.

System_CAPS_protmethodCreateDocData()

Creates a document in memory.

System_CAPS_pubmethodCreateDocData(String^, IVsHierarchy^, UInt32)

Creates a document in memory.

System_CAPS_protmethodCreateDocView(ModelingDocData^, String^, String^)

Creates a document in memory.

System_CAPS_pubmethodCreateEditorInstance(UInt32, String^, String^, IVsHierarchy^, UInt32, IntPtr, IntPtr, IntPtr, String^, Guid, Int32)

Creates a modeling editor.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetDocData(Object^)

Gets a document.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetItemErrorListProvider(IVsHierarchy^, UInt32)

Get an error list provider for the specified project item (assumed to be a modeling doc data). If there is no existing error list provider for the item, then one is created.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodHandleEditorCreationException(String^, Exception^)

Handles an exception if one occurs when an additional modeling editor is created.

System_CAPS_protmethodIsDocDataSupported(ModelingDocData^)

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

System_CAPS_protmethodMapLogicalView(Guid, Object^)

Maps a logical view's GUID to a physical view.

System_CAPS_pubmethodMapLogicalView(Guid, String^)

Maps a logical view's GUID to a physical view.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnAfterCloseSolution(Object^)

Notifies listening clients that the modeling editor has closed.

System_CAPS_pubmethodOnAfterLoadProject(IVsHierarchy^, IVsHierarchy^)

Notifies listening clients that the project has loaded.

System_CAPS_pubmethodOnAfterOpenProject(IVsHierarchy^, Int32)

Notifies listening clients that the project has opened.

System_CAPS_pubmethodOnAfterOpenSolution(Object^, Int32)

Notifies listening clients that the modeling editor has opened.

System_CAPS_pubmethodOnBeforeCloseProject(IVsHierarchy^, Int32)

Notifies listening clients that the project is about to be closed.

System_CAPS_pubmethodOnBeforeCloseSolution(Object^)

Notifies listening clients that the modeling editor is about to be closed.

System_CAPS_pubmethodOnBeforeUnloadProject(IVsHierarchy^, IVsHierarchy^)

Notifies listening clients that the project is about to be unloaded.

System_CAPS_pubmethodOnQueryCloseProject(IVsHierarchy^, Int32, Int32)

Queries listening clients as to whether the project can be closed.

System_CAPS_pubmethodOnQueryCloseSolution(Object^, Int32)

Notifies listening clients that the modeling editor has closed.

System_CAPS_pubmethodOnQueryUnloadProject(IVsHierarchy^, Int32)

Queries listening clients as to whether the project can be unloaded.

System_CAPS_pubmethodSetSite(IServiceProvider^)

Sets the service provider from which to access shell services.

System_CAPS_pubmethodToString()

(Inherited from Object.)

You can use this class to create, monitor, and close the modeling editor. The modeling editor is represented by the DocData object and the DocView object. The DocData object represents a document in memory, and the DocView object represents a view for the document. Within the modeling editor, a document can have multiple views assigned to it.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: