IRelatedDocList Interface

List of documents related to another document.

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Interface IRelatedDocList
[CLSCompliantAttribute(false)]
public interface IRelatedDocList
[CLSCompliantAttribute(false)]
public interface class IRelatedDocList
[<CLSCompliantAttribute(false)>]
type IRelatedDocList =  interface end
public interface IRelatedDocList

The IRelatedDocList type exposes the following members.

Properties

  Name Description
Public property RelatedDocDataList A read-only copy of the current list.

Top

Methods

  Name Description
Public method GetRegistrationCount Gets the number of times a document has been registered in this list.
Public method RegisterDependentDocument Add a document to this list.
Public method UnregisterDependentDocument Remove a document from this list.

Top

Events

  Name Description
Public event RemovingDocumentFromList Event fired before a document is removed from the RelatedSaveItems list.

Top

Remarks

Contract for SRelatedDocList that is used to access and manage the RelatedSaveItem list owned by ModelingDocData objects

See Also

Reference

Microsoft.VisualStudio.Modeling.Shell Namespace