Import Windows Forms related props and targets into Windows Desktop (#…

…4779) * Import Windows Forms related props and targets into Windows Desktop * Establish a mechanism to import Windows Forms related functionality into Windows Desktop SDK via the Windows Forms transport package. * Add a basic validation of the content of the shipping package in .\eng\WindowsFormsImports.targets. * fixup! Import Windows Forms related props and targets into Windows Desktop
dotnet · Jul 23, 2021 · a321b03 · a321b03
1 parent b065d06
commit a321b03
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 0 deletions.
diff --git a/...ging/Microsoft.NET.Sdk.WindowsDesktop/Microsoft.NET.Sdk.WindowsDesktop.ArchNeutral.csproj b/...ging/Microsoft.NET.Sdk.WindowsDesktop/Microsoft.NET.Sdk.WindowsDesktop.ArchNeutral.csproj
@@ -1,4 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
+
   <PropertyGroup>
     <ProjectGuid>{440d06b8-e3de-4c0d-ad25-cd4f43d836e1}</ProjectGuid>
     <TargetFramework>net6.0</TargetFramework>
@@ -25,4 +26,8 @@
     <PackagingContent Include="targets\*" SubFolder="root\targets" />
     <PackagingContent Include="useSharedDesignerContext.txt" SubFolder="root" />
   </ItemGroup>
+
+  <!-- Windows Forms validation and packaging -->
+  <Import Project="Microsoft.NET.Sdk.WindowsDesktop.WinForms.Packaging.targets" />
+
 </Project>
diff --git a/...rosoft.NET.Sdk.WindowsDesktop/Microsoft.NET.Sdk.WindowsDesktop.WinForms.Packaging.targets b/...rosoft.NET.Sdk.WindowsDesktop/Microsoft.NET.Sdk.WindowsDesktop.WinForms.Packaging.targets
@@ -0,0 +1,51 @@
+<Project>
+
+  <PropertyGroup>
+    <_WindowsFormsNuGetPath>$(PkgMicrosoft_Private_Winforms)</_WindowsFormsNuGetPath>
+  </PropertyGroup>
+
+  <!--
+    ============================================================
+                      _ValidateWindowsFormsPackagingContent
+    Validates the content of Microsoft.Private.Winforms NuGet package
+    to ensure we correctly import and reference props and targets.
+    ============================================================
+   -->
+  <Target Name="_ValidateWindowsFormsPackagingContent">
+    <PropertyGroup>
+      <_WindowsFormsContentPath>$(_WindowsFormsNuGetPath)\sdk\dotnet-wpf\*</_WindowsFormsContentPath>
+      <_WindowsFormsRequiredFileName>Microsoft.NET.Sdk.WindowsDesktop.WindowsForms</_WindowsFormsRequiredFileName>
+    </PropertyGroup>
+
+    <Error Text="Unable to resolve path to Microsoft.Private.Winforms NuGet package. Is %24(PkgMicrosoft_Private_Winforms) defined?"
+           Condition="'$(_WindowsFormsNuGetPath)' == ''"/>
+
+    <ItemGroup>
+      <!-- Enumerate all transported files -->
+      <_WindowsFormsContent Include="$(_WindowsFormsContentPath)" />
+      <!-- ...and verify Microsoft.NET.Sdk.WindowsDesktop.WindowsForms.props/.targets are present -->
+      <_WindowsFormsContentFiles Include="@(_WindowsFormsContent->'%(FileName)%(Extension)')"
+          Condition=" '%(FileName)%(Extension)' == '$(_WindowsFormsRequiredFileName).props'
+                   or '%(FileName)%(Extension)' == '$(_WindowsFormsRequiredFileName).targets' "/>
+    </ItemGroup>
+
+    <!-- Fail if the required files are missing -->
+    <Error Text="Microsoft.Private.Winforms NuGet package does not contain $(_WindowsFormsRequiredFileName).props or $(_WindowsFormsRequiredFileName).targets"
+           Condition="@(_WindowsFormsContentFiles->Count()) != 2"/>
+  </Target>
+
+
+  <!--
+    ============================================================
+                      _IdentifyWindowsFormsPackageAssets
+    Add props/targets shipped by Windows Forms to the collection of files that get packaged
+    in to Microsoft.NET.Sdk.WindowsDesktop.<configuration>.<version>.nupkg.
+    ============================================================
+  -->
+  <Target Name="_IdentifyWindowsFormsPackageAssets" BeforeTargets="IdentifyPackageAssets" DependsOnTargets="_ValidateWindowsFormsPackagingContent">
+    <ItemGroup>
+      <PackagingContent Include="$(_WindowsFormsContentPath)" SubFolder="root\targets" />
+    </ItemGroup>
+  </Target>
+
+</Project>
diff --git a/packaging/Microsoft.NET.Sdk.WindowsDesktop/targets/Microsoft.NET.Sdk.WindowsDesktop.props b/packaging/Microsoft.NET.Sdk.WindowsDesktop/targets/Microsoft.NET.Sdk.WindowsDesktop.props
@@ -161,4 +161,11 @@
     <SupportedTargetFramework Remove="@(_UnsupportedNETCoreAppTargetFramework);@(_UnsupportedNETStandardTargetFramework);@(_UnsupportedNETFrameworkTargetFramework)" />
   </ItemGroup>
 
+  <!--
+    Import Windows Forms props.
+    These come via the Windows Forms transport package, that can be found under
+    https://github.com/dotnet/winforms/tree/main/pkg/Microsoft.Private.Winforms/sdk
+  -->
+  <Import Project="Microsoft.NET.Sdk.WindowsDesktop.WindowsForms.props" />
+
 </Project>
diff --git a/packaging/Microsoft.NET.Sdk.WindowsDesktop/targets/Microsoft.NET.Sdk.WindowsDesktop.targets b/packaging/Microsoft.NET.Sdk.WindowsDesktop/targets/Microsoft.NET.Sdk.WindowsDesktop.targets
@@ -155,4 +155,11 @@
   <!-- Import WPF Build logic only when we don't import NETFX's WinFX targets -->
   <Import Project="Microsoft.WinFX.targets" Condition="'$(ImportFrameworkWinFXTargets)' != 'true'"/>
 
+  <!--
+    Import Windows Forms targets.
+    These come via the Windows Forms transport package, that can be found under
+    https://github.com/dotnet/winforms/tree/main/pkg/Microsoft.Private.Winforms/sdk
+  -->
+  <Import Project="Microsoft.NET.Sdk.WindowsDesktop.WindowsForms.targets" Condition="'$(UseWindowsForms)' == 'true'"/>
+
 </Project>