ModelingDocStore Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Shell

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Important

This API is not CLS-compliant.

Class that maintains a 1-1 relationship with the store. Per-store functionality should go here, as opposed to per-file functionality, which should be placed on the ModeingingDocData

public ref class ModelingDocStore : IDisposable

[System.CLSCompliant(false)]
public class ModelingDocStore : IDisposable

public class ModelingDocStore : IDisposable

[<System.CLSCompliant(false)>]
type ModelingDocStore = class
    interface IDisposable

type ModelingDocStore = class
    interface IDisposable

Public Class ModelingDocStore
Implements IDisposable

Inheritance: Object
ModelingDocStore

Attributes: CLSCompliantAttribute

Implements: IDisposable

Constructors

ModelingDocStore(IServiceProvider, Store)

ModelingDocStore constructor

Fields

ModelingDocStoreKey

Key used to index the ModelingDocStore in the store's property bag.

Properties

CanRefreshPropertyBrowser	If this returns false, then the property browser will not be automatically refreshed. This callback is required for transaction commit during delete scenarios. In this case, the undo unit pulls the before selection from the current window, so it must be correct. However, the property browser cannot refresh a deleted ModelElement. This enables derived classes to block the RefreshPropertyBrowser callback.
Context	Context managed by this ModelingDocStore.
ModelingDocuments	Collection of ModelingDocData objects sharing this ModelingDocStore.
ServiceProvider	Service provider, used to retrieve shell services.
ShareCount	Flag indicating if the store is shared by multiple DocData objects.
ShouldDisposeStore	By default, the ModelingDocStore disposes of the store when the last editor is finished with it. Derived classes that want to control the store lifetime can override this to prevent store disposal.
Store	Store managed by this ModelingDocStore.
UndoManager	UndoManager maintained by this ModelingDocStore.

Methods

CanCommit(Transaction)	Query whether top-level transaction commit can proceed based on external criteria.
CanUndoRedo(Boolean, TransactionItem)	Query whether Undo/Redo can proceed based on external criteria.
ConnectDocData(ModelingDocData)	Create a connection between the DocStore and a DocData.
CreateUndoUnit(TransactionItem)	Create Undo Unit.
Dispose()
Dispose(Boolean)
FlushUndoManager()	Flush the transactions maintained by the IMS. Once it’s flushed, one will not be able to undo/redo transactions.
Initialize()	Called after the store is loaded, to allow derived classes to perform initialization, such as adding event handlers, etc., that requires a loaded store.
RemoveDocData(ModelingDocData)	Remove a connection between the DocStore and a DocData.
SetEncoding(Encoding)	Sets the encoding for each doc data linked to the store

Applies to

Share via