From 4cc663c1a055b1413e247a35273391f873d8522b Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Sep 2020 13:54:57 -0700 Subject: [PATCH 1/3] document private apis for visual studio --- docs/framework/additional-apis/index.md | 27 +++--- ...ows.controls.gridviewheaderrowpresenter.md | 90 +++++++++++++++++++ docs/framework/toc.yml | 36 ++++---- 3 files changed, 125 insertions(+), 28 deletions(-) create mode 100644 docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md diff --git a/docs/framework/additional-apis/index.md b/docs/framework/additional-apis/index.md index a8f5ad7fb4280..5b9a5b6fd48cc 100644 --- a/docs/framework/additional-apis/index.md +++ b/docs/framework/additional-apis/index.md @@ -2,7 +2,7 @@ title: Additional class libraries and APIs description: Explore additional class libraries and APIs in .NET, including out-of-band (OOB) projects, platform-specific libraries, and private APIs. ms.date: 08/11/2020 -helpviewer_keywords: +helpviewer_keywords: - "Additional class libraries" - "Additional managed libraries" - ".NET Framework out-of-band releases" @@ -18,25 +18,25 @@ This article lists .NET Framework APIs that either were released out of band, ta To improve cross-platform development and introduce new functionality early, some .NET Framework features were released out of band (OOB). -| Project | Description | -| ------- | ----------- | +| Project | Description | +| ------- | ----------- | | | Provides collections that are thread safe and guaranteed to never change their contents. | | | Provides a message handler for based on the WinHTTP interface of Windows. | | | Provides a library of vector types that can take advantage of SIMD hardware-based acceleration.| -| | The TPL Dataflow Library provides dataflow components to help increase the robustness of concurrency-enabled applications. | +| | The TPL Dataflow Library provides dataflow components to help increase the robustness of concurrency-enabled applications. | ## Platform-specific libraries Some libraries target specific platforms. For example, the class makes code page encodings available to UWP apps developed using .NET Framework. - -| Project | Description | -| ------- | ----------- | -| | Extends the class to make code page encodings available to apps that target the Universal Windows Platform. | - -## Private APIs -These APIs support the product infrastructure and are not intended or supported to be used directly from your code. - +| Project | Description | +| ------- | ----------- | +| | Extends the class to make code page encodings available to apps that target the Universal Windows Platform. | + +## Private APIs + +These APIs support the product infrastructure and are not intended or supported to be used directly from your code. + * [Microsoft.SqlServer.Server.SmiOrderProperty.Item property](microsoft.sqlserver.server.smiorderproperty.item.md) * [System.Exception.PrepForRemoting method](system.exception.prepforremoting.md) * [System.Data.SqlTypes.SqlChars.Stream property](system.data.sqltypes.sqlchars.stream.md) @@ -82,6 +82,7 @@ These APIs support the product infrastructure and are not intended or supported * [System.ServiceModel.Channels.Message.BodyToString method](system.servicemodel.channels.message.bodytostring.md) * [System.ServiceModel.Channels.Message.WriteStartHeaders method](system.servicemodel.channels.message.writestartheaders.md) * [System.Web.Compilation.ControlBuilderInterceptor class](controlbuilderinterceptor-class.md) +* [System.Windows.Controls.GridViewHeaderRowPresenter methods](system.windows.controls.gridviewheaderrowpresenter.md) * [System.Windows.Diagnostics.VisualDiagnostics.s\_isDebuggerCheckDisabledForTestPurposes field](s-isdebuggercheckdisabledfortestpurposes-field.md) * [System.Windows.Forms.Design.DataMemberFieldEditor class](datamemberfieldeditor-class.md) * [System.Windows.Forms.Design.DataMemberListEditor class](datamemberlisteditor-class.md) @@ -97,7 +98,7 @@ These APIs support the product infrastructure and are not intended or supported * [stdole.IPictureDisp.Handle property](stdole.ipicturedisp.handle.md) * [stdole.StdFont interface](stdole.stdfont.md) * [stdole.StdPicture interface](stdole.stdpicture.md) - + ## See also * [.NET Framework and Out-of-Band Releases](../get-started/the-net-framework-and-out-of-band-releases.md) diff --git a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md new file mode 100644 index 0000000000000..68c02d0903211 --- /dev/null +++ b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md @@ -0,0 +1,90 @@ +--- +title: GridViewHeaderRowPresenter methods (System.Windows.Controls) +ms.date: 09/25/2020 +ms.technology: dotnet-networking +topic_type: + - apiref +api_name: + - System.Windows.Controls.GridViewHeaderRowPresenter.FindHeaderByColumn + - System.Windows.Controls.GridViewHeaderRowPresenter.MakeParentItemsControlGotFocus + - System.Windows.Controls.GridViewHeaderRowPresenter.PrepareHeaderDrag +api_location: + - PresentationFramework.dll +api_type: + - Assembly +--- +# GridViewHeaderRowPresenter methods + +## FindHeaderByColumn method + +Finds the column header for the specified column in the visual tree. + +```csharp +private GridViewColumnHeader FindHeaderByColumn(GridViewColumn column) +``` + +> [!WARNING] +> This method is private and is not meant to be used directly in your code. +> +> Microsoft does not support the use of this method in a production application under any circumstance. + +### Parameters + +`column` \ +The column whose header should be found and returned. + +### Return value + + + +The header of the specified column, or `null` if the specified column doesn't exist. + +## MakeParentItemsControlGotFocus method + +Gives focus to the parent control of the item. If the parent control is a , gives focus to the most recently accessed item in the . + +```csharp +internal void MakeParentItemsControlGotFocus() +``` + +> [!WARNING] +> This method is internal and is not meant to be used directly in your code. +> +> Microsoft does not support the use of this method in a production application under any circumstance. + +## PrepareHeaderDrag method + +Prepares the specified column header for reordering. + +```csharp +private void PrepareHeaderDrag(GridViewColumnHeader header, Point pos, Point relativePos, bool cancelInvoke) +``` + +> [!WARNING] +> This method is private and is not meant to be used directly in your code. +> +> Microsoft does not support the use of this method in a production application under any circumstance. + +### Parameters + +`header` \ +The column header to prepare for reordering. + +`pos` \ +The position, relative to , where the dragging starts. + +`relativePos` \ +The position, relative to `header`, where the dragging starts. + +`cancelInvoke` \ +`true` to cancel the reordering; otherwise, `false`. + +## Requirements + +**Namespace:** + +**Assembly:** PresentationFramework.dll + +## See also + +- diff --git a/docs/framework/toc.yml b/docs/framework/toc.yml index 8c6113eeb1731..0966f1948ee3f 100644 --- a/docs/framework/toc.yml +++ b/docs/framework/toc.yml @@ -51,10 +51,10 @@ items: href: migration-guide/index.md - name: Compatibility items: - - name: Application compatibility + - name: Application compatibility items: - name: Overview - displayName: App compatibility + displayName: App compatibility href: migration-guide/application-compatibility.md - name: Runtime changes items: @@ -333,7 +333,7 @@ items: - name: Migrate from .NET Framework 1.1 href: migration-guide/migrating-from-the-net-framework-1-1.md - name: .NET Framework 4 migration issues - href: migration-guide/net-framework-4-migration-issues.md + href: migration-guide/net-framework-4-migration-issues.md - name: Development guide href: development-guide.md items: @@ -598,6 +598,12 @@ items: items: - name: ControlBuilderInterceptor class href: additional-apis/controlbuilderinterceptor-class.md + - name: System.Windows.Controls + items: + - name: GridViewHeaderRowPresenter class + items: + - name: FindHeaderByColumn, MakeParentItemsControlGotFocus, and PrepareHeaderDrag methods + href: additional-apis/system.windows.controls.gridviewheaderrowpresenter.md - name: System.Windows.Diagnostics items: - name: VisualDiagnostics class @@ -616,7 +622,7 @@ items: items: - name: raise__WritingCancelled method href: additional-apis/xpsdocumentwriter-raise-writingcancelled-method-system-windows-xps.md - - name: raise__WritingCompleted method + - name: raise__WritingCompleted method href: additional-apis/xpsdocumentwriter-raise-writingcompleted-method-system-windows-xps.md - name: raise__WritingPrintTicketRequired method href: additional-apis/xpsdocumentwriter-raise-writingprintticketrequired-method-system-windows-xps.md @@ -668,18 +674,18 @@ items: href: additional-apis/stdole.stdfont.md - name: StdPicture interface href: additional-apis/stdole.stdpicture.md -- name: What's new and obsolete - items: +- name: What's new and obsolete + items: - name: What's new - href: whats-new/index.md - - name: What's new in accessibility - href: whats-new/whats-new-in-accessibility.md - - name: What's obsolete in API ref - href: whats-new/whats-obsolete.md - items: - - name: Obsolete types - href: whats-new/obsolete-types.md - - name: Obsolete members + href: whats-new/index.md + - name: What's new in accessibility + href: whats-new/whats-new-in-accessibility.md + - name: What's obsolete in API ref + href: whats-new/whats-obsolete.md + items: + - name: Obsolete types + href: whats-new/obsolete-types.md + - name: Obsolete members href: whats-new/obsolete-members.md - name: Code Access security items: From eb73a75cc47fc6ec63834c52fc0452bf1eb25f8c Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Sep 2020 14:19:10 -0700 Subject: [PATCH 2/3] split methods into separate files --- docs/framework/additional-apis/index.md | 4 +- ...ewheaderrowpresenter.findheaderbycolumn.md | 47 ++++++++++ ...resenter.makeparentitemscontrolgotfocus.md | 36 ++++++++ ...ows.controls.gridviewheaderrowpresenter.md | 90 ------------------- ...iewheaderrowpresenter.prepareheaderdrag.md | 50 +++++++++++ docs/framework/toc.yml | 8 +- 6 files changed, 142 insertions(+), 93 deletions(-) create mode 100644 docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md create mode 100644 docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.makeparentitemscontrolgotfocus.md delete mode 100644 docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md create mode 100644 docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.prepareheaderdrag.md diff --git a/docs/framework/additional-apis/index.md b/docs/framework/additional-apis/index.md index 5b9a5b6fd48cc..c7f09492c0f34 100644 --- a/docs/framework/additional-apis/index.md +++ b/docs/framework/additional-apis/index.md @@ -82,7 +82,9 @@ These APIs support the product infrastructure and are not intended or supported * [System.ServiceModel.Channels.Message.BodyToString method](system.servicemodel.channels.message.bodytostring.md) * [System.ServiceModel.Channels.Message.WriteStartHeaders method](system.servicemodel.channels.message.writestartheaders.md) * [System.Web.Compilation.ControlBuilderInterceptor class](controlbuilderinterceptor-class.md) -* [System.Windows.Controls.GridViewHeaderRowPresenter methods](system.windows.controls.gridviewheaderrowpresenter.md) +* [System.Windows.Controls.GridViewHeaderRowPresenter.FindHeaderByColumn method](system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md) +* [System.Windows.Controls.GridViewHeaderRowPresenter.MakeParentItemsControlGotFocus method](system.windows.controls.gridviewheaderrowpresenter.makeparentitemscontrolgotfocus.md) +* [System.Windows.Controls.GridViewHeaderRowPresenter.PrepareHeaderDrag method](system.windows.controls.gridviewheaderrowpresenter.prepareheaderdrag.md) * [System.Windows.Diagnostics.VisualDiagnostics.s\_isDebuggerCheckDisabledForTestPurposes field](s-isdebuggercheckdisabledfortestpurposes-field.md) * [System.Windows.Forms.Design.DataMemberFieldEditor class](datamemberfieldeditor-class.md) * [System.Windows.Forms.Design.DataMemberListEditor class](datamemberlisteditor-class.md) diff --git a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md new file mode 100644 index 0000000000000..761df616a56ae --- /dev/null +++ b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md @@ -0,0 +1,47 @@ +--- +title: FindHeaderByColumn method (System.Windows.Controls.GridViewHeaderRowPresenter) +description: Learn about the private WPF method called FindHeaderByColumn. +ms.date: 09/25/2020 +ms.technology: dotnet-wpf +topic_type: + - apiref +api_name: + - System.Windows.Controls.GridViewHeaderRowPresenter.FindHeaderByColumn +api_location: + - PresentationFramework.dll +api_type: + - Assembly +--- +# FindHeaderByColumn method + +Finds the column header for the specified column in the visual tree. + +```csharp +private GridViewColumnHeader FindHeaderByColumn(GridViewColumn column) +``` + +> [!WARNING] +> This method is private and is not meant to be used directly in your code. +> +> Microsoft does not support the use of this method in a production application under any circumstance. + +## Parameters + +`column` \ +The column whose header should be found and returned. + +## Return value + + + +The header of the specified column, or `null` if the specified column doesn't exist. + +## Requirements + +**Namespace:** + +**Assembly:** PresentationFramework.dll + +## See also + +- diff --git a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.makeparentitemscontrolgotfocus.md b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.makeparentitemscontrolgotfocus.md new file mode 100644 index 0000000000000..6801169d65341 --- /dev/null +++ b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.makeparentitemscontrolgotfocus.md @@ -0,0 +1,36 @@ +--- +title: MakeParentItemsControlGotFocus method (System.Windows.Controls.GridViewHeaderRowPresenter) +description: Learn about the private WPF method called MakeParentItemsControlGotFocus. +ms.date: 09/25/2020 +ms.technology: dotnet-wpf +topic_type: + - apiref +api_name: + - System.Windows.Controls.GridViewHeaderRowPresenter.MakeParentItemsControlGotFocus +api_location: + - PresentationFramework.dll +api_type: + - Assembly +--- +# MakeParentItemsControlGotFocus method + +Gives focus to the parent control of the item. If the parent control is a , gives focus to the most recently accessed item in the . + +```csharp +internal void MakeParentItemsControlGotFocus() +``` + +> [!WARNING] +> This method is internal and is not meant to be used directly in your code. +> +> Microsoft does not support the use of this method in a production application under any circumstance. + +## Requirements + +**Namespace:** + +**Assembly:** PresentationFramework.dll + +## See also + +- diff --git a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md deleted file mode 100644 index 68c02d0903211..0000000000000 --- a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: GridViewHeaderRowPresenter methods (System.Windows.Controls) -ms.date: 09/25/2020 -ms.technology: dotnet-networking -topic_type: - - apiref -api_name: - - System.Windows.Controls.GridViewHeaderRowPresenter.FindHeaderByColumn - - System.Windows.Controls.GridViewHeaderRowPresenter.MakeParentItemsControlGotFocus - - System.Windows.Controls.GridViewHeaderRowPresenter.PrepareHeaderDrag -api_location: - - PresentationFramework.dll -api_type: - - Assembly ---- -# GridViewHeaderRowPresenter methods - -## FindHeaderByColumn method - -Finds the column header for the specified column in the visual tree. - -```csharp -private GridViewColumnHeader FindHeaderByColumn(GridViewColumn column) -``` - -> [!WARNING] -> This method is private and is not meant to be used directly in your code. -> -> Microsoft does not support the use of this method in a production application under any circumstance. - -### Parameters - -`column` \ -The column whose header should be found and returned. - -### Return value - - - -The header of the specified column, or `null` if the specified column doesn't exist. - -## MakeParentItemsControlGotFocus method - -Gives focus to the parent control of the item. If the parent control is a , gives focus to the most recently accessed item in the . - -```csharp -internal void MakeParentItemsControlGotFocus() -``` - -> [!WARNING] -> This method is internal and is not meant to be used directly in your code. -> -> Microsoft does not support the use of this method in a production application under any circumstance. - -## PrepareHeaderDrag method - -Prepares the specified column header for reordering. - -```csharp -private void PrepareHeaderDrag(GridViewColumnHeader header, Point pos, Point relativePos, bool cancelInvoke) -``` - -> [!WARNING] -> This method is private and is not meant to be used directly in your code. -> -> Microsoft does not support the use of this method in a production application under any circumstance. - -### Parameters - -`header` \ -The column header to prepare for reordering. - -`pos` \ -The position, relative to , where the dragging starts. - -`relativePos` \ -The position, relative to `header`, where the dragging starts. - -`cancelInvoke` \ -`true` to cancel the reordering; otherwise, `false`. - -## Requirements - -**Namespace:** - -**Assembly:** PresentationFramework.dll - -## See also - -- diff --git a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.prepareheaderdrag.md b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.prepareheaderdrag.md new file mode 100644 index 0000000000000..eb6916a38658c --- /dev/null +++ b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.prepareheaderdrag.md @@ -0,0 +1,50 @@ +--- +title: PrepareHeaderDrag method (System.Windows.Controls.GridViewHeaderRowPresenter) +description: Learn about the private WPF method called PrepareHeaderDrag. +ms.date: 09/25/2020 +ms.technology: dotnet-wpf +topic_type: + - apiref +api_name: + - System.Windows.Controls.GridViewHeaderRowPresenter.PrepareHeaderDrag +api_location: + - PresentationFramework.dll +api_type: + - Assembly +--- +# PrepareHeaderDrag method + +Prepares the specified column header for reordering. + +```csharp +private void PrepareHeaderDrag(GridViewColumnHeader header, Point pos, Point relativePos, bool cancelInvoke) +``` + +> [!WARNING] +> This method is private and is not meant to be used directly in your code. +> +> Microsoft does not support the use of this method in a production application under any circumstance. + +## Parameters + +`header` \ +The column header to prepare for reordering. + +`pos` \ +The position, relative to , where the dragging starts. + +`relativePos` \ +The position, relative to `header`, where the dragging starts. + +`cancelInvoke` \ +`true` to cancel the reordering; otherwise, `false`. + +## Requirements + +**Namespace:** + +**Assembly:** PresentationFramework.dll + +## See also + +- diff --git a/docs/framework/toc.yml b/docs/framework/toc.yml index 0966f1948ee3f..c3d3d1d44b8c1 100644 --- a/docs/framework/toc.yml +++ b/docs/framework/toc.yml @@ -602,8 +602,12 @@ items: items: - name: GridViewHeaderRowPresenter class items: - - name: FindHeaderByColumn, MakeParentItemsControlGotFocus, and PrepareHeaderDrag methods - href: additional-apis/system.windows.controls.gridviewheaderrowpresenter.md + - name: FindHeaderByColumn method + href: additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md + - name: MakeParentItemsControlGotFocus method + href: additional-apis/system.windows.controls.gridviewheaderrowpresenter.makeparentitemscontrolgotfocus.md + - name: PrepareHeaderDrag method + href: additional-apis/system.windows.controls.gridviewheaderrowpresenter.prepareheaderdrag.md - name: System.Windows.Diagnostics items: - name: VisualDiagnostics class From 860c55f650304f9238924f9ef2c9a081f4616e54 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Sep 2020 14:29:58 -0700 Subject: [PATCH 3/3] fix spacing --- ...s.controls.gridviewheaderrowpresenter.findheaderbycolumn.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md index 761df616a56ae..609fee6b2b6a5 100644 --- a/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md +++ b/docs/framework/additional-apis/system.windows.controls.gridviewheaderrowpresenter.findheaderbycolumn.md @@ -32,8 +32,7 @@ The column whose header should be found and returned. ## Return value - - +\ The header of the specified column, or `null` if the specified column doesn't exist. ## Requirements