DocData Class

 

A wrapper around a DocData object that provides additional features.

Namespace:   Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

System.Object
  Microsoft.VisualStudio.Shell.Design.Serialization.DocData

[CLSCompliantAttribute(false)]
public class DocData : IDisposable, IVsTextStreamEvents, IVsDocumentLockHolder

NameDescription
System_CAPS_pubmethodDocData(IServiceProvider, String)

Initializes a new instance of DocData from the specified file and sets the site from the specified site.

System_CAPS_pubmethodDocData(Object)

Initializes a new DocData object for the given buffer.

NameDescription
System_CAPS_pubpropertyBuffer

The text buffer contained within the doc data.

System_CAPS_pubpropertyData

The actual DocData object this class wraps.

System_CAPS_pubpropertyModified

Determines whether the buffer has been modified

System_CAPS_pubpropertyName

Gets the file name of the doc data.

NameDescription
System_CAPS_pubmethodCheckoutFile(IServiceProvider)

Checks out the doc data file from source code control.

System_CAPS_pubmethodCreateChangeMarker()

Marks the beginning of an external change of the text buffer.

System_CAPS_pubmethodDispose()

Disposes the DocData.

System_CAPS_protmethodDispose(Boolean)

Disposes the DocData.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

Called automatically when this object is destroyed.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodModify()

Marks this DocData as modified.

System_CAPS_protmethodOnDataChanged(EventArgs)

Called when an external change has been made to the doc data.

System_CAPS_protmethodOnModifying(EventArgs)

Called by Modify.

System_CAPS_pubmethodRaiseModifying()

Raises the Modifying event.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDataChanged

An event that is raised when the data contained within this doc data has changed.

System_CAPS_pubeventModifying

An event that is raised when this DocData object is being marked as modified.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsDocumentLockHolder.CloseDocumentHolder(UInt32)

Close the document based on a user request.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsDocumentLockHolder.ShowDocumentHolder()

Called by Visual Studio to show the window frame associated with this document.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTextStreamEvents.OnChangeStreamAttributes(Int32, Int32)

A notification from Visual Studio that something in the text has changed.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTextStreamEvents.OnChangeStreamText(Int32, Int32, Int32, Int32)

Provides a notification from Visual Studio that something in the text has changed.

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: