Class ProjectFile

Namespace

RDCore.SDK.Workspace

Assembly

RDCore.SDK.dll

The in-memory model of a workspace's .rdproj project file.

public sealed record ProjectFile : IEquatable<ProjectFile>

Inheritance

object

ProjectFile

Implements

IEquatable<ProjectFile>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProjectFile()

public ProjectFile()

ProjectFile(ProjectFile)

public ProjectFile(ProjectFile source)

Parameters

source ProjectFile

ProjectFile(string)

public ProjectFile(string uri)

Parameters

uri string

ProjectFile(string, RDCoreProject)

public ProjectFile(string uri, RDCoreProject project)

Parameters

uri string

project RDCoreProject

Fields

FileName

The ProjectFile filename is the same for all instances.

public static readonly string FileName

Field Value

string

Properties

Configuration

An array of string values containing the relative paths of configuration settings file(s) included in this project.

public string[] Configuration { get; init; }

Property Value

string[]

IsDirty

true if the project file has unsaved changes.

[JsonIgnore]
public bool IsDirty { get; init; }

Property Value

bool

ProjectInfo

Describes the workspace structure (files, folders, project references, etc.)

public RDCoreProject ProjectInfo { get; init; }

Property Value

RDCoreProject

Uri

The location of the project file on disk.

[JsonIgnore]
public string Uri { get; init; }

Property Value

string

Remarks

This property is assigned on load rather than de/serialized, and serves as the workspace root everything else is relative to.

Version

The RDCore.ServerApp version that this project was created with.

public string Version { get; init; }

Property Value

string

Methods

Equals(ProjectFile?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ProjectFile? other)

Parameters

other ProjectFile

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

WithDocument(RDCoreFile)

public ProjectFile WithDocument(RDCoreFile document)

Parameters

document RDCoreFile

Returns

ProjectFile

WithFolder(string)

public ProjectFile WithFolder(string folder)

Parameters

folder string

Returns

ProjectFile

WithModule(RDCoreModule)

public ProjectFile WithModule(RDCoreModule module)

Parameters

module RDCoreModule

Returns

ProjectFile

WithPrecompilerConstant(string, string)

public ProjectFile WithPrecompilerConstant(string name, string value)

Parameters

name string

value string

Returns

ProjectFile

WithReference(RDCoreReference)

public ProjectFile WithReference(RDCoreReference reference)

Parameters

reference RDCoreReference

Returns

ProjectFile

WithUri(string)

public ProjectFile WithUri(string uri)

Parameters

uri string

Returns

ProjectFile

WithoutDocument(RDCoreFile)

public ProjectFile WithoutDocument(RDCoreFile document)

Parameters

document RDCoreFile

Returns

ProjectFile

WithoutFolder(string)

public ProjectFile WithoutFolder(string folder)

Parameters

folder string

Returns

ProjectFile

WithoutModule(RDCoreModule)

public ProjectFile WithoutModule(RDCoreModule module)

Parameters

module RDCoreModule

Returns

ProjectFile

WithoutPrecompilerConstant(string)

public ProjectFile WithoutPrecompilerConstant(string name)

Parameters

name string

Returns

ProjectFile

WithoutReference(RDCoreReference)

public ProjectFile WithoutReference(RDCoreReference reference)

Parameters

reference RDCoreReference

Returns

ProjectFile