DocData Members

Include Protected Members
Include Inherited Members

A wrapper around a DocData object that provides additional features.

The DocData type exposes the following members.

Constructors

 

Name

Description

Public method

DocData

Overloaded. Initializes a new instance of DocData.

Top

Methods

 

Name

Description

Public method

CheckoutFile

Checks out the doc data file from source code control.

Public method

CreateChangeMarker

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

Public method

Dispose

Overloaded. Disposes the DocData.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

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

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Public method

Modify

Marks this DocData as modified.

Protected method

OnDataChanged

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

Protected method

OnModifying

Called by Modify.

Public method

RaiseModifying

Raises the Modifying event.

Public method

ToString

Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

 

Name

Description

Public property

Buffer

The text buffer contained within the doc data.

Public property

Data

The actual DocData object this class wraps.

Public property

Modified

Determines whether the buffer has been modified

Public property

Name

Gets the file name of the doc data.

Top

Events

 

Name

Description

Public event

DataChanged

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

Public event

Modifying

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

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IVsDocumentLockHolder.CloseDocumentHolder

Close the document based on a user request.

Explicit interface implemetationPrivate method

IVsTextStreamEvents.OnChangeStreamAttributes

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

Explicit interface implemetationPrivate method

IVsTextStreamEvents.OnChangeStreamText

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

Explicit interface implemetationPrivate method

IVsDocumentLockHolder.ShowDocumentHolder

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

Top

See Also

Reference

DocData Class

Microsoft.VisualStudio.Shell.Design.Serialization Namespace