ProjectReference Class

Summary

Represents a project reference to another project.
Namespace
Cake.Common.Solution.Project
Base Types
  • object
graph BT Type-->Base0["object"] Type["ProjectReference"] class Type type-node

Syntax

public sealed class ProjectReference

Remarks

Schema from https://msdn.microsoft.com/en-us/library/ms164283.aspx and https://msdn.microsoft.com/en-us/library/bb629388.aspx.

Properties

Name Value Summary
FilePath FilePath
Gets or sets the path to the referenced project file.
Name string
Gets or sets the display name of the reference.
Package FilePath
Gets or sets the path of the project file that is being referenced.
Private bool?
Gets or sets whether the reference should be copied to the output folder.
Project string
Gets or sets a GUID for the reference.
RelativePath string
Gets or sets the relative path to the referenced project file.

Extension Methods

Name Value Summary
Dump<ProjectReference>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ProjectReference>(ProjectReference[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ProjectReference>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ProjectReference>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ProjectReference>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ProjectReference>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin