ProjectFile (Paket)

ProjectFile Type

Namespace: Paket
Assembly: Paket.Core.dll
Base Type: obj
All Interfaces: IEquatable<ProjectFile> , IStructuralEquatable

Contains methods to read and manipulate project files.

Record fields

Record Field	Description
`CalculatedProperties` Full Usage: `CalculatedProperties` Field type: `ConcurrentDictionary<Map<string, string>, Map<string, string>>` Modifiers: mutable	Field type: `ConcurrentDictionary<Map<string, string>, Map<string, string>>`
`DefaultProperties` Full Usage: `DefaultProperties` Field type: `Map<string, string> option` Modifiers: mutable	Field type: `Map<string, string> option`
`Document` Full Usage: `Document` Field type: `XmlDocument`	Field type: `XmlDocument`
`FileName` Full Usage: `FileName` Field type: `string`	Field type: `string`
`Language` Full Usage: `Language` Field type: `ProjectLanguage`	Field type: `ProjectLanguage`
`OriginalText` Full Usage: `OriginalText` Field type: `string`	Field type: `string`
`ProjectNode` Full Usage: `ProjectNode` Field type: `XmlNode`	Field type: `XmlNode`

Instance members

Instance member	Description
`this.AddImportForPaketTargets` Full Usage: `this.AddImportForPaketTargets` Parameters: relativeTargetsPath : `string`	relativeTargetsPath : `string`
`this.AppendTargetFrameworkToOutputPath` Full Usage: `this.AppendTargetFrameworkToOutputPath` Returns: `bool`	Returns: `bool`
`this.BuildOutputTargetFolder` Full Usage: `this.BuildOutputTargetFolder` Returns: `string option`	Returns: `string option`
`this.CreateNode` Full Usage: `this.CreateNode` Parameters: name : `string` text : `string` Returns: `XmlElement`	name : `string` text : `string` Returns: `XmlElement`
`this.CreateNode` Full Usage: `this.CreateNode` Parameters: name : `string` Returns: `XmlElement`	name : `string` Returns: `XmlElement`
`this.DeleteCustomModelNodes` Full Usage: `this.DeleteCustomModelNodes` Parameters: model : `InstallModel`	model : `InstallModel`
`this.DeleteIfEmpty` Full Usage: `this.DeleteIfEmpty` Parameters: name : `string` Returns: `bool`	name : `string` Returns: `bool`
`this.DeletePaketNodes` Full Usage: `this.DeletePaketNodes` Parameters: name : `string`	name : `string`
`this.DetermineBuildAction` Full Usage: `this.DetermineBuildAction` Parameters: fileName : `string` Returns: `BuildAction`	fileName : `string` Returns: `BuildAction`
`this.DetermineBuildActionForRemoteItems` Full Usage: `this.DetermineBuildActionForRemoteItems` Parameters: fileName : `string` Returns: `BuildAction`	fileName : `string` Returns: `BuildAction`
`this.FindCorrespondingFile` Full Usage: `this.FindCorrespondingFile` Parameters: correspondingFile : `string` Returns: `string option`	correspondingFile : `string` Returns: `string option`
`this.FindLocalizedLanguageNames` Full Usage: `this.FindLocalizedLanguageNames` Returns: `string list`	Returns: `string list`
`this.FindOrCreateReferencesFile` Full Usage: `this.FindOrCreateReferencesFile` Returns: `ReferencesFile`	Returns: `ReferencesFile`
`this.FindPaketNodes` Full Usage: `this.FindPaketNodes` Parameters: name : `string` Returns: `XmlNode list`	name : `string` Returns: `XmlNode list`
`this.FindReferencesFile` Full Usage: `this.FindReferencesFile` Returns: `string option`	Returns: `string option`
`this.FindTemplatesFile` Full Usage: `this.FindTemplatesFile` Returns: `string option`	Returns: `string option`
`this.GenerateXml` Full Usage: `this.GenerateXml` Parameters: model : `InstallModel` usedFrameworkLibs : `HashSet<TargetProfile * string>` aliases : `Map<string, string>` embedInteropTypes : `bool option` copyLocal : `bool option` specificVersion : `bool option` importTargets : `bool` allTargetProfiles : `'a` referenceCondition : `string option` Returns: `XmlContext` Type parameters: 'a (requires :> Paket.TargetProfile Microsoft.FSharp.Collections.seq)	model : `InstallModel` usedFrameworkLibs : `HashSet<TargetProfile * string>` aliases : `Map<string, string>` embedInteropTypes : `bool option` copyLocal : `bool option` specificVersion : `bool option` importTargets : `bool` allTargetProfiles : `'a` referenceCondition : `string option` Returns: `XmlContext`
`this.GetAllInterProjectDependenciesWithProjectTemplates` Full Usage: `this.GetAllInterProjectDependenciesWithProjectTemplates` Parameters: cache : `PackProcessCache` Returns: `ProjectFile list`	cache : `PackProcessCache` Returns: `ProjectFile list`
`this.GetAllInterProjectDependenciesWithoutProjectTemplates` Full Usage: `this.GetAllInterProjectDependenciesWithoutProjectTemplates` Parameters: cache : `PackProcessCache` Returns: `ProjectFile list`	cache : `PackProcessCache` Returns: `ProjectFile list`
`this.GetAllReferencedProjects` Full Usage: `this.GetAllReferencedProjects` Parameters: onlyWithOutput : `bool` cache : `PackProcessCache` Returns: `ProjectFile list`	onlyWithOutput : `bool` cache : `PackProcessCache` Returns: `ProjectFile list`
`this.GetAssemblyName` Full Usage: `this.GetAssemblyName` Returns: `string`	Returns: `string`
`this.GetCliToolReferences` Full Usage: `this.GetCliToolReferences` Returns: `string list`	Returns: `string list`
`this.GetCompileItems` Full Usage: `this.GetCompileItems` Parameters: includeReferencedProjects : `bool` cache : `PackProcessCache` Returns: `CompileItem seq`	includeReferencedProjects : `bool` cache : `PackProcessCache` Returns: `CompileItem seq`
`this.GetCustomModelNodes` Full Usage: `this.GetCustomModelNodes` Parameters: model : `InstallModel` Returns: `XmlNode list`	model : `InstallModel` Returns: `XmlNode list`
`this.GetCustomReferenceAndFrameworkNodes` Full Usage: `this.GetCustomReferenceAndFrameworkNodes` Returns: `XmlNode list`	Returns: `XmlNode list`
`this.GetFrameworkAssemblies` Full Usage: `this.GetFrameworkAssemblies` Returns: `string list`	Returns: `string list`
`this.GetInterProjectDependencies` Full Usage: `this.GetInterProjectDependencies` Returns: `ProjectReference list`	Returns: `ProjectReference list`
`this.GetOutputDirectory` Full Usage: `this.GetOutputDirectory` Parameters: buildConfiguration : `string` buildPlatform : `string` targetFramework : `TargetProfile option` Returns: `string`	buildConfiguration : `string` buildPlatform : `string` targetFramework : `TargetProfile option` Returns: `string`
`this.GetPackageReferences` Full Usage: `this.GetPackageReferences` Returns: `string list`	Returns: `string list`
`this.GetPaketFileItems` Full Usage: `this.GetPaketFileItems` Returns: `FileInfo list`	Returns: `FileInfo list`
`this.GetProjectGuid` Full Usage: `this.GetProjectGuid` Returns: `Guid`	Returns: `Guid`
`this.GetProjects` Full Usage: `this.GetProjects` Parameters: includeReferencedProjects : `bool` cache : `PackProcessCache` Returns: `ProjectFile list`	includeReferencedProjects : `bool` cache : `PackProcessCache` Returns: `ProjectFile list`
`this.GetProperty` Full Usage: `this.GetProperty` Parameters: propertyName : `string` Returns: `string option`	propertyName : `string` Returns: `string option`
`this.GetPropertyWithDefaults` Full Usage: `this.GetPropertyWithDefaults` Parameters: propertyName : `string` defaultProperties : `Map<string, string>` Returns: `string option`	propertyName : `string` defaultProperties : `Map<string, string>` Returns: `string option`
`this.GetTargetFrameworkIdentifier` Full Usage: `this.GetTargetFrameworkIdentifier` Returns: `string option`	Returns: `string option`
`this.GetTargetFrameworkProfile` Full Usage: `this.GetTargetFrameworkProfile` Returns: `string option`	Returns: `string option`
`this.GetTargetProfiles` Full Usage: `this.GetTargetProfiles` Returns: `TargetProfile list`	Returns: `TargetProfile list`
`this.GetTemplateMetadata` Full Usage: `this.GetTemplateMetadata` Returns: `ProjectCoreInfo * OptionalPackagingInfo`	Returns: `ProjectCoreInfo * OptionalPackagingInfo`
`this.GetToolsVersion` Full Usage: `this.GetToolsVersion` Returns: `float`	Returns: `float`
`this.HasPackageInstalled` Full Usage: `this.HasPackageInstalled` Parameters: groupName : `GroupName` package : `PackageName` Returns: `bool`	groupName : `GroupName` package : `PackageName` Returns: `bool`
`this.HasTemplateFile` Full Usage: `this.HasTemplateFile` Returns: `bool`	Returns: `bool`
`this.Name` Full Usage: `this.Name` Returns: `string`	Returns: `string`
`this.NameWithoutExtension` Full Usage: `this.NameWithoutExtension` Returns: `string`	Returns: `string`
`this.OutputType` Full Usage: `this.OutputType` Returns: `ProjectOutputType`	Returns: `ProjectOutputType`
`this.ProjectsWithTemplates` Full Usage: `this.ProjectsWithTemplates` Parameters: projects : `ProjectFile list` Returns: `ProjectFile list`	projects : `ProjectFile list` Returns: `ProjectFile list`
`this.ProjectsWithoutTemplates` Full Usage: `this.ProjectsWithoutTemplates` Parameters: projects : `ProjectFile list` Returns: `ProjectFile list`	projects : `ProjectFile list` Returns: `ProjectFile list`
`this.RemoveCliToolReferenceEntries` Full Usage: `this.RemoveCliToolReferenceEntries`
`this.RemoveImportAndTargetEntries` Full Usage: `this.RemoveImportAndTargetEntries` Parameters: packages : `(string * SemVerInfo) list`	packages : `(string * SemVerInfo) list`
`this.RemoveImportForPaketTargets` Full Usage: `this.RemoveImportForPaketTargets`
`this.RemoveNuGetPackageImportStamp` Full Usage: `this.RemoveNuGetPackageImportStamp`
`this.RemoveNuGetTargetsEntries` Full Usage: `this.RemoveNuGetTargetsEntries`
`this.RemoveNugetAnalysers` Full Usage: `this.RemoveNugetAnalysers` Parameters: packages : `(string * SemVerInfo) list`	packages : `(string * SemVerInfo) list`
`this.RemovePackageReferenceEntries` Full Usage: `this.RemovePackageReferenceEntries`
`this.RemovePaketNodes` Full Usage: `this.RemovePaketNodes`
`this.ReplaceNuGetPackagesFile` Full Usage: `this.ReplaceNuGetPackagesFile`
`this.Save` Full Usage: `this.Save` Parameters: forceTouch : `bool`	forceTouch : `bool`
`this.SetOrCreateAutoGenerateBindingRedirects` Full Usage: `this.SetOrCreateAutoGenerateBindingRedirects`
`this.TryFindConfigFile` Full Usage: `this.TryFindConfigFile` Returns: `FileInfo option`	Returns: `FileInfo option`
`this.UpdateFileItems` Full Usage: `this.UpdateFileItems` Parameters: fileItems : `FileItem list`	fileItems : `FileItem list`
`this.UpdateReferences` Full Usage: `this.UpdateReferences` Parameters: completeModel : `Map<(GroupName * PackageName), ('a * InstallModel)>` directDependencies : `Map<(GroupName * PackageName), ('b * InstallSettings)>` usedPackages : `Map<(GroupName * PackageName), ('c * InstallSettings)>` Type parameters: 'a, 'b, 'c	completeModel : `Map<(GroupName * PackageName), ('a * InstallModel)>` directDependencies : `Map<(GroupName * PackageName), ('b * InstallSettings)>` usedPackages : `Map<(GroupName * PackageName), ('c * InstallSettings)>`

Static members

Static member	Description
`ProjectFile.FindAllProjectFiles(folder)` Full Usage: `ProjectFile.FindAllProjectFiles(folder)` Parameters: folder : `string` Returns: `FileInfo[]`	Finds all project files folder : `string` Returns: `FileInfo[]`
`ProjectFile.FindAllProjects(folder)` Full Usage: `ProjectFile.FindAllProjects(folder)` Parameters: folder : `string` Returns: `ProjectFile[]`	Finds all project files folder : `string` Returns: `ProjectFile[]`
`ProjectFile.FindCorrespondingFile(projectFile, correspondingFile)` Full Usage: `ProjectFile.FindCorrespondingFile(projectFile, correspondingFile)` Parameters: projectFile : `FileInfo` correspondingFile : `string` Returns: `string option`	projectFile : `FileInfo` correspondingFile : `string` Returns: `string option`
`ProjectFile.FindOrCreateReferencesFile(projectFile)` Full Usage: `ProjectFile.FindOrCreateReferencesFile(projectFile)` Parameters: projectFile : `FileInfo` Returns: `ReferencesFile`	projectFile : `FileInfo` Returns: `ReferencesFile`
`ProjectFile.FindReferencesFile(projectFile)` Full Usage: `ProjectFile.FindReferencesFile(projectFile)` Parameters: projectFile : `FileInfo` Returns: `string option`	projectFile : `FileInfo` Returns: `string option`
`ProjectFile.LoadFromFile(fileName)` Full Usage: `ProjectFile.LoadFromFile(fileName)` Parameters: fileName : `string` Returns: `ProjectFile`	fileName : `string` Returns: `ProjectFile`
`ProjectFile.LoadFromStream(fullName, stream)` Full Usage: `ProjectFile.LoadFromStream(fullName, stream)` Parameters: fullName : `string` stream : `Stream` Returns: `ProjectFile`	fullName : `string` stream : `Stream` Returns: `ProjectFile`
`ProjectFile.LoadFromString(fullName, text)` Full Usage: `ProjectFile.LoadFromString(fullName, text)` Parameters: fullName : `string` text : `string` Returns: `ProjectFile`	fullName : `string` text : `string` Returns: `ProjectFile`
`ProjectFile.SearchAllProjectRelatedFiles(searchPattern) (folder)` Full Usage: `ProjectFile.SearchAllProjectRelatedFiles(searchPattern) (folder)` Parameters: searchPattern : `string` folder : `string` Returns: `FileInfo[]`	searchPattern : `string` folder : `string` Returns: `FileInfo[]`
`ProjectFile.TryFindProject(projects, projectName)` Full Usage: `ProjectFile.TryFindProject(projects, projectName)` Parameters: projects : `ProjectFile seq` projectName : `string` Returns: `ProjectFile option`	projects : `ProjectFile seq` projectName : `string` Returns: `ProjectFile option`
`ProjectFile.TryLoad(fileName)` Full Usage: `ProjectFile.TryLoad(fileName)` Parameters: fileName : `string` Returns: `ProjectFile option`	fileName : `string` Returns: `ProjectFile option`