Table of Contents

Interface IProjectGraphFiles

Namespace
NDepend.Project
Assembly
NDepend.API.dll

Represents the list of graph files referenced by this project.

public interface IProjectGraphFiles
Extension Methods

Property (1)

GraphFilesRef

Gets all graph files referenced by this project.

IReadOnlyList<IGraphFileRef> GraphFilesRef { get; }

Property Value

IReadOnlyList<IGraphFileRef>

Methods (3)

TryAdd(IFilePath)

Add a graph file referenced by this project.

bool TryAdd(IFilePath filePath)

Parameters

filePath IFilePath

The graph file path.

Returns

bool

false if there is already a graph file referenced by this project, with IGraphFileRef.Path equals to filePath else the graph file gets added and the method returns true.

Remarks

If this method adds a graph file, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.GraphFilesRef_Paths activated.

TryChangeGraphFileRefPath(IFilePath, IFilePath)

Change the path of a graph file referenced by this project.

bool TryChangeGraphFileRefPath(IFilePath filePathOld, IFilePath filePathNew)

Parameters

filePathOld IFilePath

The old path of the graph file to override.

filePathNew IFilePath

The new path of the graph file.

Returns

bool

false if there is no graph file with IGraphFileRef.Path equals to filePathOld.

Remarks

If there is a graph file with IGraphFileRef.Path equals to filePathOld, its path gets overridden by the value filePathNew. If this method modifies the path of a graph file, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.GraphFilesRef_Paths activated.

TryRemove(IFilePath)

Remove a graph file referenced by this project.

bool TryRemove(IFilePath filePath)

Parameters

filePath IFilePath

The graph file path.

Returns

bool

false if there is no graph file with IGraphFileRef.Path equals to filePath, else returns true.

Remarks

If this method removes a graph file, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.GraphFilesRef_Paths activated.

See Also