IRelatedDocList Interface

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.

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

C++

public interface class IRelatedDocList

[System.CLSCompliant(false)]
public interface IRelatedDocList

public interface IRelatedDocList

[<System.CLSCompliant(false)>]
type IRelatedDocList = interface

type IRelatedDocList = interface

Public Interface IRelatedDocList

Attributes: CLSCompliantAttribute

Properties

RelatedDocDataList

Read-only Collection of unique RelatedSaveItems stored in this list

Methods

GetRegistrationCount(DocData)	Fetches the number of times a document has been registered in this list.
RegisterDependentDocument(DocData)	Implementers must Add/Register DocData to the RelatedSaveItemsList dictionary
UnregisterDependentDocument(DocData)	Implementers must Remove/Unregister DocData from the RelatedSaveItemsList dictionary. Also, potentially fires the OnBeforeDocumentRemovedFromList event.

Events

RemovingDocumentFromList

Event fired before a document is removed from the RelatedSaveItems list.

Applies to

Product	Versions
Visual Studio SDK	2017, 2019, 2022

Share via