JetBrains.Platform.DocumentManager

For those documents that are created over project files, exposes the mapping, and allows to create documents over project files on-demand. Uses as the backing store.

If the project file is valid, gets the existing document over the project file, if it has already been created and has not yet expired. Returns null otherwise.

Document for valid project file, null otherwise

Gets the existing document over the project file, if it has already been created and has not yet expired.

If this document has been created over a project file, returns that project file. Otherwise, throws an exception.

Forces all known documents sync with disk. Used primarily to workaround file changes in tests when IFileSystemTracker is disabled. Do not use . Consider using the method instead

IDocumentStorageHelpers component

Manages file-based documents that are backed with s. Simple in-memory documents can be created with and used independently of this class. Note: this class does not (and MUST NOT) have any own logic, it's only an aggregate of single-responsibility components. This prevents circular dependencies.

Limits for legacy code.

Gets document by project item. Creates if it hasn't been created yet for this project file.

Gets the already created document by project item.

The document if it has been already created; otherwise, null.

Gets document by file path.

The document if it has been already created; otherwise, null.

Gets document by file path. Creates if it hasn't been created yet for this disk path.

If this document has been created over a project file, returns that project file. Otherwise, returns Null.

If this document has been created over a project file, returns that project file. Otherwise, throws an exception. For safe check use

Get clearance for write access to the document, for example, at the Source Code Control. You MUST scope file-based-document modifications with this method.

Get clearance for write access to the documents, for example, at the Source Code Control. You MUST scope file-based-document modifications with this method.

Fires before a document is modified. Aggregates the event on all the documents.

Ask Serjik.

Gets the change provider that's firing and .

Returns list of documents corresponding to "shared" project files (i.e. project files with the same location) including the argument.

Any document List of documents corresponding to "shared" project files (i.e. project files with the same location) including the argument.

Just stores the mapping between documents and project files. You should rather use the facade in high-level code, or inside document-vs-project-model cases.

Key for back-mapping from document to project file. Currently, the mapping is stored on the document's userdata (as document lifetime is CLR-defined, while for a project file there's explicit removal).

Fires when a new mapping gets added. Bool set to true when the document is new, otherwise - false. Old document may happen if it was mapped to a path and then remapped to a project file

Fires when a mapping gets explicitly added. Note that it will NOT fire for each item because mappings are weak-references and might expire on their own.

Fires when a mapping gets explicitly removed. Note that it will NOT fire for each item because mappings are weak-references and might expire on their own.

Gets document by project item, if it's already created.

Gets a copy of registered mapped items in a form of a list.

If this document has a mapping to a project file, returns that project file. Otherwise, returns Null.

If this document has a mapping to a project file, returns that project file. Also returns project file if one is invalid (ex. was removed from project model but transaction is committing) Otherwise, returns Null.

Needed to avoid direct dependency from documents/project model to a text control

Checks wether the document with is open in the editor and external change is handled by the editor

Document paths True is the editor handles the external change

Checks wether the document with is open in the editor

Document paths True if document with corresponding path is open in the editor

Subscribes and finds affected project marks by file system path

Return affected project marks by some path

Handles all file system changes and update solution structure

Tells other file system handlers that base project model (solution, projects) have already handled file system changes and other components can also handle this change

Support for Directory.Build.props and Directory.Build.targets see https://docs.microsoft.com/en-us/visualstudio/msbuild/customize-your-build#search-scope

Check if actual reference location mismatch expected hint path

As project files are removed within a transaction, sometimes processing for them must be delayed, as the transaction might be rolled back or something. Listens to project model changes, maintains the list of files removed under transaction, and fires their remove only when transaction gets committed (not rolled back).

Fires when a project file gets removed. If there's no transaction, fires immediately. Under a transaction, fires when it's closed.

Per-solution range marker manager.

Listens to solution-specific events on behalf of .

Schedule documents sync. Null in means no change detected, sync for the sake of consistency

Reason for the sync Shared file location Document changes that triggered sync request. Null means the sync for the sake of consistency

Listens to changes in all the living documents, re-translates them to clients as a single event.

Fires before a document is modified. Aggregates the event on all the documents.

Ask Serjic.

The change provider that's firing and .

When a file-based document is modified, asserts that it's allowed.

Key - Created Item, Value - Original Item

Interface to edit project's (or configuration) msbuild properties Note, the project might need to be reloaded once modified

Returns the value associated with or Null

Property to fetch value Value associated with or Null

Removes the property

Property to remove True if successful

Sets the property value

Property to set value to New property value True if successful

Adds specified file to the project

Parent folder Path to the file being added Additional file metadata and build action Additional untyped data that can be used by AddFileAction. Used in C++ to create files in particular 'filter' Reference to the new project item

Edits project file properties

Project file to edit Action that modifies properties True if succeeded

Adds a directory to the project

/// Parent folder Name of the directory being added Path to the directory being added. If null, folderPath equals parentFolder.Location.Combine(name) Some context Reference to the new project item

Renames the project item. When is an and the file is shared, then all the shared but not linked files will be renamed together with the file.

Project item to rename New name of the project item Whether to rename dependent items as well

Moves the project item so that it becomes a child of the specified parent. If file is linked it will be recreated in new location, so it has to be reloaded after move.

Project item to move newParentItem == null means project becomes a top-level one Some context

Copies the project item so that it's copy becomes a child of the specified parent.

Project item to copy newParentItem == null means project becomes a top-level one If not null, a projectItem copy will have a custom name different from original projectItem.Name Some context Reference to the new project item

Removes project item.

Adds a new project to the solution by using an existing project file. Throws an exception if fails.

The path to the existing project file that should be added to the solution. This value must not be null. The parent project to which the new project will be attached. This value can be null. A that represents the asynchronous operation, with a result of type . The result will contain the newly added project.

Makes the project reference the specified module

Adds the specified library to the project's references

Removes the specified assembly or project from project's references

Removes NuGet package from project

Edit project's (or project configuration) msbuild properties. Project reload might be required when done. In VS the opertaion is async.

Project to alter the properties Configuration to alter the properties. If null the changes applied on project level Function to actually edit properties

Checks is msbuild project properties are editable

Project to edit properties in Reason why the operation is impossible True if properties are editable

Create project file in specified parent folder

Parent folder of project file Custom name of file in case of link creation. If null when name from will be used Location of project file, in case of links doesn't depend on or Build action for the file in the context of Store information of what data the project file was created

Remove existing misc file for the same physical file, we do not need it anymore In R# case Visual Studio manages misc files so there is no such magic there

Sometimes a project file is exists only because of another project file. Example from dotnet6: [Content] Page.txt [AdditionalFiles] Page.txt In this case we should not try to change project file for the second file, just adjust R# project model

An extension which allows to specify a rule to reload a project after changes inside made by R# engine (ProjectModelEditor and friends)

Returns true if project should be reloaded after add/remove/rename change of specified project file

Returns a corresponding project items from referenced shared projects.

Any project item List of project items sharing the same location including the argument in referenced shared projects.

Gets or creates a corresponding project folder from each referenced project.

Project folder from a shared project List of project folders sharing the same location from referenced projects.

Returns a corresponding project items from referenced projects.

Project item from a shared project List of project items sharing the same location from referenced projects.

Use this context to specify `RemoveReference` and `AddReference` should be threated as an update operation