Pri.Essentials.DotnetPsCmds.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>Pri.Essentials.DotnetPsCmds</name> </assembly> <members> <member name="T:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet"> <summary> Defines a cmdlet that adds a NuGet package reference to a .NET project within a solution. </summary> <remarks> This cmdlet is intended for use in PowerShell scripts or interactive sessions to automate the process of adding package dependencies to .NET projects. The cmdlet supports confirmation prompts and can be used with PowerShell's ShouldProcess pattern for safe execution. The output is the updated project with the new package reference applied. </remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.PackageId"> <summary> Gets or sets the identifier of the package to add to the project. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.PackageVersion"> <summary> Gets or sets the version of the package to add to the project. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.Project"> <summary> Gets or sets the project to add to the solution. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.Prerelease"> <summary> Gets or sets a value indicating whether prerelease packages are allowed to be installed. </summary> <remarks>If set to <see langword="true"/>, prerelease versions of packages may be included during installation. If <see langword="false"/>, only stable package versions are considered. If <see langword="null"/>, the default behavior is used.</remarks> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetPackageCmdlet.DetermineCommand(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetProject,System.String,System.String,System.Boolean)"> <summary> </summary> <param name="executor"></param> <param name="project"></param> <param name="packageId"></param> <param name="packageVersion"></param> <param name="isPrerelease"></param> <returns></returns> </member> <member name="T:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet"> <summary> Defines a cmdlet that adds a NuGet package reference to a .NET project within a solution. </summary> <remarks> This cmdlet is intended for use in PowerShell scripts or interactive sessions to automate the process of adding package dependencies to .NET projects. The cmdlet supports confirmation prompts and can be used with PowerShell's ShouldProcess pattern for safe execution. The output is the updated project with the new package reference applied. </remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet.Project"> <summary> Gets or sets the project to add to the solution. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet.PackageIds"> <summary> Gets or sets the identifier of the package to add to the project. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet.Prerelease"> <summary> Gets or sets a value indicating whether prerelease packages are allowed to be installed. </summary> <remarks>If set to <see langword="true"/>, prerelease versions of packages may be included during installation. If <see langword="false"/>, only stable package versions are considered. If <see langword="null"/>, the default behavior is used.</remarks> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetPackagesCmdlet.DetermineCommand(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetProject,System.String,System.Boolean)"> <summary> </summary> <param name="executor"></param> <param name="project"></param> <param name="packageId"></param> <param name="isPrerelease"></param> <returns></returns> </member> <member name="T:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet"> <summary> Represents a PowerShell cmdlet that adds a .NET project to an existing solution using the dotnet CLI. </summary> <remarks>This cmdlet supports ShouldProcess, enabling confirmation prompts and WhatIf support. Use this cmdlet to programmatically add a project to a solution file within automation scripts or interactive PowerShell sessions. The cmdlet writes the updated solution object to the output pipeline upon successful completion.</remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet.Solution"> <summary> Gets or sets the solution to which the project will be added. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet.Project"> <summary> </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet.SolutionFolder"> <summary> Gets or sets the solution folder to which the project will be added. </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetProjectCmdlet.EndProcessing"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetPsCmds.AddDotnetProjectReferenceCmdlet"> <summary> Represents a PowerShell cmdlet that adds a .NET project reference to an existing .NET project using the dotnet CLI. </summary> <remarks>This cmdlet supports ShouldProcess, enabling confirmation prompts and WhatIf support. Use this cmdlet to programmatically add a project to a solution file within automation scripts or interactive PowerShell sessions. The cmdlet writes the updated solution object to the output pipeline upon successful completion.</remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetProjectReferenceCmdlet.Project"> <summary> </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.AddDotnetProjectReferenceCmdlet.TargetProject"> <summary> </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetProjectReferenceCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetProjectReferenceCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.AddDotnetProjectReferenceCmdlet.EndProcessing"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet"> <summary> Implements the New_DotnetProject Cmdlet. <param type="synopsis">Creates a new .NET project.</param> <param type="description">Creates a new .NET project.</param> </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.TemplateName"> <summary> The parameter to the <code>dotnet new sln --template</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.OutputDirectory"> <summary> The parameter to the <code>dotnet new sln --output</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.OutputName"> <summary> The parameter to the <code>dotnet new sln --name</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.FrameworkName"> <summary> The parameter to the <code>dotnet new sln --name</code> option </summary> <remarks>TODO: set default based on global.json if present</remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.Solution"> <summary> Gets or sets the solution to which the project will be added. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.SolutionFolder"> <summary> Gets or sets the solution folder to which the project will be added. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.ShouldGenerateDocumentationFile"> <summary> Gets or sets a value indicating whether to generate XML documentation </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.CreateDotnetProjectCmdlet.EndProcessing"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet"> <summary> Implements the New_DotnetSolution Cmdlet. <para type="synopsis">Creates a new .NET solution.</para> </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet.OutputDirectory"> <summary> The parameter to the <code>dotnet new sln --output</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet.OutputName"> <summary> The parameter to the <code>dotnet new sln --name</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet.FrameworkName"> <summary> Which .NET framework version to use. </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.CreateDotnetSolutionCmdlet.EndProcessing"> <summary> Performs end-of-processing tasks after all pipeline input has been received and processed. </summary> <remarks> This method is called once at the end of pipeline execution. It is not invoked if no input is received by the cmdlet. Override this method to implement any cleanup or finalization logic that should occur after all input has been processed. </remarks> </member> <member name="T:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet"> <summary> Edit_DotnetProject </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.Project"> <summary> The target project to modify. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.Path"> <summary> The path to the target project to modify. </summary>AndArray </member> <member name="P:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.Properties"> <summary> An array of strings that represent property name/value pairs. </summary> </member> <member name="P:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.InternalsVisibleTo"> <summary> Gets or sets the list of assembly names that are granted access to internal types and members of this assembly via the InternalsVisibleTo attribute. </summary> <remarks>Specify the names of friend assemblies that should be able to access internal members. Each entry should be the full name of an assembly. If no assemblies are specified, internal members remain inaccessible to other assemblies.</remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.SuppressMessage"> <summary> SuppressMessageAttribute details. </summary> <remarks> <code> -SuppressMessage @{Category="Category"; CheckId="PR1000"} </code> </remarks> </member> <member name="P:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.PropertiesObject"> <summary> The properties, as a hash table, to set in the project file. </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetPsCmds.EditDotnetProjectCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetPsCmds.KeyValueExtensions"> <summary> Temporary class until available in Pri.ProductivityExtensions.Source </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.KeyValueExtensions.Deconstruct``2(System.Collections.Generic.KeyValuePair{``0,``1},``0@,``1@)"> <inheritdoc cref="M:Pri.Essentials.DotnetPsCmds.KeyValueExtensions.<G>$F9A05F0C2727948431BAFCE09F60AA7B`2.Deconstruct(`0@,`1@)"/> </member> <member name="T:Pri.Essentials.DotnetPsCmds.KeyValueExtensions.<G>$F9A05F0C2727948431BAFCE09F60AA7B`2.<M>$529D8614268EB0C0A34B0A644CCBBC6B"> <param name="kvp"></param> <typeparam name="TKey"></typeparam> <typeparam name="TValue"></typeparam> </member> <member name="M:Pri.Essentials.DotnetPsCmds.KeyValueExtensions.<G>$F9A05F0C2727948431BAFCE09F60AA7B`2.Deconstruct(`0@,`1@)"> <summary> A Deconstruct method for KeyValuePair </summary> <param name="key"></param> <param name="value"></param> </member> <member name="T:Pri.Essentials.DotnetPsCmds.EditDotnetProjectService"> <summary> A service class that encapsulates support functionality needed when executing the Edit-DotnetProject cmdlet </summary> </member> <member name="M:Pri.Essentials.DotnetPsCmds.EditDotnetProjectService.ProcessPropertyRequests(System.Management.Automation.Cmdlet,System.Collections.Generic.Dictionary{System.String,System.Object},Pri.Essentials.DotnetProjects.VisualStudioProjectConfigurationService)"> <summary> A service method to process properties details </summary> <param name="cmdlet"></param> <param name="properties"></param> <param name="projectConfigurationService"></param> <returns></returns> </member> <member name="M:Pri.Essentials.DotnetPsCmds.EditDotnetProjectService.DetermineActionDescription``1(System.String[],System.Collections.Generic.IReadOnlyDictionary{System.String,``0})"> <summary> A service method to determine the description displayed for the action based on the properties passed in. </summary> <typeparam name="T"></typeparam> <param name="internalsVisibleTo"></param> <param name="properties"></param> <returns></returns> </member> <member name="M:Pri.Essentials.DotnetPsCmds.EditDotnetProjectService.DetermineProjectFileFullPath(Pri.Essentials.DotnetProjects.DotnetProject,System.String,System.Management.Automation.SessionState)"> <summary> A service method to determine the full path of the project based on the current session directory and provided project or path. </summary> <param name="project"></param> <param name="path"></param> <param name="sessionState"></param> <returns></returns> </member> </members> </doc> |