XmlStore Class

Article
09/30/2015

Manages the XmlModel objects.

Namespace: Microsoft.VisualStudio.XmlEditor
Assembly: Microsoft.VisualStudio.XmlEditor (in Microsoft.VisualStudio.XmlEditor.dll)

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.XmlEditor.XmlStore

Syntax

[CLSCompliantAttribute(false)]
public abstract class XmlStore : IDisposable

[CLSCompliantAttribute(false)]
public ref class XmlStore abstract : IDisposable

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type XmlStore = 
    class
        interface IDisposable
    end

<CLSCompliantAttribute(False)>
Public MustInherit Class XmlStore
    Implements IDisposable

Constructors

	Name	Description
	XmlStore()	Initializes a new instance of the XmlStore class.

Properties

	Name	Description
	CurrentEditingScope	Gets the current XmlEditingScope that is associated with this store.
	SynchronizingObject	Gets or sets the ISynchronizeInvoke object.
	UndoManager	Get or set the IOleUndoManager associated with this XmlStore.
	XmlModels	Gets a list of all open XmlModel objects that are associated with this store.

Methods

	Name	Description
	BeginEditingScope(String, Object)	Begins a new editing operation on one or more models in this XmlStore.
	Dispose()	Releases all resources used by the current instance of the XmlStore class.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	OpenXmlModel(Uri)	Loads a new XmlModel for the specified file name.
	ToString()	(Inherited from Object.)

Events

	Name	Description
	EditingScopeCompleted	Occurs when edit operations have completed. This can be either when XmlEditingScope objects are created using the XmlEditingScope method or when the user makes changes in the XML Editor text view.
	UndoRedoCompleted	Occurs when a new XmlEditingScope object has been created as a result of an undo/redo operation.

Remarks

You only need one XmlStore object to manage all the XML files that you are editing in your designer. The current list of open XmlModel objects is the scope for any changes you make to those models. The XmlStore object tracks changes to the model when an XmlEditingScope is active and raises an EditingScopeCompleted event whenever the XmlEditingScope is completed or reverted, or when an undo/redo operation is performed.

Thread Safety

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