diff --git a/xml/FrameworksIndex/dotnet-plat-ext-6.0.xml b/xml/FrameworksIndex/dotnet-plat-ext-6.0.xml index 9bbde029692..e7963a1f0d9 100644 --- a/xml/FrameworksIndex/dotnet-plat-ext-6.0.xml +++ b/xml/FrameworksIndex/dotnet-plat-ext-6.0.xml @@ -75,7 +75,7 @@ - + @@ -538,6 +538,7 @@ + @@ -2824,6 +2825,12 @@ + + + + + + @@ -2902,6 +2909,7 @@ + @@ -5419,9 +5427,7 @@ - - @@ -5617,7 +5623,6 @@ - @@ -5772,13 +5777,10 @@ - - - @@ -5801,13 +5803,10 @@ - - - @@ -6117,7 +6116,6 @@ - @@ -6194,7 +6192,6 @@ - @@ -6764,6 +6761,14 @@ + + + + + + + + @@ -17181,6 +17186,7 @@ + @@ -17631,6 +17637,7 @@ + @@ -17836,6 +17843,12 @@ + + + + + + diff --git a/xml/FrameworksIndex/msbuild-16-netcore.xml b/xml/FrameworksIndex/msbuild-16-netcore.xml index 832eb41d4e3..fb7557ff9fb 100644 --- a/xml/FrameworksIndex/msbuild-16-netcore.xml +++ b/xml/FrameworksIndex/msbuild-16-netcore.xml @@ -3209,15 +3209,6 @@ - - - - - - - - - diff --git a/xml/FrameworksIndex/net-6.0.xml b/xml/FrameworksIndex/net-6.0.xml index a2962895474..d4df6b1b08e 100644 --- a/xml/FrameworksIndex/net-6.0.xml +++ b/xml/FrameworksIndex/net-6.0.xml @@ -145,7 +145,6 @@ - @@ -163,6 +162,8 @@ + + @@ -336,6 +337,12 @@ + + + + + + @@ -402,6 +409,7 @@ + @@ -423,6 +431,7 @@ + @@ -17740,11 +17749,13 @@ + + @@ -19642,8 +19653,8 @@ - - + + @@ -19659,8 +19670,8 @@ - - + + @@ -19670,8 +19681,8 @@ - - + + @@ -20527,6 +20538,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + @@ -21296,6 +21332,7 @@ + @@ -21304,6 +21341,7 @@ + @@ -21322,6 +21360,7 @@ + @@ -34903,6 +34942,7 @@ + @@ -40314,7 +40354,6 @@ - @@ -50273,6 +50312,9 @@ + + + @@ -57415,6 +57457,12 @@ + + + + + + @@ -57425,6 +57473,12 @@ + + + + + + @@ -57448,6 +57502,18 @@ + + + + + + + + + + + + @@ -57887,7 +57953,9 @@ + + @@ -58009,7 +58077,7 @@ - + @@ -58041,26 +58109,36 @@ + + + + + + + + + + + + + + + + + - - - - - - - - + @@ -77727,6 +77805,7 @@ + @@ -80594,6 +80673,7 @@ + @@ -83402,6 +83482,7 @@ + @@ -83461,6 +83542,7 @@ + @@ -87539,6 +87621,20 @@ + + + + + + + + + + + + + + diff --git a/xml/Microsoft.Build.Tasks.Deployment.ManifestUtilities/DeployManifest.xml b/xml/Microsoft.Build.Tasks.Deployment.ManifestUtilities/DeployManifest.xml index db9b4dd19d4..a063541aebd 100644 --- a/xml/Microsoft.Build.Tasks.Deployment.ManifestUtilities/DeployManifest.xml +++ b/xml/Microsoft.Build.Tasks.Deployment.ManifestUtilities/DeployManifest.xml @@ -538,7 +538,7 @@ Specifies whether or not the user can skip the update. - If the user has a version less than the minimum required, he or she will not have the option to skip the update. + If the user has a version less than the minimum required, they will not have the option to skip the update. The default is to have no minimum required version. This input only applies when Install is True. diff --git a/xml/Microsoft.CSharp/CSharpCodeProvider.xml b/xml/Microsoft.CSharp/CSharpCodeProvider.xml index cc5418342af..a124e1ba7b5 100644 --- a/xml/Microsoft.CSharp/CSharpCodeProvider.xml +++ b/xml/Microsoft.CSharp/CSharpCodeProvider.xml @@ -185,10 +185,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeCompiler interface and should instead use the methods directly on the CodeDomProvider class.")] [<System.Obsolete("Callers should not use the ICodeCompiler interface and should instead use the methods directly on the CodeDomProvider class.")>] + + [System.Obsolete("ICodeCompiler has been deprecated. Use the methods directly on the CodeDomProvider class instead.")] + [<System.Obsolete("ICodeCompiler has been deprecated. Use the methods directly on the CodeDomProvider class instead.")>] + [System.Obsolete("Use CodeDomProvider class")] [<System.Obsolete("Use CodeDomProvider class")>] @@ -228,10 +232,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeGenerator interface and should instead use the methods directly on the CodeDomProvider class.")] [<System.Obsolete("Callers should not use the ICodeGenerator interface and should instead use the methods directly on the CodeDomProvider class.")>] + + [System.Obsolete("ICodeGenerator has been deprecated. Use the methods directly on the CodeDomProvider class instead.")] + [<System.Obsolete("ICodeGenerator has been deprecated. Use the methods directly on the CodeDomProvider class instead.")>] + [System.Obsolete("Use CodeDomProvider class")] [<System.Obsolete("Use CodeDomProvider class")>] diff --git a/xml/Microsoft.DotNet.PlatformAbstractions/HashCodeCombiner.xml b/xml/Microsoft.DotNet.PlatformAbstractions/HashCodeCombiner.xml index c2eb40a8a27..1280616bd72 100644 --- a/xml/Microsoft.DotNet.PlatformAbstractions/HashCodeCombiner.xml +++ b/xml/Microsoft.DotNet.PlatformAbstractions/HashCodeCombiner.xml @@ -19,10 +19,14 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is System.HashCode.")] [<System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is System.HashCode.")>] + + [System.Obsolete("HashCodeCombiner has been deprecated. Use System.HashCode instead.")] + [<System.Obsolete("HashCodeCombiner has been deprecated. Use System.HashCode instead.")>] + To be added. diff --git a/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml b/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml index 3730f676a49..edbe5df2802 100644 --- a/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml +++ b/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml @@ -109,5 +109,28 @@ To be added. + + + + + + + + Method + + Microsoft.Extensions.Configuration.EnvironmentVariables + 6.0.0.0 + + + System.String + + + + To be added. + To be added. + To be added. + + + diff --git a/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml index d4322e9a82f..2a8171da705 100644 --- a/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml @@ -494,6 +494,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -585,6 +591,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -739,6 +751,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -874,6 +892,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -1028,6 +1052,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -1119,6 +1149,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + diff --git a/xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilities.xml b/xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilities.xml index 6f3ad5656be..8a2cba6f5f2 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilities.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilities.xml @@ -135,7 +135,14 @@ T - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + + @@ -216,7 +223,14 @@ T - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + + diff --git a/xml/Microsoft.Extensions.DependencyInjection/OptionsBuilderExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection/OptionsBuilderExtensions.xml index 30d95a83c82..37d5798597b 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/OptionsBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/OptionsBuilderExtensions.xml @@ -13,6 +13,12 @@ System.Object + + + [System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2091:UnrecognizedReflectionPattern", Justification="Workaround for https://github.com/mono/linker/issues/1416. Outer method has been annotated with DynamicallyAccessedMembers.")] + [<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2091:UnrecognizedReflectionPattern", Justification="Workaround for https://github.com/mono/linker/issues/1416. Outer method has been annotated with DynamicallyAccessedMembers.")>] + + Extension methods for adding configuration related options services to the DI container via . To be added. @@ -38,6 +44,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)>] + + diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceCollectionServiceExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceCollectionServiceExtensions.xml index e3438152f8d..dfb56f07384 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceCollectionServiceExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceCollectionServiceExtensions.xml @@ -171,6 +171,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -266,6 +272,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -522,6 +534,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -663,6 +681,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -879,6 +903,12 @@ ReferenceTypeConstraint + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -974,6 +1004,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml index 7967766752f..da0d35d9b89 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml @@ -236,7 +236,6 @@ To be added. To be added. To be added. - @@ -267,7 +266,6 @@ To be added. To be added. To be added. - @@ -291,6 +289,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + System.Type @@ -298,7 +302,6 @@ To be added. To be added. To be added. - @@ -328,7 +331,6 @@ To be added. To be added. To be added. - @@ -482,6 +484,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -573,7 +581,6 @@ To be added. To be added. To be added. - @@ -807,6 +814,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -1048,6 +1061,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + diff --git a/xml/Microsoft.Extensions.FileSystemGlobbing.Internal/PatternTestResult.xml b/xml/Microsoft.Extensions.FileSystemGlobbing.Internal/PatternTestResult.xml index 76423a461ba..ba3de1d1f3d 100644 --- a/xml/Microsoft.Extensions.FileSystemGlobbing.Internal/PatternTestResult.xml +++ b/xml/Microsoft.Extensions.FileSystemGlobbing.Internal/PatternTestResult.xml @@ -75,6 +75,12 @@ 5.0.0.0 6.0.0.0 + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + System.Boolean @@ -104,6 +110,12 @@ 5.0.0.0 6.0.0.0 + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + System.String diff --git a/xml/Microsoft.Extensions.FileSystemGlobbing/FilePatternMatch.xml b/xml/Microsoft.Extensions.FileSystemGlobbing/FilePatternMatch.xml index 316d4bbb8ac..66891291011 100644 --- a/xml/Microsoft.Extensions.FileSystemGlobbing/FilePatternMatch.xml +++ b/xml/Microsoft.Extensions.FileSystemGlobbing/FilePatternMatch.xml @@ -182,6 +182,12 @@ 5.0.0.0 6.0.0.0 + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + System.String @@ -212,6 +218,12 @@ 5.0.0.0 6.0.0.0 + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + System.String diff --git a/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml b/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml index beb68c8a93e..825e43fd424 100644 --- a/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml +++ b/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml @@ -25,6 +25,24 @@ System.IDisposable + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + Listens for Ctrl+C or SIGTERM and initiates shutdown. diff --git a/xml/Microsoft.Extensions.Hosting/EnvironmentName.xml b/xml/Microsoft.Extensions.Hosting/EnvironmentName.xml index e37e854b8df..9ac980cf9ff 100644 --- a/xml/Microsoft.Extensions.Hosting/EnvironmentName.xml +++ b/xml/Microsoft.Extensions.Hosting/EnvironmentName.xml @@ -19,10 +19,14 @@ - + [System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.Environments.", false)] [<System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.Environments.", false)>] + + [System.Obsolete("EnvironmentName has been deprecated. Use Microsoft.Extensions.Hosting.Environments instead.")] + [<System.Obsolete("EnvironmentName has been deprecated. Use Microsoft.Extensions.Hosting.Environments instead.")>] + Commonly used environment names. diff --git a/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml index 1e4e382f7ff..61407765e41 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml @@ -306,6 +306,24 @@ The following defaults are applied to the 5.0.0.0 6.0.0.0 + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + System.Threading.Tasks.Task @@ -335,6 +353,24 @@ The following defaults are applied to the 5.0.0.0 6.0.0.0 + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + System.Threading.Tasks.Task @@ -369,6 +405,24 @@ The following defaults are applied to the 5.0.0.0 6.0.0.0 + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + Microsoft.Extensions.Hosting.IHostBuilder @@ -398,6 +452,24 @@ The following defaults are applied to the 5.0.0.0 6.0.0.0 + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + Microsoft.Extensions.Hosting.IHostBuilder diff --git a/xml/Microsoft.Extensions.Hosting/IApplicationLifetime.xml b/xml/Microsoft.Extensions.Hosting/IApplicationLifetime.xml index 6dc76b22fc1..f289c0803eb 100644 --- a/xml/Microsoft.Extensions.Hosting/IApplicationLifetime.xml +++ b/xml/Microsoft.Extensions.Hosting/IApplicationLifetime.xml @@ -16,10 +16,14 @@ - + [System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.IHostApplicationLifetime.", false)] [<System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.IHostApplicationLifetime.", false)>] + + [System.Obsolete("IApplicationLifetime has been deprecated. Use Microsoft.Extensions.Hosting.IHostApplicationLifetime instead.")] + [<System.Obsolete("IApplicationLifetime has been deprecated. Use Microsoft.Extensions.Hosting.IHostApplicationLifetime instead.")>] + Allows consumers to perform cleanup during a graceful shutdown. diff --git a/xml/Microsoft.Extensions.Hosting/IHostingEnvironment.xml b/xml/Microsoft.Extensions.Hosting/IHostingEnvironment.xml index eb23e719d53..5500d125c24 100644 --- a/xml/Microsoft.Extensions.Hosting/IHostingEnvironment.xml +++ b/xml/Microsoft.Extensions.Hosting/IHostingEnvironment.xml @@ -16,10 +16,14 @@ - + [System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.IHostEnvironment.", false)] [<System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.Extensions.Hosting.IHostEnvironment.", false)>] + + [System.Obsolete("IHostingEnvironment has been deprecated. Use Microsoft.Extensions.Hosting.IHostEnvironment instead.")] + [<System.Obsolete("IHostingEnvironment has been deprecated. Use Microsoft.Extensions.Hosting.IHostEnvironment instead.")>] + Provides information about the hosting environment an application is running in. diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml index ac4ab1b878a..f296cebea7a 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml @@ -19,7 +19,7 @@ - To be added. + Handles logging of the lifecycle for an HTTP request. To be added. @@ -44,9 +44,11 @@ - To be added. - To be added. + The to log to. + Initializes a new instance of the class with a specified logger. To be added. + + is . @@ -67,10 +69,12 @@ - To be added. - To be added. - To be added. + The to log to. + The used to configure the instance. + Initializes a new instance of the class with a specified logger and options. To be added. + + or is . @@ -108,7 +112,16 @@ To be added. To be added. To be added. - To be added. + + . + + ]]> + + diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml index 1fc1e3c714a..807df72583a 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml @@ -19,7 +19,7 @@ - To be added. + Handles logging of the lifecycle for an HTTP request within a log scope. To be added. @@ -44,9 +44,11 @@ - To be added. - To be added. + The to log to. + Initializes a new instance of the class with a specified logger. To be added. + + is . @@ -67,10 +69,12 @@ - To be added. - To be added. - To be added. + The to log to. + The used to configure the instance. + Initializes a new instance of the class with a specified logger and options. To be added. + + or is . @@ -108,7 +112,16 @@ To be added. To be added. To be added. - To be added. + + . + + ]]> + + diff --git a/xml/Microsoft.Extensions.Http/HttpClientFactoryOptions.xml b/xml/Microsoft.Extensions.Http/HttpClientFactoryOptions.xml index 93f80571380..3cb698f072a 100644 --- a/xml/Microsoft.Extensions.Http/HttpClientFactoryOptions.xml +++ b/xml/Microsoft.Extensions.Http/HttpClientFactoryOptions.xml @@ -41,7 +41,7 @@ - To be added. + Initializes a new instance of the class. To be added. diff --git a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml index a6678a57eb1..7ce4493b378 100644 --- a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml +++ b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml @@ -43,7 +43,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -129,11 +129,20 @@ - To be added. - To be added. - To be added. - To be added. + An instance of to operate at the bottom of the handler chain and actually handle the HTTP transport operations. + An ordered list of instances to be invoked as part of sending an and receiving an . + The handlers are invoked in a top-down fashion. That is, the first entry is invoked first for an outbound request message but last for an inbound response message. + Constructs an instance of by chaining one after another with in the end of the chain. The resulting pipeline is used by infrastructure to create instances with customized message handlers. The resulting pipeline can also be accessed by using instead of . + The HTTP message handler chain. To be added. + + or is . + + contains a entry. + +-or- + +DelegatingHandler.InnerHandler is not . DelegatingHandler instances provided to HttpMessageHandlerBuilder must not be reused or cached. diff --git a/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml b/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml index 1c3613c2a03..91af4c3c82e 100644 --- a/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml +++ b/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml @@ -47,7 +47,7 @@ A delegate which will run the next . Applies additional initialization to the . - To be added. + The configured . To be added. diff --git a/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml index b1be6c5c730..36a02583875 100644 --- a/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml @@ -120,7 +120,15 @@ The will attach a cont To be added. To be added. To be added. - To be added. + + . + + ]]> + diff --git a/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerFormat.xml b/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerFormat.xml index e407c2c0a64..b85d7ae0816 100644 --- a/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerFormat.xml +++ b/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerFormat.xml @@ -16,10 +16,14 @@ System.Enum - + [System.Obsolete("ConsoleLoggerFormat has been deprecated.", false)] [<System.Obsolete("ConsoleLoggerFormat has been deprecated.", false)>] + + [System.Obsolete("ConsoleLoggerFormat has been deprecated.")] + [<System.Obsolete("ConsoleLoggerFormat has been deprecated.")>] + Format of messages. diff --git a/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml b/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml index 3b25b9dd73d..0b2ce0039d8 100644 --- a/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml +++ b/xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml @@ -65,10 +65,14 @@ 6.0.0.0 - + [System.Obsolete("ConsoleLoggerOptions.DisableColors has been deprecated. Please use SimpleConsoleFormatterOptions.ColorBehavior instead.", false)] [<System.Obsolete("ConsoleLoggerOptions.DisableColors has been deprecated. Please use SimpleConsoleFormatterOptions.ColorBehavior instead.", false)>] + + [System.Obsolete("ConsoleLoggerOptions.DisableColors has been deprecated. Use SimpleConsoleFormatterOptions.ColorBehavior instead.")] + [<System.Obsolete("ConsoleLoggerOptions.DisableColors has been deprecated. Use SimpleConsoleFormatterOptions.ColorBehavior instead.")>] + System.Boolean @@ -95,10 +99,14 @@ 6.0.0.0 - + [System.Obsolete("ConsoleLoggerOptions.Format has been deprecated. Please use ConsoleLoggerOptions.FormatterName instead.", false)] [<System.Obsolete("ConsoleLoggerOptions.Format has been deprecated. Please use ConsoleLoggerOptions.FormatterName instead.", false)>] + + [System.Obsolete("ConsoleLoggerOptions.Format has been deprecated. Use ConsoleLoggerOptions.FormatterName instead.")] + [<System.Obsolete("ConsoleLoggerOptions.Format has been deprecated. Use ConsoleLoggerOptions.FormatterName instead.")>] + Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat @@ -150,10 +158,14 @@ 6.0.0.0 - + [System.Obsolete("ConsoleLoggerOptions.IncludeScopes has been deprecated. Please use ConsoleFormatterOptions.IncludeScopes instead.", false)] [<System.Obsolete("ConsoleLoggerOptions.IncludeScopes has been deprecated. Please use ConsoleFormatterOptions.IncludeScopes instead.", false)>] + + [System.Obsolete("ConsoleLoggerOptions.IncludeScopes has been deprecated. Use ConsoleFormatterOptions.IncludeScopes instead.")] + [<System.Obsolete("ConsoleLoggerOptions.IncludeScopes has been deprecated. Use ConsoleFormatterOptions.IncludeScopes instead.")>] + System.Boolean @@ -204,10 +216,14 @@ 6.0.0.0 - + [System.Obsolete("ConsoleLoggerOptions.TimestampFormat has been deprecated. Please use ConsoleFormatterOptions.TimestampFormat instead.", false)] [<System.Obsolete("ConsoleLoggerOptions.TimestampFormat has been deprecated. Please use ConsoleFormatterOptions.TimestampFormat instead.", false)>] + + [System.Obsolete("ConsoleLoggerOptions.TimestampFormat has been deprecated. Use ConsoleFormatterOptions.TimestampFormat instead.")] + [<System.Obsolete("ConsoleLoggerOptions.TimestampFormat has been deprecated. Use ConsoleFormatterOptions.TimestampFormat instead.")>] + System.String @@ -232,10 +248,14 @@ 6.0.0.0 - + [System.Obsolete("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Please use ConsoleFormatterOptions.UseUtcTimestamp instead.", false)] [<System.Obsolete("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Please use ConsoleFormatterOptions.UseUtcTimestamp instead.", false)>] + + [System.Obsolete("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Use ConsoleFormatterOptions.UseUtcTimestamp instead.")] + [<System.Obsolete("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Use ConsoleFormatterOptions.UseUtcTimestamp instead.")>] + System.Boolean diff --git a/xml/Microsoft.JSInterop.Implementation/JSStreamReference.xml b/xml/Microsoft.JSInterop.Implementation/JSStreamReference.xml index 185dbad8cd2..99f7922cf7f 100644 --- a/xml/Microsoft.JSInterop.Implementation/JSStreamReference.xml +++ b/xml/Microsoft.JSInterop.Implementation/JSStreamReference.xml @@ -50,12 +50,12 @@ - - + + - - - + + + Method M:Microsoft.JSInterop.IJSStreamReference.OpenReadStreamAsync(System.Int64,System.Threading.CancellationToken) @@ -68,11 +68,11 @@ System.Threading.Tasks.ValueTask<System.IO.Stream> - + - To be added. + To be added. To be added. To be added. To be added. diff --git a/xml/Microsoft.JSInterop/DotNetStreamReference.xml b/xml/Microsoft.JSInterop/DotNetStreamReference.xml new file mode 100644 index 00000000000..69b5a13329d --- /dev/null +++ b/xml/Microsoft.JSInterop/DotNetStreamReference.xml @@ -0,0 +1,114 @@ + + + + + + + + + Microsoft.JSInterop + 6.0.0.0 + + + System.Object + + + + System.IDisposable + + + + To be added. + To be added. + + + + + + + + + Constructor + + Microsoft.JSInterop + 6.0.0.0 + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + Microsoft.JSInterop + 6.0.0.0 + + + System.Void + + + + To be added. + To be added. + + + + + + + + + + Property + + Microsoft.JSInterop + 6.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + Microsoft.JSInterop + 6.0.0.0 + + + System.IO.Stream + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/Microsoft.JSInterop/JSRuntime.xml b/xml/Microsoft.JSInterop/JSRuntime.xml index 30f034df7c5..2444925b3cf 100644 --- a/xml/Microsoft.JSInterop/JSRuntime.xml +++ b/xml/Microsoft.JSInterop/JSRuntime.xml @@ -365,5 +365,32 @@ To be added. + + + + + + + + Method + + Microsoft.JSInterop + 6.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventArgs.xml b/xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventArgs.xml new file mode 100644 index 00000000000..c9082c164a1 --- /dev/null +++ b/xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventArgs.xml @@ -0,0 +1,95 @@ + + + + + + + + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + System.EventArgs + + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [System.Runtime.InteropServices.ComVisible(false)] + [<System.Runtime.InteropServices.ComVisible(false)>] + + + + To be added. + To be added. + + + + + + + + + + Property + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + System.Drawing.Font + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + System.Windows.Forms.HighDpiMode + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + System.Int32 + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventHandler.xml b/xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventHandler.xml new file mode 100644 index 00000000000..351a8e18abb --- /dev/null +++ b/xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventHandler.xml @@ -0,0 +1,34 @@ + + + + + + + + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + System.Delegate + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml b/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml index 2171d1d09fc..a39d72038a3 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml @@ -191,6 +191,26 @@ Objects (Visual Basic) + + + + + + + + Event + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + Microsoft.VisualBasic.ApplicationServices.ApplyApplicationDefaultsEventHandler + + + To be added. + To be added. + + @@ -363,6 +383,33 @@ Extending the Visual Basic Application Model + + + + + + + + Property + + Microsoft.VisualBasic.Forms + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Windows.Forms.HighDpiMode + + + To be added. + To be added. + To be added. + + @@ -473,6 +520,10 @@ 6.0.0.0 + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] diff --git a/xml/Microsoft.VisualBasic.CompilerServices/Conversions.xml b/xml/Microsoft.VisualBasic.CompilerServices/Conversions.xml index ec29cd373be..2fbf8be6756 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/Conversions.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/Conversions.xml @@ -101,7 +101,7 @@ 11.0.0.0 - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -109,6 +109,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Expression origin object cannot be statically analyzed and may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Expression origin object cannot be statically analyzed and may be trimmed")>] + + [System.Obsolete("FallbackUserDefinedConversion has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackUserDefinedConversion has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] diff --git a/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml b/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml index 0c9f2325930..f8d8b9106a6 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml @@ -59,7 +59,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -67,6 +67,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackCall has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackCall has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -126,7 +130,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -134,6 +138,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackGet has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackGet has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -183,7 +191,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -191,6 +199,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackIndexSet has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackIndexSet has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -241,7 +253,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -249,6 +261,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackIndexSetComplex has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackIndexSetComplex has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -304,7 +320,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -312,6 +328,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackInvokeDefault1 has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackInvokeDefault1 has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -362,7 +382,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -370,6 +390,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackInvokeDefault2 has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackInvokeDefault2 has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -419,7 +443,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -427,6 +451,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackSet has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackSet has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] @@ -473,7 +501,7 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -481,6 +509,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Late binding is dynamic and cannot be statically analyzed. The referenced types and members may be trimmed")>] + + [System.Obsolete("FallbackSetComplex has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackSetComplex has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] diff --git a/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml b/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml index fd2a916ca98..c74bf8cf6ca 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml @@ -1149,7 +1149,7 @@ 11.0.0.0 - + [System.Obsolete("do not use this method", true)] [<System.Obsolete("do not use this method", true)>] @@ -1157,6 +1157,10 @@ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The object types cannot be statically analyzed so their operators may be trimmed")] [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The object types cannot be statically analyzed so their operators may be trimmed")>] + + [System.Obsolete("FallbackInvokeUserDefinedOperator has been deprecated and is not supported.", true)] + [<System.Obsolete("FallbackInvokeUserDefinedOperator has been deprecated and is not supported.", true)>] + [System.Diagnostics.DebuggerStepThrough] [<System.Diagnostics.DebuggerStepThrough>] diff --git a/xml/Microsoft.VisualBasic/Constants.xml b/xml/Microsoft.VisualBasic/Constants.xml index c4caecc207b..2ab9fa7dd69 100644 --- a/xml/Microsoft.VisualBasic/Constants.xml +++ b/xml/Microsoft.VisualBasic/Constants.xml @@ -2494,10 +2494,14 @@ 11.0.0.0 - + [System.Obsolete("For a carriage return and line feed, use vbCrLf. For the current platform's newline, use System.Environment.NewLine.")] [<System.Obsolete("For a carriage return and line feed, use vbCrLf. For the current platform's newline, use System.Environment.NewLine.")>] + + [System.Obsolete("vbNewLine has been deprecated. For a carriage return and line feed, use vbCrLf. For the current platform's newline, use System.Environment.NewLine.")] + [<System.Obsolete("vbNewLine has been deprecated. For a carriage return and line feed, use vbCrLf. For the current platform's newline, use System.Environment.NewLine.")>] + System.String diff --git a/xml/Microsoft.VisualBasic/FileSystem.xml b/xml/Microsoft.VisualBasic/FileSystem.xml index 087936f7af5..b0ee9f48469 100644 --- a/xml/Microsoft.VisualBasic/FileSystem.xml +++ b/xml/Microsoft.VisualBasic/FileSystem.xml @@ -3527,8 +3527,8 @@ [<System.Obsolete("This member has been deprecated. Please use FilePutObject to write Object types, or coerce FileNumber and RecordNumber to Integer for writing non-Object types. http://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This member has been deprecated. Please use FilePutObject to write Object types, or coerce FileNumber and RecordNumber to Integer for writing non-Object types. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This member has been deprecated. Please use FilePutObject to write Object types, or coerce FileNumber and RecordNumber to Integer for writing non-Object types. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("FileSystem.FilePut has been deprecated. Use FilePutObject to write Object types, or coerce FileNumber and RecordNumber to Integer for writing non-Object types.")] + [<System.Obsolete("FileSystem.FilePut has been deprecated. Use FilePutObject to write Object types, or coerce FileNumber and RecordNumber to Integer for writing non-Object types.")>] [System.Obsolete("Use FilePutObject to write Object types, or coerce FileNumber and RecordNumber to Integer for writing non-Object types")] @@ -5131,10 +5131,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -5414,10 +5410,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -5490,10 +5482,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -5568,10 +5556,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -6568,10 +6552,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -6644,10 +6624,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -6722,10 +6698,6 @@ Result = GetAttr(FName) And vbArchive [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] diff --git a/xml/Microsoft.VisualBasic/VBCodeProvider.xml b/xml/Microsoft.VisualBasic/VBCodeProvider.xml index 46895d7d549..8e121c48d51 100644 --- a/xml/Microsoft.VisualBasic/VBCodeProvider.xml +++ b/xml/Microsoft.VisualBasic/VBCodeProvider.xml @@ -185,10 +185,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeCompiler interface and should instead use the methods directly on the CodeDomProvider class.")] [<System.Obsolete("Callers should not use the ICodeCompiler interface and should instead use the methods directly on the CodeDomProvider class.")>] + + [System.Obsolete("ICodeCompiler has been deprecated. Use the methods directly on the CodeDomProvider class instead.")] + [<System.Obsolete("ICodeCompiler has been deprecated. Use the methods directly on the CodeDomProvider class instead.")>] + [System.Obsolete("Use CodeDomProvider class")] [<System.Obsolete("Use CodeDomProvider class")>] @@ -228,10 +232,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeGenerator interface and should instead use the methods directly on the CodeDomProvider class.")] [<System.Obsolete("Callers should not use the ICodeGenerator interface and should instead use the methods directly on the CodeDomProvider class.")>] + + [System.Obsolete("ICodeGenerator has been deprecated. Use the methods directly on the CodeDomProvider class instead.")] + [<System.Obsolete("ICodeGenerator has been deprecated. Use the methods directly on the CodeDomProvider class instead.")>] + [System.Obsolete("Use CodeDomProvider class")] [<System.Obsolete("Use CodeDomProvider class")>] diff --git a/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml index 1113cc78fc9..1806ec49d4e 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml @@ -113,7 +113,7 @@ - To be added. + Creates a around a file handle. To be added. @@ -203,8 +203,8 @@ System.Boolean - To be added. - To be added. + Gets a value that determines if the handle is asynchronous or not. + if the handle is asynchronous; otherwise. To be added. diff --git a/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml index ac4ac67ce17..0f55acd00db 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml @@ -69,7 +69,7 @@ - To be added. + Initializes a instance. To be added. diff --git a/xml/Microsoft.Win32/SystemEvents.xml b/xml/Microsoft.Win32/SystemEvents.xml index 210aa129507..033ae71b2eb 100644 --- a/xml/Microsoft.Win32/SystemEvents.xml +++ b/xml/Microsoft.Win32/SystemEvents.xml @@ -458,10 +458,14 @@ [System.Obsolete("This event has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This event has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This event has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This event has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("The LowMemory event has been deprecated and is not supported.")] + [<System.Obsolete("The LowMemory event has been deprecated and is not supported.")>] + [System.MonoTODO("Currently does nothing on Mono")] [<System.MonoTODO("Currently does nothing on Mono")>] diff --git a/xml/System.CodeDom.Compiler/CodeDomProvider.xml b/xml/System.CodeDom.Compiler/CodeDomProvider.xml index 7fd14bb90ae..38352f69f7b 100644 --- a/xml/System.CodeDom.Compiler/CodeDomProvider.xml +++ b/xml/System.CodeDom.Compiler/CodeDomProvider.xml @@ -1,10 +1,11 @@ - + + System 1.0.5000.0 @@ -319,10 +320,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeCompiler interface and should instead use the methods directly on the CodeDomProvider class. Those inheriting from CodeDomProvider must still implement this interface, and should exclude this warning or also obsolete this method.")] [<System.Obsolete("Callers should not use the ICodeCompiler interface and should instead use the methods directly on the CodeDomProvider class. Those inheriting from CodeDomProvider must still implement this interface, and should exclude this warning or also obsolete this method.")>] + + [System.Obsolete("ICodeCompiler has been deprecated. Use the methods directly on the CodeDomProvider class instead. Classes inheriting from CodeDomProvider must still implement this interface, and should suppress this warning or also mark this method as obsolete.")] + [<System.Obsolete("ICodeCompiler has been deprecated. Use the methods directly on the CodeDomProvider class instead. Classes inheriting from CodeDomProvider must still implement this interface, and should suppress this warning or also mark this method as obsolete.")>] + [System.Obsolete("ICodeCompiler is obsolete")] [<System.Obsolete("ICodeCompiler is obsolete")>] @@ -428,10 +433,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeGenerator interface and should instead use the methods directly on the CodeDomProvider class. Those inheriting from CodeDomProvider must still implement this interface, and should exclude this warning or also obsolete this method.")] [<System.Obsolete("Callers should not use the ICodeGenerator interface and should instead use the methods directly on the CodeDomProvider class. Those inheriting from CodeDomProvider must still implement this interface, and should exclude this warning or also obsolete this method.")>] + + [System.Obsolete("ICodeGenerator has been deprecated. Use the methods directly on the CodeDomProvider class instead. Classes inheriting from CodeDomProvider must still implement this interface, and should suppress this warning or also mark this method as obsolete.")] + [<System.Obsolete("ICodeGenerator has been deprecated. Use the methods directly on the CodeDomProvider class instead. Classes inheriting from CodeDomProvider must still implement this interface, and should suppress this warning or also mark this method as obsolete.")>] + [System.Obsolete("ICodeGenerator is obsolete")] [<System.Obsolete("ICodeGenerator is obsolete")>] @@ -583,10 +592,14 @@ 6.0.0.0 - + [System.Obsolete("Callers should not use the ICodeParser interface and should instead use the methods directly on the CodeDomProvider class. Those inheriting from CodeDomProvider must still implement this interface, and should exclude this warning or also obsolete this method.")] [<System.Obsolete("Callers should not use the ICodeParser interface and should instead use the methods directly on the CodeDomProvider class. Those inheriting from CodeDomProvider must still implement this interface, and should exclude this warning or also obsolete this method.")>] + + [System.Obsolete("ICodeParser has been deprecated. Use the methods directly on the CodeDomProvider class instead. Classes inheriting from CodeDomProvider must still implement this interface, and should suppress this warning or also mark this method as obsolete.")] + [<System.Obsolete("ICodeParser has been deprecated. Use the methods directly on the CodeDomProvider class instead. Classes inheriting from CodeDomProvider must still implement this interface, and should suppress this warning or also mark this method as obsolete.")>] + [System.Obsolete("ICodeParser is obsolete")] [<System.Obsolete("ICodeParser is obsolete")>] diff --git a/xml/System.CodeDom.Compiler/IndentedTextWriter.xml b/xml/System.CodeDom.Compiler/IndentedTextWriter.xml index 9ef9fd8cbe2..8eec2b13254 100644 --- a/xml/System.CodeDom.Compiler/IndentedTextWriter.xml +++ b/xml/System.CodeDom.Compiler/IndentedTextWriter.xml @@ -307,8 +307,8 @@ - To be added. - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. + A representing the asynchronous dispose operation. To be added. @@ -431,8 +431,8 @@ - To be added. - To be added. + Clears all buffers for this asynchronously and causes any buffered data to be written to the underlying device. + A representing the asynchronous flush operation. To be added. @@ -2225,8 +2225,8 @@ - To be added. - To be added. + Asynchronously writes the line terminator to the underlying . + A representing the asynchronous line writing operation. To be added. diff --git a/xml/System.CodeDom/CodeMemberMethod.xml b/xml/System.CodeDom/CodeMemberMethod.xml index c40d25fb673..7e8ff8947d5 100644 --- a/xml/System.CodeDom/CodeMemberMethod.xml +++ b/xml/System.CodeDom/CodeMemberMethod.xml @@ -181,10 +181,10 @@ - + - + Event System @@ -212,10 +212,10 @@ - + - + Event System @@ -243,10 +243,10 @@ - + - + Event System diff --git a/xml/System.CodeDom/CodeNamespace.xml b/xml/System.CodeDom/CodeNamespace.xml index e580e5569c7..af83104f6b7 100644 --- a/xml/System.CodeDom/CodeNamespace.xml +++ b/xml/System.CodeDom/CodeNamespace.xml @@ -238,10 +238,10 @@ - + - + Event System @@ -269,10 +269,10 @@ - + - + Event System @@ -300,10 +300,10 @@ - + - + Event System diff --git a/xml/System.CodeDom/CodeNamespaceImportCollection.xml b/xml/System.CodeDom/CodeNamespaceImportCollection.xml index bfe2165714e..e2bac60661c 100644 --- a/xml/System.CodeDom/CodeNamespaceImportCollection.xml +++ b/xml/System.CodeDom/CodeNamespaceImportCollection.xml @@ -3,10 +3,10 @@ - + + - System 1.0.5000.0 diff --git a/xml/System.CodeDom/CodeTypeDeclaration.xml b/xml/System.CodeDom/CodeTypeDeclaration.xml index b79a9c7bc0d..7e0295e6ba1 100644 --- a/xml/System.CodeDom/CodeTypeDeclaration.xml +++ b/xml/System.CodeDom/CodeTypeDeclaration.xml @@ -459,10 +459,10 @@ Implements Interface1 - + - + Event System @@ -490,10 +490,10 @@ Implements Interface1 - + - + Event System diff --git a/xml/System.CodeDom/CodeTypeReference.xml b/xml/System.CodeDom/CodeTypeReference.xml index 9a8606a835c..409ad7dc3be 100644 --- a/xml/System.CodeDom/CodeTypeReference.xml +++ b/xml/System.CodeDom/CodeTypeReference.xml @@ -136,12 +136,13 @@ - + + Constructor System @@ -394,12 +395,13 @@ - + + Property System diff --git a/xml/System.CodeDom/MemberAttributes.xml b/xml/System.CodeDom/MemberAttributes.xml index 8f07cb36aa6..8bd5a716496 100644 --- a/xml/System.CodeDom/MemberAttributes.xml +++ b/xml/System.CodeDom/MemberAttributes.xml @@ -24,6 +24,10 @@ System.Enum + + [System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + [System.Runtime.InteropServices.ComVisible(true)] [<System.Runtime.InteropServices.ComVisible(true)>] diff --git a/xml/System.Collections.Specialized/NameObjectCollectionBase.xml b/xml/System.Collections.Specialized/NameObjectCollectionBase.xml index ac9130fa53c..5243ebe38c0 100644 --- a/xml/System.Collections.Specialized/NameObjectCollectionBase.xml +++ b/xml/System.Collections.Specialized/NameObjectCollectionBase.xml @@ -313,10 +313,14 @@ 6.0.0.0 - + [System.Obsolete("Please use NameObjectCollectionBase(IEqualityComparer) instead.")] [<System.Obsolete("Please use NameObjectCollectionBase(IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use NameObjectCollectionBase(IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use NameObjectCollectionBase(IEqualityComparer) instead.")>] + @@ -493,10 +497,14 @@ 6.0.0.0 - + [System.Obsolete("Please use NameObjectCollectionBase(Int32, IEqualityComparer) instead.")] [<System.Obsolete("Please use NameObjectCollectionBase(Int32, IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use NameObjectCollectionBase(Int32, IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use NameObjectCollectionBase(Int32, IEqualityComparer) instead.")>] + diff --git a/xml/System.Collections.Specialized/NameValueCollection.xml b/xml/System.Collections.Specialized/NameValueCollection.xml index 59c6ecd4723..37dd807ce71 100644 --- a/xml/System.Collections.Specialized/NameValueCollection.xml +++ b/xml/System.Collections.Specialized/NameValueCollection.xml @@ -369,10 +369,14 @@ 6.0.0.0 - + [System.Obsolete("Please use NameValueCollection(IEqualityComparer) instead.")] [<System.Obsolete("Please use NameValueCollection(IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use NameValueCollection(IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use NameValueCollection(IEqualityComparer) instead.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] @@ -622,10 +626,14 @@ 6.0.0.0 - + [System.Obsolete("Please use NameValueCollection(Int32, IEqualityComparer) instead.")] [<System.Obsolete("Please use NameValueCollection(Int32, IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use NameValueCollection(Int32, IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use NameValueCollection(Int32, IEqualityComparer) instead.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] diff --git a/xml/System.Collections/CaseInsensitiveHashCodeProvider.xml b/xml/System.Collections/CaseInsensitiveHashCodeProvider.xml index 3e2fa880cc7..37a6e647d5d 100644 --- a/xml/System.Collections/CaseInsensitiveHashCodeProvider.xml +++ b/xml/System.Collections/CaseInsensitiveHashCodeProvider.xml @@ -40,10 +40,14 @@ - + [System.Obsolete("Please use StringComparer instead.")] [<System.Obsolete("Please use StringComparer instead.")>] + + [System.Obsolete("CaseInsensitiveHashCodeProvider has been deprecated. Use StringComparer instead.")] + [<System.Obsolete("CaseInsensitiveHashCodeProvider has been deprecated. Use StringComparer instead.")>] + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Collections/Hashtable.xml b/xml/System.Collections/Hashtable.xml index 987540b72d3..4be990bd936 100644 --- a/xml/System.Collections/Hashtable.xml +++ b/xml/System.Collections/Hashtable.xml @@ -683,10 +683,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use Hashtable(IEqualityComparer) instead.")] [<System.Obsolete("Please use Hashtable(IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use Hashtable(IEqualityComparer).")] + [<System.Obsolete("This constructor has been deprecated. Use Hashtable(IEqualityComparer).")>] + @@ -1018,10 +1022,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use Hashtable(IDictionary, IEqualityComparer) instead.")] [<System.Obsolete("Please use Hashtable(IDictionary, IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use Hashtable(IDictionary, IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use Hashtable(IDictionary, IEqualityComparer) instead.")>] + @@ -1211,10 +1219,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use Hashtable(int, IEqualityComparer) instead.")] [<System.Obsolete("Please use Hashtable(int, IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use Hashtable(int, IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use Hashtable(int, IEqualityComparer) instead.")>] + @@ -1401,10 +1413,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use Hashtable(IDictionary, float, IEqualityComparer) instead.")] [<System.Obsolete("Please use Hashtable(IDictionary, float, IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use Hashtable(IDictionary, float, IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use Hashtable(IDictionary, float, IEqualityComparer) instead.")>] + @@ -1503,10 +1519,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use Hashtable(int, float, IEqualityComparer) instead.")] [<System.Obsolete("Please use Hashtable(int, float, IEqualityComparer) instead.")>] + + [System.Obsolete("This constructor has been deprecated. Use Hashtable(int, float, IEqualityComparer) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use Hashtable(int, float, IEqualityComparer) instead.")>] + @@ -1839,10 +1859,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use KeyComparer properties.")] [<System.Obsolete("Please use KeyComparer properties.")>] + + [System.Obsolete("Hashtable.comparer has been deprecated. Use the KeyComparer properties instead.")] + [<System.Obsolete("Hashtable.comparer has been deprecated. Use the KeyComparer properties instead.")>] + System.Collections.IComparer @@ -2559,10 +2583,14 @@ Each element is a key/value pair stored in a 6.0.0.0 - + [System.Obsolete("Please use EqualityComparer property.")] [<System.Obsolete("Please use EqualityComparer property.")>] + + [System.Obsolete("Hashtable.hcp has been deprecated. Use the EqualityComparer property instead.")] + [<System.Obsolete("Hashtable.hcp has been deprecated. Use the EqualityComparer property instead.")>] + System.Collections.IHashCodeProvider diff --git a/xml/System.Collections/IHashCodeProvider.xml b/xml/System.Collections/IHashCodeProvider.xml index f40838b7ee9..36fcb9eded6 100644 --- a/xml/System.Collections/IHashCodeProvider.xml +++ b/xml/System.Collections/IHashCodeProvider.xml @@ -45,10 +45,14 @@ - + [System.Obsolete("Please use IEqualityComparer instead.")] [<System.Obsolete("Please use IEqualityComparer instead.")>] + + [System.Obsolete("IHashCodeProvider has been deprecated. Use IEqualityComparer instead.")] + [<System.Obsolete("IHashCodeProvider has been deprecated. Use IEqualityComparer instead.")>] + [System.Runtime.InteropServices.ComVisible(true)] [<System.Runtime.InteropServices.ComVisible(true)>] diff --git a/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml b/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml index fb4def727df..6b0f143e4bd 100644 --- a/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml +++ b/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml @@ -19,7 +19,7 @@ - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Hosting.AssemblyCatalogDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Hosting.AssemblyCatalogDebuggerProxy))>] diff --git a/xml/System.ComponentModel.Composition.Hosting/CompositionScopeDefinition.xml b/xml/System.ComponentModel.Composition.Hosting/CompositionScopeDefinition.xml index 9de7f165c2c..96f5c1db37d 100644 --- a/xml/System.ComponentModel.Composition.Hosting/CompositionScopeDefinition.xml +++ b/xml/System.ComponentModel.Composition.Hosting/CompositionScopeDefinition.xml @@ -19,7 +19,7 @@ - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Hosting.CompositionScopeDefinitionDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Hosting.CompositionScopeDefinitionDebuggerProxy))>] @@ -120,11 +120,11 @@ - + - + Event E:System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged.Changed @@ -146,11 +146,11 @@ - + - + Event E:System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged.Changing diff --git a/xml/System.ComponentModel.Composition.Hosting/DirectoryCatalog.xml b/xml/System.ComponentModel.Composition.Hosting/DirectoryCatalog.xml index 46883e10769..c9d2888aeaa 100644 --- a/xml/System.ComponentModel.Composition.Hosting/DirectoryCatalog.xml +++ b/xml/System.ComponentModel.Composition.Hosting/DirectoryCatalog.xml @@ -22,7 +22,7 @@ - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Hosting.DirectoryCatalog+DirectoryCatalogDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Hosting.DirectoryCatalog+DirectoryCatalogDebuggerProxy))>] @@ -365,11 +365,11 @@ - + - + Event E:System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged.Changed @@ -391,11 +391,11 @@ - + - + Event E:System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged.Changing diff --git a/xml/System.ComponentModel.Composition.Hosting/ExportProvider.xml b/xml/System.ComponentModel.Composition.Hosting/ExportProvider.xml index c46a5955914..c0456145ae9 100644 --- a/xml/System.ComponentModel.Composition.Hosting/ExportProvider.xml +++ b/xml/System.ComponentModel.Composition.Hosting/ExportProvider.xml @@ -47,11 +47,11 @@ - + - + Event System.ComponentModel.Composition @@ -70,11 +70,11 @@ - + - + Event System.ComponentModel.Composition diff --git a/xml/System.ComponentModel.Composition.Hosting/FilteredCatalog.xml b/xml/System.ComponentModel.Composition.Hosting/FilteredCatalog.xml index eb6a007f25b..738a53fa8a9 100644 --- a/xml/System.ComponentModel.Composition.Hosting/FilteredCatalog.xml +++ b/xml/System.ComponentModel.Composition.Hosting/FilteredCatalog.xml @@ -60,11 +60,11 @@ - + - + Event E:System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged.Changed @@ -86,11 +86,11 @@ - + - + Event E:System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged.Changing diff --git a/xml/System.ComponentModel.Composition.Hosting/TypeCatalog.xml b/xml/System.ComponentModel.Composition.Hosting/TypeCatalog.xml index bad36ec4ae1..cdcc079d8eb 100644 --- a/xml/System.ComponentModel.Composition.Hosting/TypeCatalog.xml +++ b/xml/System.ComponentModel.Composition.Hosting/TypeCatalog.xml @@ -19,7 +19,7 @@ - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartCatalogDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartCatalogDebuggerProxy))>] diff --git a/xml/System.ComponentModel.Composition.Primitives/ComposablePartCatalog.xml b/xml/System.ComponentModel.Composition.Primitives/ComposablePartCatalog.xml index 7f43b963b8b..e042f73e66e 100644 --- a/xml/System.ComponentModel.Composition.Primitives/ComposablePartCatalog.xml +++ b/xml/System.ComponentModel.Composition.Primitives/ComposablePartCatalog.xml @@ -31,7 +31,7 @@ - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartCatalogDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartCatalogDebuggerProxy))>] diff --git a/xml/System.ComponentModel.Composition.Primitives/ComposablePartException.xml b/xml/System.ComponentModel.Composition.Primitives/ComposablePartException.xml index 07ae7f6a4d1..b8bbaad023d 100644 --- a/xml/System.ComponentModel.Composition.Primitives/ComposablePartException.xml +++ b/xml/System.ComponentModel.Composition.Primitives/ComposablePartException.xml @@ -1,11 +1,11 @@ - + - + System.ComponentModel.Composition 2.0.5.0 @@ -16,18 +16,18 @@ - - [System.Serializable] - [<System.Serializable>] - - + [System.Diagnostics.DebuggerDisplay("{Message}")] [<System.Diagnostics.DebuggerDisplay("{Message}")>] - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartExceptionDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartExceptionDebuggerProxy))>] + + [System.Serializable] + [<System.Serializable>] + The exception that is thrown when an error occurs when calling methods on a object. diff --git a/xml/System.ComponentModel.Composition/CompositionContractMismatchException.xml b/xml/System.ComponentModel.Composition/CompositionContractMismatchException.xml index 9a9003f9428..e0aed653e07 100644 --- a/xml/System.ComponentModel.Composition/CompositionContractMismatchException.xml +++ b/xml/System.ComponentModel.Composition/CompositionContractMismatchException.xml @@ -1,11 +1,11 @@ - + - + System.ComponentModel.Composition 2.0.5.0 @@ -16,7 +16,7 @@ - + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.ComponentModel.Composition/CompositionError.xml b/xml/System.ComponentModel.Composition/CompositionError.xml index d5bf6c5fcaf..edcae0885d6 100644 --- a/xml/System.ComponentModel.Composition/CompositionError.xml +++ b/xml/System.ComponentModel.Composition/CompositionError.xml @@ -16,7 +16,7 @@ - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.CompositionErrorDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.CompositionErrorDebuggerProxy))>] diff --git a/xml/System.ComponentModel.Composition/CompositionException.xml b/xml/System.ComponentModel.Composition/CompositionException.xml index 808ff4fe940..dc2d92ad329 100644 --- a/xml/System.ComponentModel.Composition/CompositionException.xml +++ b/xml/System.ComponentModel.Composition/CompositionException.xml @@ -16,18 +16,18 @@ - - [System.Serializable] - [<System.Serializable>] - - + [System.Diagnostics.DebuggerDisplay("{Message}")] [<System.Diagnostics.DebuggerDisplay("{Message}")>] - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.CompositionExceptionDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.CompositionExceptionDebuggerProxy))>] + + [System.Serializable] + [<System.Serializable>] + Represents the exception that is thrown when one or more errors occur during composition in a object. diff --git a/xml/System.ComponentModel.Composition/ImportCardinalityMismatchException.xml b/xml/System.ComponentModel.Composition/ImportCardinalityMismatchException.xml index ef207d56c34..5ebab287662 100644 --- a/xml/System.ComponentModel.Composition/ImportCardinalityMismatchException.xml +++ b/xml/System.ComponentModel.Composition/ImportCardinalityMismatchException.xml @@ -1,11 +1,11 @@ - + - + System.ComponentModel.Composition 2.0.5.0 @@ -16,18 +16,18 @@ - - [System.Serializable] - [<System.Serializable>] - - + [System.Diagnostics.DebuggerDisplay("{Message}")] [<System.Diagnostics.DebuggerDisplay("{Message}")>] - + [System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.ImportCardinalityMismatchExceptionDebuggerProxy))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.ImportCardinalityMismatchExceptionDebuggerProxy))>] + + [System.Serializable] + [<System.Serializable>] + The exception that is thrown when the cardinality of an import is not compatible with the cardinality of the matching exports. diff --git a/xml/System.ComponentModel.DataAnnotations/AssociationAttribute.xml b/xml/System.ComponentModel.DataAnnotations/AssociationAttribute.xml index 2005dda6120..536bbc366f7 100644 --- a/xml/System.ComponentModel.DataAnnotations/AssociationAttribute.xml +++ b/xml/System.ComponentModel.DataAnnotations/AssociationAttribute.xml @@ -32,10 +32,14 @@ [System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)] [<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>] - + [System.Obsolete("This attribute is no longer in use and will be ignored if applied.")] [<System.Obsolete("This attribute is no longer in use and will be ignored if applied.")>] + + [System.Obsolete("AssociationAttribute has been deprecated and is not supported.")] + [<System.Obsolete("AssociationAttribute has been deprecated and is not supported.")>] + Specifies that an entity member represents a data relationship, such as a foreign key relationship. diff --git a/xml/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml b/xml/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml index 62606c77c1a..8f74b3e2e9a 100644 --- a/xml/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml +++ b/xml/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml @@ -32,10 +32,14 @@ [System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)] [<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>] - + [System.Obsolete("This attribute is no longer in use and will be ignored if applied.")] [<System.Obsolete("This attribute is no longer in use and will be ignored if applied.")>] + + [System.Obsolete("FilterUIHintAttribute has been deprecated and is not supported.")] + [<System.Obsolete("FilterUIHintAttribute has been deprecated and is not supported.")>] + Represents an attribute that is used to specify the filtering behavior for a column. diff --git a/xml/System.ComponentModel.Design.Serialization/RootDesignerSerializerAttribute.xml b/xml/System.ComponentModel.Design.Serialization/RootDesignerSerializerAttribute.xml index ee3569138f2..fafa167fc6c 100644 --- a/xml/System.ComponentModel.Design.Serialization/RootDesignerSerializerAttribute.xml +++ b/xml/System.ComponentModel.Design.Serialization/RootDesignerSerializerAttribute.xml @@ -38,10 +38,14 @@ [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=true, Inherited=true)] [<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=true, Inherited=true)>] - + [System.Obsolete("This attribute has been deprecated. Use DesignerSerializerAttribute instead. For example, to specify a root designer for CodeDom, use DesignerSerializerAttribute(...,typeof(TypeCodeDomSerializer)). https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This attribute has been deprecated. Use DesignerSerializerAttribute instead. For example, to specify a root designer for CodeDom, use DesignerSerializerAttribute(...,typeof(TypeCodeDomSerializer)). https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("RootDesignerSerializerAttribute has been deprecated. Use DesignerSerializerAttribute instead. For example, to specify a root designer for CodeDom, use DesignerSerializerAttribute(...,typeof(TypeCodeDomSerializer)) instead.")] + [<System.Obsolete("RootDesignerSerializerAttribute has been deprecated. Use DesignerSerializerAttribute instead. For example, to specify a root designer for CodeDom, use DesignerSerializerAttribute(...,typeof(TypeCodeDomSerializer)) instead.")>] + [System.Obsolete("This attribute has been deprecated. Use DesignerSerializerAttribute instead. For example, to specify a root designer for CodeDom, use DesignerSerializerAttribute(...,typeof(TypeCodeDomSerializer)). http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This attribute has been deprecated. Use DesignerSerializerAttribute instead. For example, to specify a root designer for CodeDom, use DesignerSerializerAttribute(...,typeof(TypeCodeDomSerializer)). http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.ComponentModel.Design/DesignerTransactionCloseEventArgs.xml b/xml/System.ComponentModel.Design/DesignerTransactionCloseEventArgs.xml index efbea137751..c90cfd603a9 100644 --- a/xml/System.ComponentModel.Design/DesignerTransactionCloseEventArgs.xml +++ b/xml/System.ComponentModel.Design/DesignerTransactionCloseEventArgs.xml @@ -105,8 +105,8 @@ [<System.Obsolete("This constructor is obsolete. Use DesignerTransactionCloseEventArgs(bool, bool) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This constructor is obsolete. Use DesignerTransactionCloseEventArgs(bool, bool) instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This constructor is obsolete. Use DesignerTransactionCloseEventArgs(bool, bool) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("This constructor has been deprecated. Use DesignerTransactionCloseEventArgs(bool, bool) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use DesignerTransactionCloseEventArgs(bool, bool) instead.")>] [System.Obsolete("This constructor is obsolete. Use DesignerTransactionCloseEventArgs(bool, bool) instead. http://go.microsoft.com/fwlink/?linkid=14202")] diff --git a/xml/System.ComponentModel.Design/SelectionTypes.xml b/xml/System.ComponentModel.Design/SelectionTypes.xml index ac54052e279..4aa2e6d5432 100644 --- a/xml/System.ComponentModel.Design/SelectionTypes.xml +++ b/xml/System.ComponentModel.Design/SelectionTypes.xml @@ -157,10 +157,14 @@ 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Use SelectionTypes.Primary instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use SelectionTypes.Primary instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SelectionTypes.Click has been deprecated. Use SelectionTypes.Primary instead.")] + [<System.Obsolete("SelectionTypes.Click has been deprecated. Use SelectionTypes.Primary instead.")>] + [System.Obsolete("This value has been deprecated. Use SelectionTypes.Primary instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use SelectionTypes.Primary instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -207,10 +211,14 @@ 6.0.0.0 - + [System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SelectionTypes.MouseDown has been deprecated and is not supported.")] + [<System.Obsolete("SelectionTypes.MouseDown has been deprecated and is not supported.")>] + [System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -257,10 +265,14 @@ 6.0.0.0 - + [System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SelectionTypes.MouseUp has been deprecated and is not supported.")] + [<System.Obsolete("SelectionTypes.MouseUp has been deprecated and is not supported.")>] + [System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -307,10 +319,14 @@ 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Use SelectionTypes.Auto instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use SelectionTypes.Auto instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SelectionTypes.Normal has been deprecated. Use SelectionTypes.Auto instead.")] + [<System.Obsolete("SelectionTypes.Normal has been deprecated. Use SelectionTypes.Auto instead.")>] + [System.Obsolete("This value has been deprecated. Use SelectionTypes.Auto instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use SelectionTypes.Auto instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -498,10 +514,14 @@ 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Use Enum class methods to determine valid values, or use a type converter. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use Enum class methods to determine valid values, or use a type converter. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SelectionTypes.Valid has been deprecated. Use Enum class methods to determine valid values, or use a type converter instead.")] + [<System.Obsolete("SelectionTypes.Valid has been deprecated. Use Enum class methods to determine valid values, or use a type converter instead.")>] + [System.Obsolete("This value has been deprecated. Use Enum class methods to determine valid values, or use a type converter. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use Enum class methods to determine valid values, or use a type converter. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.ComponentModel.Design/ViewTechnology.xml b/xml/System.ComponentModel.Design/ViewTechnology.xml index e19f8472d61..fa13777daa8 100644 --- a/xml/System.ComponentModel.Design/ViewTechnology.xml +++ b/xml/System.ComponentModel.Design/ViewTechnology.xml @@ -138,10 +138,14 @@ The root designer may return any type of object, but the object must be compatib 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("ViewTechnology.Passthrough has been deprecated. Use ViewTechnology.Default instead.")] + [<System.Obsolete("ViewTechnology.Passthrough has been deprecated. Use ViewTechnology.Default instead.")>] + [System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -190,10 +194,14 @@ The view object must implement any interfaces the development environment requir 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("ViewTechnology.WindowsForms has been deprecated. Use ViewTechnology.Default instead.")] + [<System.Obsolete("ViewTechnology.WindowsForms has been deprecated. Use ViewTechnology.Default instead.")>] + [System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. Use ViewTechnology.Default instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.ComponentModel/BackgroundWorker.xml b/xml/System.ComponentModel/BackgroundWorker.xml index 0f4e86ec840..a6dcb6f8905 100644 --- a/xml/System.ComponentModel/BackgroundWorker.xml +++ b/xml/System.ComponentModel/BackgroundWorker.xml @@ -330,8 +330,8 @@ - To be added. - To be added. + This method does not do anything. + This method does not do anything. To be added. diff --git a/xml/System.ComponentModel/TypeDescriptor.xml b/xml/System.ComponentModel/TypeDescriptor.xml index 4770d283617..fd67c88a2a1 100644 --- a/xml/System.ComponentModel/TypeDescriptor.xml +++ b/xml/System.ComponentModel/TypeDescriptor.xml @@ -581,10 +581,14 @@ 6.0.0.0 - + [System.Obsolete("This property has been deprecated. Use a type description provider to supply type information for COM types instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Use a type description provider to supply type information for COM types instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("TypeDescriptor.ComNativeDescriptorHandler has been deprecated. Use a type description provider to supply type information for COM types instead.")] + [<System.Obsolete("TypeDescriptor.ComNativeDescriptorHandler has been deprecated. Use a type description provider to supply type information for COM types instead.")>] + [System.Obsolete("This property has been deprecated. Use a type description provider to supply type information for COM types instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Use a type description provider to supply type information for COM types instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Configuration.Provider/ProviderException.xml b/xml/System.Configuration.Provider/ProviderException.xml index 9a5f3973c97..cc4cc64ef62 100644 --- a/xml/System.Configuration.Provider/ProviderException.xml +++ b/xml/System.Configuration.Provider/ProviderException.xml @@ -1,11 +1,11 @@ - + - + System.Configuration 2.0.0.0 @@ -24,7 +24,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Configuration/AppSettingsSection.xml b/xml/System.Configuration/AppSettingsSection.xml index ef08f9ab84f..d219469a396 100644 --- a/xml/System.Configuration/AppSettingsSection.xml +++ b/xml/System.Configuration/AppSettingsSection.xml @@ -76,16 +76,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -136,7 +136,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("file", DefaultValue="")] [<System.Configuration.ConfigurationProperty("file", DefaultValue="")>] @@ -163,16 +163,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -198,12 +198,12 @@ - - + + - + - + @@ -233,15 +233,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -266,16 +266,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -303,12 +303,12 @@ - - + + - - - + + + @@ -336,10 +336,10 @@ System.String - + - - + + @@ -375,7 +375,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)] [<System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)>] diff --git a/xml/System.Configuration/ClientSettingsSection.xml b/xml/System.Configuration/ClientSettingsSection.xml index 2b4e6be87c5..df44521bbee 100644 --- a/xml/System.Configuration/ClientSettingsSection.xml +++ b/xml/System.Configuration/ClientSettingsSection.xml @@ -84,12 +84,15 @@ - + - + - + + + + Property System @@ -141,7 +144,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)] [<System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)>] diff --git a/xml/System.Configuration/ConfigurationElement.xml b/xml/System.Configuration/ConfigurationElement.xml index 418fae2201a..17101f394c5 100644 --- a/xml/System.Configuration/ConfigurationElement.xml +++ b/xml/System.Configuration/ConfigurationElement.xml @@ -177,16 +177,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -277,15 +277,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -528,16 +528,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -562,16 +562,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -603,16 +603,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -729,15 +729,15 @@ - + - + - - - - + + + + @@ -784,15 +784,15 @@ - + - + - - - - + + + + @@ -1355,15 +1355,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -1401,16 +1401,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1438,16 +1438,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1479,16 +1479,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1532,16 +1532,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1620,16 +1620,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1664,16 +1664,16 @@ - - + + - + - - - - - + + + + + diff --git a/xml/System.Configuration/ConfigurationElementCollection.xml b/xml/System.Configuration/ConfigurationElementCollection.xml index 790f3156b95..0f1d702de5d 100644 --- a/xml/System.Configuration/ConfigurationElementCollection.xml +++ b/xml/System.Configuration/ConfigurationElementCollection.xml @@ -178,15 +178,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -281,16 +281,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -373,16 +373,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -436,16 +436,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -490,16 +490,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -543,16 +543,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -578,16 +578,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -665,16 +665,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -704,16 +704,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -757,16 +757,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -822,15 +822,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -1384,16 +1384,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1549,15 +1549,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -1583,16 +1583,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1627,16 +1627,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1668,16 +1668,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1718,16 +1718,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -1870,16 +1870,16 @@ - - + + - + - - - - - + + + + + diff --git a/xml/System.Configuration/ConfigurationErrorsException.xml b/xml/System.Configuration/ConfigurationErrorsException.xml index 759a4f10ef9..7bfd8453122 100644 --- a/xml/System.Configuration/ConfigurationErrorsException.xml +++ b/xml/System.Configuration/ConfigurationErrorsException.xml @@ -1,11 +1,11 @@ - + - + System.Configuration 2.0.0.0 @@ -24,7 +24,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Configuration/ConfigurationException.xml b/xml/System.Configuration/ConfigurationException.xml index 65ee8fd49bc..fc7f8ef1065 100644 --- a/xml/System.Configuration/ConfigurationException.xml +++ b/xml/System.Configuration/ConfigurationException.xml @@ -1,11 +1,11 @@ - + - + System 1.0.5000.0 @@ -25,7 +25,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + [System.Serializable] [<System.Serializable>] @@ -82,8 +86,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] @@ -128,8 +132,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] @@ -210,8 +214,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] @@ -261,8 +265,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Obsolete("This class is obsolete. Use System.Configuration.ConfigurationErrorsException")] @@ -308,8 +312,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Obsolete("This class is obsolete. Use System.Configuration.ConfigurationErrorsException")] @@ -357,8 +361,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] @@ -410,8 +414,8 @@ [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration!System.Configuration.ConfigurationErrorsException")>] - [System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")] - [<System.Obsolete("This class is obsolete, to create a new exception create a System.Configuration.ConfigurationErrorsException")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException instead.")>] [System.Obsolete("This class is obsolete. Use System.Configuration.ConfigurationErrorsException")] @@ -579,8 +583,8 @@ [<System.Obsolete("This class is obsolete, use System.Configuration!System.Configuration.ConfigurationErrorsException.GetFilename instead")>] - [System.Obsolete("This class is obsolete, use System.Configuration.ConfigurationErrorsException.GetFilename instead")] - [<System.Obsolete("This class is obsolete, use System.Configuration.ConfigurationErrorsException.GetFilename instead")>] + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException.GetFilename instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException.GetFilename instead.")>] [System.Obsolete("This class is obsolete. Use System.Configuration.ConfigurationErrorsException")] @@ -627,9 +631,13 @@ [System.Obsolete("This class is obsolete, use System.Configuration!System.Configuration.ConfigurationErrorsException.GetLinenumber instead")] [<System.Obsolete("This class is obsolete, use System.Configuration!System.Configuration.ConfigurationErrorsException.GetLinenumber instead")>] - - [System.Obsolete("This class is obsolete, use System.Configuration.ConfigurationErrorsException.GetLinenumber instead")] - [<System.Obsolete("This class is obsolete, use System.Configuration.ConfigurationErrorsException.GetLinenumber instead")>] + + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException.GetFilename instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException.GetFilename instead.")>] + + + [System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException.GetLinenumber instead.")] + [<System.Obsolete("ConfigurationException has been deprecated. Use System.Configuration.ConfigurationErrorsException.GetLinenumber instead.")>] [System.Obsolete("This class is obsolete. Use System.Configuration.ConfigurationErrorsException")] diff --git a/xml/System.Configuration/ConfigurationSection.xml b/xml/System.Configuration/ConfigurationSection.xml index e3de5db8035..f51ff847110 100644 --- a/xml/System.Configuration/ConfigurationSection.xml +++ b/xml/System.Configuration/ConfigurationSection.xml @@ -139,16 +139,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -185,16 +185,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -244,16 +244,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -280,16 +280,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -355,16 +355,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -404,16 +404,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -456,16 +456,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -510,16 +510,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration diff --git a/xml/System.Configuration/ConfigurationSectionCollection.xml b/xml/System.Configuration/ConfigurationSectionCollection.xml index 3d34990338a..9fe6f6c0aab 100644 --- a/xml/System.Configuration/ConfigurationSectionCollection.xml +++ b/xml/System.Configuration/ConfigurationSectionCollection.xml @@ -332,10 +332,10 @@ - + - + Method System.Configuration @@ -351,6 +351,10 @@ 6.0.0.0 + + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionCollection+<GetEnumerator>d__15))] + [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionCollection+<GetEnumerator>d__15))>] + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionCollection+<GetEnumerator>d__1))] [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionCollection+<GetEnumerator>d__1))>] @@ -455,8 +459,8 @@ System.Void - - + + The applicable object. diff --git a/xml/System.Configuration/ConfigurationSectionGroup.xml b/xml/System.Configuration/ConfigurationSectionGroup.xml index c14cf5239c2..ff56c3cd074 100644 --- a/xml/System.Configuration/ConfigurationSectionGroup.xml +++ b/xml/System.Configuration/ConfigurationSectionGroup.xml @@ -501,16 +501,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration diff --git a/xml/System.Configuration/ConfigurationSectionGroupCollection.xml b/xml/System.Configuration/ConfigurationSectionGroupCollection.xml index 6ceaaeed0f9..24cc249d208 100644 --- a/xml/System.Configuration/ConfigurationSectionGroupCollection.xml +++ b/xml/System.Configuration/ConfigurationSectionGroupCollection.xml @@ -344,10 +344,10 @@ - + - + Method System.Configuration @@ -363,6 +363,10 @@ 6.0.0.0 + + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionGroupCollection+<GetEnumerator>d__14))] + [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionGroupCollection+<GetEnumerator>d__14))>] + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionGroupCollection+<GetEnumerator>d__1))] [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.ConfigurationSectionGroupCollection+<GetEnumerator>d__1))>] @@ -467,8 +471,8 @@ System.Void - - + + The applicable object. diff --git a/xml/System.Configuration/ConfigurationSettings.xml b/xml/System.Configuration/ConfigurationSettings.xml index 9f7f93883be..f61a2caf7a4 100644 --- a/xml/System.Configuration/ConfigurationSettings.xml +++ b/xml/System.Configuration/ConfigurationSettings.xml @@ -69,8 +69,8 @@ [<System.Obsolete("This method is obsolete, it has been replaced by System.Configuration!System.Configuration.ConfigurationManager.AppSettings")>] - [System.Obsolete("This property is obsolete, it has been replaced by System.Configuration.ConfigurationManager.AppSettings")] - [<System.Obsolete("This property is obsolete, it has been replaced by System.Configuration.ConfigurationManager.AppSettings")>] + [System.Obsolete("ConfigurationSettings.AppSettings has been deprecated. Use System.Configuration.ConfigurationManager.AppSettings instead.")] + [<System.Obsolete("ConfigurationSettings.AppSettings has been deprecated. Use System.Configuration.ConfigurationManager.AppSettings instead.")>] [System.Obsolete("This property is obsolete. Please use System.Configuration.ConfigurationManager.AppSettings")] @@ -128,8 +128,8 @@ [<System.Obsolete("This method is obsolete, it has been replaced by System.Configuration!System.Configuration.ConfigurationManager.GetSection")>] - [System.Obsolete("This method is obsolete, it has been replaced by System.Configuration.ConfigurationManager.GetSection")] - [<System.Obsolete("This method is obsolete, it has been replaced by System.Configuration.ConfigurationManager.GetSection")>] + [System.Obsolete("ConfigurationSettings.GetConfig has been deprecated. Use System.Configuration.ConfigurationManager.GetSection instead.")] + [<System.Obsolete("ConfigurationSettings.GetConfig has been deprecated. Use System.Configuration.ConfigurationManager.GetSection instead.")>] diff --git a/xml/System.Configuration/ConnectionStringSettings.xml b/xml/System.Configuration/ConnectionStringSettings.xml index 3f93ac338b9..27dec334b8a 100644 --- a/xml/System.Configuration/ConnectionStringSettings.xml +++ b/xml/System.Configuration/ConnectionStringSettings.xml @@ -186,7 +186,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("connectionString", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)] [<System.Configuration.ConfigurationProperty("connectionString", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)>] @@ -234,7 +234,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("name", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsKey | System.Configuration.ConfigurationPropertyOptions.IsRequired)] [<System.Configuration.ConfigurationProperty("name", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsKey | System.Configuration.ConfigurationPropertyOptions.IsRequired)>] @@ -261,15 +261,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -315,7 +315,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("providerName", DefaultValue="System.Data.SqlClient")] [<System.Configuration.ConfigurationProperty("providerName", DefaultValue="System.Data.SqlClient")>] diff --git a/xml/System.Configuration/ConnectionStringSettingsCollection.xml b/xml/System.Configuration/ConnectionStringSettingsCollection.xml index cafb8133d48..0872d5f6ea9 100644 --- a/xml/System.Configuration/ConnectionStringSettingsCollection.xml +++ b/xml/System.Configuration/ConnectionStringSettingsCollection.xml @@ -444,15 +444,15 @@ - + - + - - - - + + + + Property System.Configuration diff --git a/xml/System.Configuration/ConnectionStringsSection.xml b/xml/System.Configuration/ConnectionStringsSection.xml index 45216174523..48128f729e0 100644 --- a/xml/System.Configuration/ConnectionStringsSection.xml +++ b/xml/System.Configuration/ConnectionStringsSection.xml @@ -105,7 +105,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("", Options=System.Configuration.ConfigurationPropertyOptions.IsDefaultCollection)] [<System.Configuration.ConfigurationProperty("", Options=System.Configuration.ConfigurationPropertyOptions.IsDefaultCollection)>] @@ -132,16 +132,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -167,15 +167,15 @@ - + - + - - - - + + + + Property System.Configuration diff --git a/xml/System.Configuration/DefaultSection.xml b/xml/System.Configuration/DefaultSection.xml index d1ae14adcb8..1442bcbde60 100644 --- a/xml/System.Configuration/DefaultSection.xml +++ b/xml/System.Configuration/DefaultSection.xml @@ -62,16 +62,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -99,16 +99,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -134,15 +134,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -167,16 +167,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -204,16 +204,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -238,16 +238,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration diff --git a/xml/System.Configuration/IdnElement.xml b/xml/System.Configuration/IdnElement.xml index 9d9ad1f3bfb..aa56bf870d1 100644 --- a/xml/System.Configuration/IdnElement.xml +++ b/xml/System.Configuration/IdnElement.xml @@ -101,7 +101,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("enabled", DefaultValue=System.UriIdnScope.None)] [<System.Configuration.ConfigurationProperty("enabled", DefaultValue=System.UriIdnScope.None)>] @@ -189,12 +189,15 @@ - + - + - + + + + Property System diff --git a/xml/System.Configuration/IgnoreSection.xml b/xml/System.Configuration/IgnoreSection.xml index 832fee8a6a9..c59430ef0e2 100644 --- a/xml/System.Configuration/IgnoreSection.xml +++ b/xml/System.Configuration/IgnoreSection.xml @@ -69,16 +69,16 @@ - - + + - + - - - - - + + + + + @@ -113,16 +113,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -148,15 +148,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -181,16 +181,16 @@ - - + + - + - - - - - + + + + + @@ -225,16 +225,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -259,16 +259,16 @@ - - + + - + - - - - - + + + + + diff --git a/xml/System.Configuration/IriParsingElement.xml b/xml/System.Configuration/IriParsingElement.xml index a46fc381a80..e6239641f46 100644 --- a/xml/System.Configuration/IriParsingElement.xml +++ b/xml/System.Configuration/IriParsingElement.xml @@ -97,7 +97,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("enabled", DefaultValue=false)] [<System.Configuration.ConfigurationProperty("enabled", DefaultValue=false)>] @@ -183,12 +183,15 @@ - + - + - + + + + Property System diff --git a/xml/System.Configuration/KeyValueConfigurationCollection.xml b/xml/System.Configuration/KeyValueConfigurationCollection.xml index f36381e71ba..dafc0b4ecb6 100644 --- a/xml/System.Configuration/KeyValueConfigurationCollection.xml +++ b/xml/System.Configuration/KeyValueConfigurationCollection.xml @@ -362,15 +362,15 @@ - + - + - - - - + + + + Property System.Configuration diff --git a/xml/System.Configuration/KeyValueConfigurationElement.xml b/xml/System.Configuration/KeyValueConfigurationElement.xml index 6fdc015acfb..25d399f11eb 100644 --- a/xml/System.Configuration/KeyValueConfigurationElement.xml +++ b/xml/System.Configuration/KeyValueConfigurationElement.xml @@ -88,16 +88,16 @@ - - + + - + - - - - - + + + + + Method System.Configuration @@ -143,7 +143,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("key", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsKey)] [<System.Configuration.ConfigurationProperty("key", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsKey)>] @@ -168,15 +168,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -223,7 +223,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("value", DefaultValue="")] [<System.Configuration.ConfigurationProperty("value", DefaultValue="")>] diff --git a/xml/System.Configuration/NameValueConfigurationCollection.xml b/xml/System.Configuration/NameValueConfigurationCollection.xml index bdcc4d55b19..564d123a7cf 100644 --- a/xml/System.Configuration/NameValueConfigurationCollection.xml +++ b/xml/System.Configuration/NameValueConfigurationCollection.xml @@ -328,15 +328,15 @@ - + - + - - - - + + + + Property System.Configuration diff --git a/xml/System.Configuration/NameValueConfigurationElement.xml b/xml/System.Configuration/NameValueConfigurationElement.xml index ceef9c64c14..2d4e9bc7f1f 100644 --- a/xml/System.Configuration/NameValueConfigurationElement.xml +++ b/xml/System.Configuration/NameValueConfigurationElement.xml @@ -91,7 +91,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true)] [<System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true)>] @@ -110,15 +110,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -164,7 +164,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("value", DefaultValue="")] [<System.Configuration.ConfigurationProperty("value", DefaultValue="")>] diff --git a/xml/System.Configuration/PropertyInformationCollection.xml b/xml/System.Configuration/PropertyInformationCollection.xml index 984d8a4ec40..a9132940b94 100644 --- a/xml/System.Configuration/PropertyInformationCollection.xml +++ b/xml/System.Configuration/PropertyInformationCollection.xml @@ -94,10 +94,10 @@ - + - + Method System.Configuration @@ -113,6 +113,10 @@ 6.0.0.0 + + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.PropertyInformationCollection+<GetEnumerator>d__6))] + [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.PropertyInformationCollection+<GetEnumerator>d__6))>] + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.PropertyInformationCollection+<GetEnumerator>d__1))] [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Configuration.PropertyInformationCollection+<GetEnumerator>d__1))>] @@ -157,8 +161,8 @@ System.Void - - + + A object that contains the information required to serialize the instance. diff --git a/xml/System.Configuration/ProtectedConfigurationSection.xml b/xml/System.Configuration/ProtectedConfigurationSection.xml index d850dcc649b..f58a9e53432 100644 --- a/xml/System.Configuration/ProtectedConfigurationSection.xml +++ b/xml/System.Configuration/ProtectedConfigurationSection.xml @@ -122,7 +122,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("defaultProvider", DefaultValue="RsaProtectedConfigurationProvider")] [<System.Configuration.ConfigurationProperty("defaultProvider", DefaultValue="RsaProtectedConfigurationProvider")>] @@ -147,15 +147,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -201,7 +201,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("providers")] [<System.Configuration.ConfigurationProperty("providers")>] diff --git a/xml/System.Configuration/ProtectedProviderSettings.xml b/xml/System.Configuration/ProtectedProviderSettings.xml index a7edf6bd1c4..f98c853fdce 100644 --- a/xml/System.Configuration/ProtectedProviderSettings.xml +++ b/xml/System.Configuration/ProtectedProviderSettings.xml @@ -57,15 +57,15 @@ - + - + - - - - + + + + Property System.Configuration @@ -118,7 +118,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("", IsDefaultCollection=true, Options=System.Configuration.ConfigurationPropertyOptions.IsDefaultCollection)] [<System.Configuration.ConfigurationProperty("", IsDefaultCollection=true, Options=System.Configuration.ConfigurationPropertyOptions.IsDefaultCollection)>] diff --git a/xml/System.Configuration/ProviderSettings.xml b/xml/System.Configuration/ProviderSettings.xml index 560b1474ddf..c8b510f0d93 100644 --- a/xml/System.Configuration/ProviderSettings.xml +++ b/xml/System.Configuration/ProviderSettings.xml @@ -162,16 +162,16 @@ PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" /> - - + + - + - - - - - + + + + + Method System.Configuration @@ -218,7 +218,7 @@ PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" /> 6.0.0.0 - + [System.Configuration.ConfigurationProperty("name", IsKey=true, IsRequired=true)] [<System.Configuration.ConfigurationProperty("name", IsKey=true, IsRequired=true)>] @@ -333,15 +333,15 @@ PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" /> - + - + - - - - + + + + Property System.Configuration @@ -366,16 +366,16 @@ PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" /> - - + + - + - - - - - + + + + + Method System.Configuration @@ -424,7 +424,7 @@ PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" /> 6.0.0.0 - + [System.Configuration.ConfigurationProperty("type", IsRequired=true)] [<System.Configuration.ConfigurationProperty("type", IsRequired=true)>] @@ -458,16 +458,16 @@ PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" /> - - + + - + - - - - - + + + + + diff --git a/xml/System.Configuration/ProviderSettingsCollection.xml b/xml/System.Configuration/ProviderSettingsCollection.xml index c2a3af3173c..247f03cf47c 100644 --- a/xml/System.Configuration/ProviderSettingsCollection.xml +++ b/xml/System.Configuration/ProviderSettingsCollection.xml @@ -320,15 +320,15 @@ - + - + - - - - + + + + Property System.Configuration diff --git a/xml/System.Configuration/RsaProtectedConfigurationProvider.xml b/xml/System.Configuration/RsaProtectedConfigurationProvider.xml index d84fc8e6bb4..c0aceaee695 100644 --- a/xml/System.Configuration/RsaProtectedConfigurationProvider.xml +++ b/xml/System.Configuration/RsaProtectedConfigurationProvider.xml @@ -440,8 +440,8 @@ The following example shows how to use the standard System.Void - - + + The provider name to use for the object. diff --git a/xml/System.Configuration/SchemeSettingElement.xml b/xml/System.Configuration/SchemeSettingElement.xml index 761365c6f4f..7954d66c016 100644 --- a/xml/System.Configuration/SchemeSettingElement.xml +++ b/xml/System.Configuration/SchemeSettingElement.xml @@ -99,7 +99,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("genericUriParserOptions", DefaultValue=System.Configuration.ConfigurationPropertyOptions.None, IsRequired=true)] [<System.Configuration.ConfigurationProperty("genericUriParserOptions", DefaultValue=System.Configuration.ConfigurationPropertyOptions.None, IsRequired=true)>] @@ -147,7 +147,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("name", DefaultValue=null, IsKey=true, IsRequired=true)] [<System.Configuration.ConfigurationProperty("name", DefaultValue=null, IsKey=true, IsRequired=true)>] @@ -177,12 +177,15 @@ - + - + - + + + + Property System diff --git a/xml/System.Configuration/SettingElement.xml b/xml/System.Configuration/SettingElement.xml index 3f279047168..35a7725a68a 100644 --- a/xml/System.Configuration/SettingElement.xml +++ b/xml/System.Configuration/SettingElement.xml @@ -204,7 +204,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true, IsRequired=true)] [<System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true, IsRequired=true)>] @@ -223,12 +223,15 @@ - + - + - + + + + Property System @@ -280,7 +283,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("serializeAs", DefaultValue=System.Configuration.SettingsSerializeAs.String, IsRequired=true)] [<System.Configuration.ConfigurationProperty("serializeAs", DefaultValue=System.Configuration.SettingsSerializeAs.String, IsRequired=true)>] @@ -327,7 +330,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("value", DefaultValue=null, IsRequired=true)] [<System.Configuration.ConfigurationProperty("value", DefaultValue=null, IsRequired=true)>] diff --git a/xml/System.Configuration/SettingValueElement.xml b/xml/System.Configuration/SettingValueElement.xml index 65a882b641b..7298f60a896 100644 --- a/xml/System.Configuration/SettingValueElement.xml +++ b/xml/System.Configuration/SettingValueElement.xml @@ -64,12 +64,16 @@ - - + + - + - + + + + + Method System @@ -171,12 +175,16 @@ - - + + - + - + + + + + Method System @@ -202,12 +210,15 @@ - + - + - + + + + Property System @@ -238,12 +249,16 @@ - - + + - + - + + + + + Method System @@ -271,12 +286,16 @@ - - + + - + - + + + + + Method System @@ -301,12 +320,16 @@ - - + + - + - + + + + + Method System @@ -337,12 +360,16 @@ - - + + - + - + + + + + Method System diff --git a/xml/System.Configuration/SettingsAttributeDictionary.xml b/xml/System.Configuration/SettingsAttributeDictionary.xml index 8e5bee905c1..4aa8987bfdb 100644 --- a/xml/System.Configuration/SettingsAttributeDictionary.xml +++ b/xml/System.Configuration/SettingsAttributeDictionary.xml @@ -137,9 +137,9 @@ - To be added. - To be added. - To be added. + The containing all the data needed to deserialize the object. + The describing the source and destination of the given serialized stream. + Constructor for deserializing a instance from state file (binary serialization). To be added. diff --git a/xml/System.Configuration/SettingsContext.xml b/xml/System.Configuration/SettingsContext.xml index 2856b40eca0..5d36e23d32c 100644 --- a/xml/System.Configuration/SettingsContext.xml +++ b/xml/System.Configuration/SettingsContext.xml @@ -95,9 +95,9 @@ - To be added. - To be added. - To be added. + The containing all the data needed to deserialize the object. + The describing the source and destination of the given serialized stream. + Constructor for deserializing a instance from state file (binary serialization). To be added. diff --git a/xml/System.Configuration/SettingsProperty.xml b/xml/System.Configuration/SettingsProperty.xml index 938cea09fbd..f00d4a3282a 100644 --- a/xml/System.Configuration/SettingsProperty.xml +++ b/xml/System.Configuration/SettingsProperty.xml @@ -172,12 +172,15 @@ - + - + - + + + + Property System diff --git a/xml/System.Configuration/SettingsPropertyCollection.xml b/xml/System.Configuration/SettingsPropertyCollection.xml index a1bd433284c..9ff2c7c3ea7 100644 --- a/xml/System.Configuration/SettingsPropertyCollection.xml +++ b/xml/System.Configuration/SettingsPropertyCollection.xml @@ -3,10 +3,10 @@ - + + - System 2.0.0.0 diff --git a/xml/System.Configuration/SettingsPropertyIsReadOnlyException.xml b/xml/System.Configuration/SettingsPropertyIsReadOnlyException.xml index dab5cb680ea..bbf7007b378 100644 --- a/xml/System.Configuration/SettingsPropertyIsReadOnlyException.xml +++ b/xml/System.Configuration/SettingsPropertyIsReadOnlyException.xml @@ -1,11 +1,11 @@ - + - + System 2.0.0.0 @@ -24,7 +24,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Configuration/SettingsPropertyNotFoundException.xml b/xml/System.Configuration/SettingsPropertyNotFoundException.xml index fe88e866454..a95ed70b0fb 100644 --- a/xml/System.Configuration/SettingsPropertyNotFoundException.xml +++ b/xml/System.Configuration/SettingsPropertyNotFoundException.xml @@ -1,11 +1,11 @@ - + - + System 2.0.0.0 @@ -24,7 +24,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Configuration/SettingsPropertyValueCollection.xml b/xml/System.Configuration/SettingsPropertyValueCollection.xml index 6ca4c09b6e5..94662e1aa62 100644 --- a/xml/System.Configuration/SettingsPropertyValueCollection.xml +++ b/xml/System.Configuration/SettingsPropertyValueCollection.xml @@ -3,10 +3,10 @@ - + + - System 2.0.0.0 diff --git a/xml/System.Configuration/SettingsPropertyWrongTypeException.xml b/xml/System.Configuration/SettingsPropertyWrongTypeException.xml index 97804cea35f..e5c4897c7f5 100644 --- a/xml/System.Configuration/SettingsPropertyWrongTypeException.xml +++ b/xml/System.Configuration/SettingsPropertyWrongTypeException.xml @@ -1,11 +1,11 @@ - + - + System 2.0.0.0 @@ -24,7 +24,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Configuration/SettingsSerializeAs.xml b/xml/System.Configuration/SettingsSerializeAs.xml index 295adf55bfa..4c00c88d6d2 100644 --- a/xml/System.Configuration/SettingsSerializeAs.xml +++ b/xml/System.Configuration/SettingsSerializeAs.xml @@ -59,8 +59,8 @@ - [System.Obsolete("BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.. Consider using Xml instead.", false)] - [<System.Obsolete("BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.. Consider using Xml instead.", false)>] + [System.Obsolete("BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.. Consider using Xml instead.")] + [<System.Obsolete("BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.. Consider using Xml instead.")>] diff --git a/xml/System.Configuration/UriSection.xml b/xml/System.Configuration/UriSection.xml index f1d434d42f5..e2e724f63cc 100644 --- a/xml/System.Configuration/UriSection.xml +++ b/xml/System.Configuration/UriSection.xml @@ -1,11 +1,11 @@ - + - + System 2.0.0.0 @@ -103,7 +103,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("idn")] [<System.Configuration.ConfigurationProperty("idn")>] @@ -160,7 +160,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("iriParsing")] [<System.Configuration.ConfigurationProperty("iriParsing")>] @@ -196,12 +196,15 @@ - + - + - + + + + Property System @@ -252,7 +255,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("schemeSettings")] [<System.Configuration.ConfigurationProperty("schemeSettings")>] diff --git a/xml/System.Data.Common/DataAdapter.xml b/xml/System.Data.Common/DataAdapter.xml index 4f50bad9264..2252c2b60df 100644 --- a/xml/System.Data.Common/DataAdapter.xml +++ b/xml/System.Data.Common/DataAdapter.xml @@ -326,10 +326,14 @@ 6.0.0.0 - + [System.Obsolete("CloneInternals() has been deprecated. Use the DataAdapter(DataAdapter from) constructor. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("CloneInternals() has been deprecated. Use the DataAdapter(DataAdapter from) constructor. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("CloneInternals() has been deprecated. Use the DataAdapter(DataAdapter from) constructor instead.")] + [<System.Obsolete("CloneInternals() has been deprecated. Use the DataAdapter(DataAdapter from) constructor instead.")>] + [System.Obsolete("CloneInternals() has been deprecated. Use the DataAdapter(DataAdapter from) constructor. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("CloneInternals() has been deprecated. Use the DataAdapter(DataAdapter from) constructor. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Data.Common/DbBatchCommandCollection.xml b/xml/System.Data.Common/DbBatchCommandCollection.xml index 01524aad906..1b22ca1978c 100644 --- a/xml/System.Data.Common/DbBatchCommandCollection.xml +++ b/xml/System.Data.Common/DbBatchCommandCollection.xml @@ -187,6 +187,31 @@ To be added. + + + + + + + + Method + + System.Data.Common + 6.0.0.0 + + + System.Data.Common.DbBatchCommand + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -295,12 +320,12 @@ - + - + - + Property P:System.Collections.Generic.IList`1.Item(System.Int32) @@ -378,6 +403,32 @@ To be added. + + + + + + + + Method + + System.Data.Common + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Data.Common/DbConnectionStringBuilder.xml b/xml/System.Data.Common/DbConnectionStringBuilder.xml index 3d9276c5355..cda54659121 100644 --- a/xml/System.Data.Common/DbConnectionStringBuilder.xml +++ b/xml/System.Data.Common/DbConnectionStringBuilder.xml @@ -88,8 +88,7 @@ builder("Initial Catalog") = "AdventureWorks;NewValue=Bad" ``` ```csharp -System.Data.Common.DbConnectionStringBuilder builder = -   new System.Data.Common.DbConnectionStringBuilder(); +System.Data.Common.DbConnectionStringBuilder builder = new System.Data.Common.DbConnectionStringBuilder(); builder["Data Source"] = "(local)"; builder["integrated Security"] = true; builder["Initial Catalog"] = "AdventureWorks;NewValue=Bad"; @@ -102,8 +101,6 @@ data source=(local);integrated security=True; initial catalog="AdventureWorks;NewValue=Bad" ``` - - ## Examples The following console application builds two connection strings, one for a Microsoft Jet database, and one for a SQL Server database. In each case, the code uses a generic class to create the connection string, and then passes the property of the instance to the constructor of the strongly typed connection class. This is not required; the code could also have created individual strongly typed connection string builder instances. The example also parses an existing connection string, and demonstrates various ways of manipulating the connection string's contents. diff --git a/xml/System.Data.Odbc/ODBC32+RETCODE.xml b/xml/System.Data.Odbc/ODBC32+RETCODE.xml new file mode 100644 index 00000000000..87797c03baf --- /dev/null +++ b/xml/System.Data.Odbc/ODBC32+RETCODE.xml @@ -0,0 +1,127 @@ + + + + + + + + + System.Data.Odbc + 6.0.0.0 + + + System.Enum + + + + [System.Runtime.CompilerServices.TypeForwardedFrom("System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + + + To be added. + To be added. + + + + + + + + + + Field + + System.Data.Odbc + 6.0.0.0 + + + System.Data.Odbc.ODBC32+RETCODE + + -1 + + To be added. + + + + + + + + + + Field + + System.Data.Odbc + 6.0.0.0 + + + System.Data.Odbc.ODBC32+RETCODE + + -2 + + To be added. + + + + + + + + + + Field + + System.Data.Odbc + 6.0.0.0 + + + System.Data.Odbc.ODBC32+RETCODE + + 100 + + To be added. + + + + + + + + + + Field + + System.Data.Odbc + 6.0.0.0 + + + System.Data.Odbc.ODBC32+RETCODE + + 0 + + To be added. + + + + + + + + + + Field + + System.Data.Odbc + 6.0.0.0 + + + System.Data.Odbc.ODBC32+RETCODE + + 1 + + To be added. + + + + diff --git a/xml/System.Data.Odbc/ODBC32.xml b/xml/System.Data.Odbc/ODBC32.xml new file mode 100644 index 00000000000..35cdc6d2d89 --- /dev/null +++ b/xml/System.Data.Odbc/ODBC32.xml @@ -0,0 +1,27 @@ + + + + + + + + + System.Data.Odbc + 6.0.0.0 + + + System.Object + + + + + [System.Runtime.CompilerServices.TypeForwardedFrom("System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + + + To be added. + To be added. + + + diff --git a/xml/System.Data.Odbc/OdbcParameter.xml b/xml/System.Data.Odbc/OdbcParameter.xml index 96d169bc77c..9ab9f83b56c 100644 --- a/xml/System.Data.Odbc/OdbcParameter.xml +++ b/xml/System.Data.Odbc/OdbcParameter.xml @@ -1448,13 +1448,13 @@ public void CreateOdbcParameter() - + - + Method M:System.ICloneable.Clone diff --git a/xml/System.Data.Odbc/OdbcParameterCollection.xml b/xml/System.Data.Odbc/OdbcParameterCollection.xml index c72c6f20a46..3e4ac774567 100644 --- a/xml/System.Data.Odbc/OdbcParameterCollection.xml +++ b/xml/System.Data.Odbc/OdbcParameterCollection.xml @@ -283,10 +283,14 @@ INSERT INTO MyTable VALUES (@p1, @p2, @p3); [System.Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value). http://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value). http://go.microsoft.com/fwlink/?linkid=14202", false)>] - + [System.Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value). https://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value). https://go.microsoft.com/fwlink/?linkid=14202", false)>] + + [System.Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value) instead.")] + [<System.Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value) instead.")>] + System.Data.Odbc.OdbcParameter diff --git a/xml/System.Data.Odbc/OdbcPermissionAttribute.xml b/xml/System.Data.Odbc/OdbcPermissionAttribute.xml index 9624fcd5b82..89a2e0bc079 100644 --- a/xml/System.Data.Odbc/OdbcPermissionAttribute.xml +++ b/xml/System.Data.Odbc/OdbcPermissionAttribute.xml @@ -29,7 +29,7 @@ [System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)] [<System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)>] - + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Data.OleDb/OleDbPermissionAttribute.xml b/xml/System.Data.OleDb/OleDbPermissionAttribute.xml index b84f7e55921..04ec3016d1a 100644 --- a/xml/System.Data.OleDb/OleDbPermissionAttribute.xml +++ b/xml/System.Data.OleDb/OleDbPermissionAttribute.xml @@ -29,7 +29,7 @@ [System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)] [<System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)>] - + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Data.SqlClient/SqlClientPermissionAttribute.xml b/xml/System.Data.SqlClient/SqlClientPermissionAttribute.xml index 7a8517ac4eb..130cdf21453 100644 --- a/xml/System.Data.SqlClient/SqlClientPermissionAttribute.xml +++ b/xml/System.Data.SqlClient/SqlClientPermissionAttribute.xml @@ -30,7 +30,7 @@ [System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)] [<System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)>] - + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Data/DataSysDescriptionAttribute.xml b/xml/System.Data/DataSysDescriptionAttribute.xml index aace9e0c26a..34851aa4368 100644 --- a/xml/System.Data/DataSysDescriptionAttribute.xml +++ b/xml/System.Data/DataSysDescriptionAttribute.xml @@ -38,10 +38,14 @@ [System.AttributeUsage(System.AttributeTargets.All)] [<System.AttributeUsage(System.AttributeTargets.All)>] - + [System.Obsolete("DataSysDescriptionAttribute has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("DataSysDescriptionAttribute has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202", false)>] + + [System.Obsolete("DataSysDescriptionAttribute has been deprecated and is not supported.")] + [<System.Obsolete("DataSysDescriptionAttribute has been deprecated and is not supported.")>] + [System.Obsolete("DataSysDescriptionAttribute has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("DataSysDescriptionAttribute has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202", false)>] @@ -84,10 +88,14 @@ 6.0.0.0 - + [System.Obsolete("DataSysDescriptionAttribute has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("DataSysDescriptionAttribute has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202", false)>] + + [System.Obsolete("DataSysDescriptionAttribute has been deprecated and is not supported.")] + [<System.Obsolete("DataSysDescriptionAttribute has been deprecated and is not supported.")>] + [System.Obsolete("DataSysDescriptionAttribute has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("DataSysDescriptionAttribute has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202", false)>] diff --git a/xml/System.Diagnostics.Eventing.Reader/StandardEventKeywords.xml b/xml/System.Diagnostics.Eventing.Reader/StandardEventKeywords.xml index c8e5b329601..7f88c8c99d9 100644 --- a/xml/System.Diagnostics.Eventing.Reader/StandardEventKeywords.xml +++ b/xml/System.Diagnostics.Eventing.Reader/StandardEventKeywords.xml @@ -110,10 +110,14 @@ 6.0.0.0 - + [System.Obsolete("Incorrect value: use CorrelationHint2 instead", false)] [<System.Obsolete("Incorrect value: use CorrelationHint2 instead", false)>] + + [System.Obsolete("StandardEventKeywords.CorrelationHint has an incorrect value and has been deprecated. Use CorrelationHint2 instead.")] + [<System.Obsolete("StandardEventKeywords.CorrelationHint has an incorrect value and has been deprecated. Use CorrelationHint2 instead.")>] + System.Diagnostics.Eventing.Reader.StandardEventKeywords diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 033b13bc3c4..0ae2def7c63 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -26,8 +26,8 @@ - To be added. - The counter is an instrument that supports adding non-negative values. For example you might call counter.Add(1) each time a request is processed to track the total number of requests. Most metric viewers will display counters using a rate by default (requests/sec) but can also display a cumulative total. + The type that the counter represents. + Represents an instrument that supports adding non-negative values. For example, you might call counter.Add(1) each time a request is processed to track the total number of requests. Most metric viewers display counters using a rate (requests/sec), by default, but can also display a cumulative total. To be added. + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + + The measurement value. + The tags associated with the measurement. + Adds the increment value of the measurement. + To be added. + + diff --git a/xml/System.Diagnostics.Metrics/Histogram`1.xml b/xml/System.Diagnostics.Metrics/Histogram`1.xml index 2d4a135616c..6a0a1681e91 100644 --- a/xml/System.Diagnostics.Metrics/Histogram`1.xml +++ b/xml/System.Diagnostics.Metrics/Histogram`1.xml @@ -26,8 +26,8 @@ - To be added. - The histogram is a metrics Instrument which can be used to report arbitrary values that are likely to be statistically meaningful. + The type that the histogram represents. + Represents a metrics Instrument that can be used to report arbitrary values that are likely to be statistically meaningful. e.g. the request duration. Use method to create the Histogram object. @@ -124,6 +124,39 @@ This class supports only the following generic parameter types: To be added. + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + + The measurement value. + The tags associated with the measurement. + Records a measurement value. + To be added. + + diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 1da44b465a3..4d36d6c385b 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -23,8 +23,8 @@ - To be added. - Instrument{T} is the base class for all non-observable instruments. + The type that the instrument represents. + The base class for all non-observable instruments. To be added. + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + + + The measurement value. + The tags associated with the measurement. + Records a measurement by notifying all objects that are listening to this instrument. + To be added. + + diff --git a/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml b/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml index 96f4b011c95..22ea01cdb3b 100644 --- a/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml +++ b/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml @@ -25,11 +25,11 @@ System.Void - To be added. - To be added. - To be added. - To be added. - To be added. + The type that the measurement represents. + The that was responsible for sending the measurement. + The measurement value. + A span of key-value pair tags associated with the measurement. + The state object originally passed to method. A delegate to represent the Meterlistener callbacks used in measurements recording operation. To be added. diff --git a/xml/System.Diagnostics.Metrics/Measurement`1.xml b/xml/System.Diagnostics.Metrics/Measurement`1.xml index 156c6d33878..0d061940773 100644 --- a/xml/System.Diagnostics.Metrics/Measurement`1.xml +++ b/xml/System.Diagnostics.Metrics/Measurement`1.xml @@ -29,8 +29,8 @@ - To be added. - Measurement stores one observed metrics value and its associated tags. This type is used by Observable instruments' Observe() method when reporting current measurements. + The type that the measurement represents. + Stores one observed metrics value and its associated tags. This type is used by an Observable instrument's Observe() method when reporting current measurements. with the associated tags. To be added. diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index d9628f5223b..03672e40f24 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -95,12 +95,12 @@ - To be added. + The numerical type of the measurement. The instrument name. cannot be . Optional instrument unit of measurements. Optional instrument description. Create a metrics Counter object. - To be added. + A new counter. - To be added. + The numerical type of the measurement. The instrument name. cannot be . Optional instrument unit of measurements. Optional instrument description. - Histogram is an Instrument which can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentile. - To be added. + Creates a Histogram, which is an instrument that can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentile. + A new histogram. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - To be added. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. + A new observable counter. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by Optional instrument unit of measurements. Optional instrument description. - ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - To be added. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. + A new observable counter. - To be added. + The numerical type of the measurement.. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - To be added. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. + A new observable counter. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableGauge is an asynchronous Instrument which reports non-additive value(s) (e.g. the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up) when the instrument is being observed. - To be added. + Creates an ObservableGauge, which is an asynchronous instrument that reports non-additive values when the instrument is being observed. An example of a non-additive value is the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up. + A new observable gauge. To be added. @@ -373,13 +373,13 @@ Example uses for ObservableCounter: The number of page faults for each process. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableGauge is an asynchronous Instrument which reports non-additive value(s) (e.g. the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up) when the instrument is being observed. - To be added. + Creates an ObservableGauge, which is an asynchronous instrument that reports non-additive values when the instrument is being observed. An example of a non-additive value is the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up. + A new observable gauge. To be added. @@ -413,13 +413,13 @@ Example uses for ObservableCounter: The number of page faults for each process. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableGauge is an asynchronous Instrument which reports non-additive value(s) (e.g. the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up) when the instrument is being observed. - To be added. + Creates an ObservableGauge, which is an asynchronous instrument that reports non-additive values when the instrument is being observed. An example of a non-additive value is the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up. + A new observable gauge. To be added. @@ -463,8 +463,8 @@ Example uses for ObservableCounter: The number of page faults for each process. System.String - Returns the Meter name. - To be added. + Gets the Meter name. + The Meter name To be added. @@ -484,8 +484,8 @@ Example uses for ObservableCounter: The number of page faults for each process. System.String - Returns the Meter Version. - To be added. + Gets the Meter version. + The Meter version. To be added. diff --git a/xml/System.Diagnostics.Metrics/MeterListener.xml b/xml/System.Diagnostics.Metrics/MeterListener.xml index 067b4f19184..e4e4f41b383 100644 --- a/xml/System.Diagnostics.Metrics/MeterListener.xml +++ b/xml/System.Diagnostics.Metrics/MeterListener.xml @@ -129,8 +129,8 @@ System.Action<System.Diagnostics.Metrics.Instrument,System.Diagnostics.Metrics.MeterListener> - Callbacks to get notification when an instrument is published. - To be added. + Gets or sets the callback to get notified when an instrument is published. + The callback to get notified when an instrument is published. To be added. @@ -150,9 +150,9 @@ System.Action<System.Diagnostics.Metrics.Instrument,System.Object> - Callbacks to get notification when stopping the measurement on some instrument. + Gets or sets the callback to get notified when the measurement is stopped on some instrument. This can happen when the Meter or the Listener is disposed or calling on the listener. - To be added. + The callback to get notified when the measurement is stopped on some instrument. To be added. @@ -205,7 +205,7 @@ - To be added. + The type of the numeric measurement. The callback which can be used to get measurement recording of numeric type T. Sets a callback for a specific numeric type to get the measurement recording notification from all instruments which enabled listening and was created with the same specified numeric type. If a measurement of type T is recorded and a callback of type T is registered, that callback will be used. diff --git a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml index 8021fed23ab..a79769dca92 100644 --- a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml @@ -26,7 +26,7 @@ - To be added. + The type that the observable counter represents. ObservableCounter is a metrics observable Instrument which reports monotonically increasing value(s) when the instrument is being observed. e.g. CPU time (for different processes, threads, user mode or kernel mode). Use Meter.CreateObservableCounter methods to create the observable counter object. @@ -58,8 +58,8 @@ This class supports only the following generic parameter types: - Observe() fetches the current measurements being tracked by this observable counter. - To be added. + Fetches the current measurements being tracked by this observable counter. + The current measurements being tracked by this observable counter. To be added. diff --git a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml index aac94e4129e..dd3ab313f75 100644 --- a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml @@ -23,7 +23,7 @@ - To be added. + The type that the observable instrument represents. ObservableInstrument{T} is the base class from which all metrics observable instruments will inherit from. System.Boolean - A property tells if the instrument is an observable instrument. This property will return for all metrics observable instruments. - To be added. + Gets a value that indicates if the instrument is an observable instrument. + + if the instrument is metrics-observable; otherwise. To be added. @@ -102,8 +103,8 @@ This class supports only the following generic parameter types: - Observe() fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. - To be added. + Fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. + The current measurements tracked by this instrument. To be added. diff --git a/xml/System.Diagnostics.SymbolStore/ISymbolBinder.xml b/xml/System.Diagnostics.SymbolStore/ISymbolBinder.xml index 1b32423bdef..35fedddf0a3 100644 --- a/xml/System.Diagnostics.SymbolStore/ISymbolBinder.xml +++ b/xml/System.Diagnostics.SymbolStore/ISymbolBinder.xml @@ -81,10 +81,14 @@ 6.0.0.0 - + [System.Obsolete("The recommended alternative is ISymbolBinder1.GetReader. ISymbolBinder1.GetReader takes the importer interface pointer as an IntPtr instead of an Int32, and thus works on both 32-bit and 64-bit architectures. https://go.microsoft.com/fwlink/?linkid=14202=14202")] [<System.Obsolete("The recommended alternative is ISymbolBinder1.GetReader. ISymbolBinder1.GetReader takes the importer interface pointer as an IntPtr instead of an Int32, and thus works on both 32-bit and 64-bit architectures. https://go.microsoft.com/fwlink/?linkid=14202=14202")>] + + [System.Obsolete("ISymbolBinder.GetReader has been deprecated because it is not 64-bit compatible. Use ISymbolBinder1.GetReader instead. ISymbolBinder1.GetReader accepts the importer interface pointer as an IntPtr instead of an Int32, and thus works on both 32-bit and 64-bit architectures.")] + [<System.Obsolete("ISymbolBinder.GetReader has been deprecated because it is not 64-bit compatible. Use ISymbolBinder1.GetReader instead. ISymbolBinder1.GetReader accepts the importer interface pointer as an IntPtr instead of an Int32, and thus works on both 32-bit and 64-bit architectures.")>] + [System.Obsolete("The recommended alternative is ISymbolBinder1.GetReader. ISymbolBinder1.GetReader takes the importer interface pointer as an IntPtr instead of an Int32, and thus works on both 32-bit and 64-bit architectures. http://go.microsoft.com/fwlink/?linkid=14202=14202")] [<System.Obsolete("The recommended alternative is ISymbolBinder1.GetReader. ISymbolBinder1.GetReader takes the importer interface pointer as an IntPtr instead of an Int32, and thus works on both 32-bit and 64-bit architectures. http://go.microsoft.com/fwlink/?linkid=14202=14202")>] diff --git a/xml/System.Diagnostics/CounterSample.xml b/xml/System.Diagnostics/CounterSample.xml index 1ad0aae3bae..2f5d2203a33 100644 --- a/xml/System.Diagnostics/CounterSample.xml +++ b/xml/System.Diagnostics/CounterSample.xml @@ -510,7 +510,7 @@ The structure to be compared with this instance. - To be added. + The structure to be compared with this instance. Indicates whether the specified structure is equal to the current structure. if is equal to the current instance; otherwise, . @@ -559,7 +559,7 @@ The structure to be compared with the current structure. - To be added. + The structure to be compared with the current structure. Indicates whether the specified structure is a structure and is identical to the current structure. if is a structure and is identical to the current instance; otherwise, . @@ -641,9 +641,9 @@ A structure. - To be added. + A structure. Another structure to be compared to the structure specified by the parameter. - To be added. + Another structure to be compared to the structure specified by the parameter. Returns a value that indicates whether two structures are equal. if and are equal; otherwise, . @@ -694,9 +694,9 @@ A structure. - To be added. + A structure. Another structure to be compared to the structure specified by the parameter. - To be added. + Another structure to be compared to the structure specified by the parameter. Returns a value that indicates whether two structures are not equal. if and are not equal; otherwise, . diff --git a/xml/System.Diagnostics/Debug+AssertInterpolatedStringHandler.xml b/xml/System.Diagnostics/Debug+AssertInterpolatedStringHandler.xml index 973e048a23f..3c9459a135a 100644 --- a/xml/System.Diagnostics/Debug+AssertInterpolatedStringHandler.xml +++ b/xml/System.Diagnostics/Debug+AssertInterpolatedStringHandler.xml @@ -218,7 +218,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Writes the specified value to the handler. To be added. @@ -247,7 +247,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. Writes the specified value to the handler. @@ -277,7 +277,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. The format string. Writes the specified value to the handler. @@ -308,7 +308,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. The format string. diff --git a/xml/System.Diagnostics/Debug+WriteIfInterpolatedStringHandler.xml b/xml/System.Diagnostics/Debug+WriteIfInterpolatedStringHandler.xml index 4420088a03d..183af9b0556 100644 --- a/xml/System.Diagnostics/Debug+WriteIfInterpolatedStringHandler.xml +++ b/xml/System.Diagnostics/Debug+WriteIfInterpolatedStringHandler.xml @@ -218,7 +218,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Writes the specified value to the handler. To be added. @@ -247,7 +247,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. Writes the specified value to the handler. @@ -277,7 +277,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. The format string. Writes the specified value to the handler. @@ -308,7 +308,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. The format string. diff --git a/xml/System.Diagnostics/Debug.xml b/xml/System.Diagnostics/Debug.xml index afa13b54978..9a89f2d5c6f 100644 --- a/xml/System.Diagnostics/Debug.xml +++ b/xml/System.Diagnostics/Debug.xml @@ -215,12 +215,12 @@ - - - - - - + + + + + + Method System.Runtime @@ -253,7 +253,7 @@ - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -263,10 +263,41 @@ - To be added. - To be added. - To be added. - To be added. + The conditional expression to evaluate. If the condition is , the specified message is not sent and the message box is not displayed. + The message to send to the collection. + Checks for a condition; if the condition is , outputs a specified message and displays a message box that shows the call stack. + + method works only in debug builds. Use the method if you want to do assertions in release builds. For more information, see [Assertions in Managed Code](/visualstudio/debugger/assertions-in-managed-code). + + Typically, the method is used to identify logic errors during program development. evaluates the condition. If the result is `false`, it sends the specified diagnostic message to the collection. You can customize this behavior by adding a to, or removing one from, the collection. + + When the application runs in user interface mode, it displays a message box that shows the call stack with file and line numbers. The message box contains three buttons: **Abort**, **Retry**, and **Ignore**. Clicking the **Abort** button terminates the application. Clicking **Retry** sends you to the code in the debugger if your application is running in a debugger, or offers to open a debugger if it is not. Clicking **Ignore** continues with the next instruction in the code. + +> [!NOTE] +> The display of the message box depends on the presence of the . If the is not in the collection, the message box is not displayed. The can be removed by the [<clear> element](/dotnet/framework/configure-apps/file-schema/trace-debug/clear-element-for-listeners-for-trace) or the [<remove> element](/dotnet/framework/configure-apps/file-schema/trace-debug/remove-element-for-listeners-for-trace), or by calling the method on the property (`System.Diagnostics.Trace.Listeners.Clear()`). + + You can change the behavior of the in the configuration file that corresponds to the name of your application. In this file, you can enable and disable the assert message box or set the property. The configuration file should be formatted as follows: + +```xml + + + + + +``` + ]]> + + + + + + + + + @@ -365,12 +396,12 @@ - - - - - - + + + + + + Method System.Runtime @@ -403,7 +434,7 @@ - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -411,7 +442,7 @@ - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -421,11 +452,42 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The conditional expression to evaluate. If the condition is , the specified message is not sent and the message box is not displayed. + The message to send to the collection. + The detailed message to send to the collection. + Checks for a condition; if the condition is , outputs a specified message and displays a message box that shows the call stack. + + method works only in debug builds. Use the method if you want to do assertions in release builds. For more information, see [Assertions in Managed Code](/visualstudio/debugger/assertions-in-managed-code). + + Typically, the method is used to identify logic errors during program development. evaluates the condition. If the result is `false`, it sends the specified diagnostic message to the collection. You can customize this behavior by adding a to, or removing one from, the collection. + + When the application runs in user interface mode, it displays a message box that shows the call stack with file and line numbers. The message box contains three buttons: **Abort**, **Retry**, and **Ignore**. Clicking the **Abort** button terminates the application. Clicking **Retry** sends you to the code in the debugger if your application is running in a debugger, or offers to open a debugger if it is not. Clicking **Ignore** continues with the next instruction in the code. + +> [!NOTE] +> The display of the message box depends on the presence of the . If the is not in the collection, the message box is not displayed. The can be removed by the [<clear> element](/dotnet/framework/configure-apps/file-schema/trace-debug/clear-element-for-listeners-for-trace) or the [<remove> element](/dotnet/framework/configure-apps/file-schema/trace-debug/remove-element-for-listeners-for-trace), or by calling the method on the property (`System.Diagnostics.Trace.Listeners.Clear()`). + + You can change the behavior of the in the configuration file that corresponds to the name of your application. In this file, you can enable and disable the assert message box or set the property. The configuration file should be formatted as follows: + +```xml + + + + + +``` + ]]> + + + + + + + + + @@ -1856,12 +1918,12 @@ End of list of errors - - - - - - + + + + + + Method System.Runtime @@ -1887,7 +1949,7 @@ End of list of errors - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -1897,10 +1959,29 @@ End of list of errors - To be added. - To be added. - To be added. - To be added. + A message to write. + A category name used to organize the output. + Writes a category name and message to the trace listeners in the collection. + + . + + Use the `category` parameter to group output messages. + + This method calls the method of the trace listener. + + ]]> + + + + + + + + + @@ -2102,12 +2183,12 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - - - - - - + + + + + + Method System.Runtime @@ -2133,7 +2214,7 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -2144,11 +2225,30 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - To be added. - To be added. - To be added. - To be added. - To be added. + The conditional expression to evaluate. If the condition is , the message is written to the trace listeners in the collection. + A message to write. + A category name used to organize the output. + Writes a category name and message to the trace listeners in the collection. + + . + + Use the `category` parameter to group output messages. + + This method calls the method of the trace listener. + + ]]> + + + + + + + + + @@ -2785,12 +2885,12 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - - - - - - + + + + + + Method System.Runtime @@ -2816,7 +2916,7 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -2826,10 +2926,43 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - To be added. - To be added. - To be added. - To be added. + The conditional expression to evaluate. If the condition is , the message is written to the trace listeners in the collection. + A message to write. + Writes a message to the trace listeners in the collection if a condition is . + + . + + This method calls the method of the trace listener. + + ]]> + + + You can minimize the performance penalty of instrumenting your application by using statements instead of using statements. The following two code examples send the same debugging message. However, the first example is much faster when tracing is off, because if mySwitch.TraceError evaluates to , you do not call . The second example always calls , even when mySwitch.TraceError is and no tracing output is produced. This can result in unnecessary execution of arbitrarily complex code. + + First example: + +```csharp +if(mySwitch.TraceError) + Debug.WriteLine("aNumber = " + aNumber + " out of range"); +``` + + Second example: + +```csharp +Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); +``` + + + + + + + + + @@ -3032,12 +3165,12 @@ Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range") - - - - - - + + + + + + Method System.Runtime @@ -3063,7 +3196,7 @@ Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range") - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -3074,11 +3207,46 @@ Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range") - To be added. - To be added. - To be added. - To be added. - To be added. + + to cause a message to be written; otherwise, . + A message to write. + A category name used to organize the output. + Writes a category name and message to the trace listeners in the collection if a condition is . + + . + + The `category` parameter can be used to group output messages. + + This method calls the method of the trace listener. + ]]> + + + You can minimize the performance penalty of instrumenting your application by using statements instead of using statements. The following two code examples send the same debugging message. However, the first example is much faster when tracing is off, because if mySwitch.TraceError evaluates to , you do not call . The second example always calls , even when mySwitch.TraceError is and no tracing output is produced. This can result in unnecessary execution of arbitrarily complex code. + + First example: + +```csharp +if(mySwitch.TraceError) + Debug.WriteLine("aNumber = " + aNumber + " out of range"); +``` + + Second example: + +```csharp +Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); +``` + + + + + + + + + diff --git a/xml/System.Diagnostics/DebuggerVisualizerAttribute.xml b/xml/System.Diagnostics/DebuggerVisualizerAttribute.xml index ff8f2ae341c..bd708b90389 100644 --- a/xml/System.Diagnostics/DebuggerVisualizerAttribute.xml +++ b/xml/System.Diagnostics/DebuggerVisualizerAttribute.xml @@ -526,6 +526,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)>] + + System.String @@ -574,6 +580,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)>] + + System.String diff --git a/xml/System.Diagnostics/DistributedContextPropagator.xml b/xml/System.Diagnostics/DistributedContextPropagator.xml index 89ff87c80e6..43719acc2cb 100644 --- a/xml/System.Diagnostics/DistributedContextPropagator.xml +++ b/xml/System.Diagnostics/DistributedContextPropagator.xml @@ -33,7 +33,7 @@ - To be added. + Initializes an instance of the class. This constructor is protected and only meant to be called from parent classes. To be added. @@ -54,8 +54,8 @@ - returns the default propagator object which Current property will be initialized with. - To be added. + Returns the default propagator object that will be initialized with. + An instance of the class. Returns a propagator that does not transmit any distributed context information in outbound network messages. - To be added. + An instance of the class. To be added. @@ -110,7 +110,7 @@ Returns a propagator that attempts to act transparently, emitting the same data on outbound network requests that was received on the inbound request. When encoding the outbound message, this propagator uses information from the request's root Activity, ignoring any intermediate Activities that may have been created while processing the request. - To be added. + An instance of the class. To be added. @@ -131,7 +131,7 @@ Get or set the process-wide propagator object to use as the current selected propagator. - To be added. + The currently selected process-wide propagator object. To be added. diff --git a/xml/System.Diagnostics/EventLog.xml b/xml/System.Diagnostics/EventLog.xml index b33892187dc..122afd6f898 100644 --- a/xml/System.Diagnostics/EventLog.xml +++ b/xml/System.Diagnostics/EventLog.xml @@ -981,10 +981,14 @@ SVC_UPDATE.EXE [System.Obsolete("This method has been deprecated. Please use System.Diagnostics.EventLog.CreateEventSource(EventSourceCreationData sourceData) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use System.Diagnostics.EventLog.CreateEventSource(EventSourceCreationData sourceData) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This method has been deprecated. Please use System.Diagnostics.EventLog.CreateEventSource(EventSourceCreationData sourceData) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use System.Diagnostics.EventLog.CreateEventSource(EventSourceCreationData sourceData) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("EventLog.CreateEventSource has been deprecated. Use System.Diagnostics.EventLog.CreateEventSource(EventSourceCreationData sourceData) instead.")] + [<System.Obsolete("EventLog.CreateEventSource has been deprecated. Use System.Diagnostics.EventLog.CreateEventSource(EventSourceCreationData sourceData) instead.")>] + [System.Obsolete("use CreateEventSource(EventSourceCreationData) instead")] [<System.Obsolete("use CreateEventSource(EventSourceCreationData) instead")>] diff --git a/xml/System.Diagnostics/EventLogEntry.xml b/xml/System.Diagnostics/EventLogEntry.xml index 4c9c7a59f43..5d702944fc6 100644 --- a/xml/System.Diagnostics/EventLogEntry.xml +++ b/xml/System.Diagnostics/EventLogEntry.xml @@ -348,10 +348,14 @@ [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.EventLogEntry.InstanceId instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.EventLogEntry.InstanceId instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.EventLogEntry.InstanceId instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.EventLogEntry.InstanceId instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("EventLogEntry.EventID has been deprecated. Use System.Diagnostics.EventLogEntry.InstanceId instead.")] + [<System.Obsolete("EventLogEntry.EventID has been deprecated. Use System.Diagnostics.EventLogEntry.InstanceId instead.")>] + [System.Diagnostics.MonitoringDescription("LogEntryEventID")] [<System.Diagnostics.MonitoringDescription("LogEntryEventID")>] diff --git a/xml/System.Diagnostics/EventLogEntryCollection.xml b/xml/System.Diagnostics/EventLogEntryCollection.xml index 05a38b21bc0..3ffe2ad0754 100644 --- a/xml/System.Diagnostics/EventLogEntryCollection.xml +++ b/xml/System.Diagnostics/EventLogEntryCollection.xml @@ -92,7 +92,7 @@ The one-dimensional array of instances that is the destination of the elements copied from the collection. The array must have zero-based indexing. - To be added. + The one-dimensional array of instances that is the destination of the elements copied from the collection. The array must have zero-based indexing. The zero-based index in the array at which copying begins. Copies the elements of the to an array of instances, starting at a particular array index. diff --git a/xml/System.Diagnostics/InstanceDataCollection.xml b/xml/System.Diagnostics/InstanceDataCollection.xml index 4c28fecc253..a095201ead8 100644 --- a/xml/System.Diagnostics/InstanceDataCollection.xml +++ b/xml/System.Diagnostics/InstanceDataCollection.xml @@ -74,10 +74,14 @@ [System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.InstanceDataCollectionCollection.get_Item to get an instance of this collection instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.InstanceDataCollectionCollection.get_Item to get an instance of this collection instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.InstanceDataCollectionCollection.get_Item to get an instance of this collection instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.InstanceDataCollectionCollection.get_Item to get an instance of this collection instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated. Use System.Diagnostics.InstanceDataCollectionCollection.get_Item to get an instance of this collection instead.")] + [<System.Obsolete("This constructor has been deprecated. Use System.Diagnostics.InstanceDataCollectionCollection.get_Item to get an instance of this collection instead.")>] + [System.Obsolete("Use InstanceDataCollectionCollection indexer instead.")] [<System.Obsolete("Use InstanceDataCollectionCollection indexer instead.")>] diff --git a/xml/System.Diagnostics/InstanceDataCollectionCollection.xml b/xml/System.Diagnostics/InstanceDataCollectionCollection.xml index 99aa3da2aae..859aab815b9 100644 --- a/xml/System.Diagnostics/InstanceDataCollectionCollection.xml +++ b/xml/System.Diagnostics/InstanceDataCollectionCollection.xml @@ -72,10 +72,14 @@ [System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.ReadCategory() to get an instance of this collection instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.ReadCategory() to get an instance of this collection instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.ReadCategory() to get an instance of this collection instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.ReadCategory() to get an instance of this collection instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated. Use System.Diagnostics.PerformanceCounterCategory.ReadCategory() to get an instance of this collection instead.")] + [<System.Obsolete("This constructor has been deprecated. Use System.Diagnostics.PerformanceCounterCategory.ReadCategory() to get an instance of this collection instead.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] diff --git a/xml/System.Diagnostics/PerformanceCounter.xml b/xml/System.Diagnostics/PerformanceCounter.xml index 1e3d3cd6f81..0882d935ee8 100644 --- a/xml/System.Diagnostics/PerformanceCounter.xml +++ b/xml/System.Diagnostics/PerformanceCounter.xml @@ -1144,10 +1144,14 @@ 6.0.0.0 - + [System.Obsolete("This field has been deprecated and is not used. Use machine.config or an application configuration file to set the size of the PerformanceCounter file mapping.")] [<System.Obsolete("This field has been deprecated and is not used. Use machine.config or an application configuration file to set the size of the PerformanceCounter file mapping.")>] + + [System.Obsolete("This field has been deprecated and is not used. Use machine.config or an application configuration file to set the size of the PerformanceCounter file mapping instead.")] + [<System.Obsolete("This field has been deprecated and is not used. Use machine.config or an application configuration file to set the size of the PerformanceCounter file mapping instead.")>] + [System.Obsolete] [<System.Obsolete>] diff --git a/xml/System.Diagnostics/PerformanceCounterCategory.xml b/xml/System.Diagnostics/PerformanceCounterCategory.xml index a175eb21feb..e31983e0c43 100644 --- a/xml/System.Diagnostics/PerformanceCounterCategory.xml +++ b/xml/System.Diagnostics/PerformanceCounterCategory.xml @@ -633,10 +633,14 @@ [System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, CounterCreationDataCollection counterData) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, CounterCreationDataCollection counterData) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, CounterCreationDataCollection counterData) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, CounterCreationDataCollection counterData) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This overload of PerformanceCounterCategory.Create has been deprecated. Use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, CounterCreationDataCollection counterData) instead.")] + [<System.Obsolete("This overload of PerformanceCounterCategory.Create has been deprecated. Use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, CounterCreationDataCollection counterData) instead.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] @@ -828,10 +832,14 @@ [System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, string counterName, string counterHelp) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, string counterName, string counterHelp) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, string counterName, string counterHelp) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, string counterName, string counterHelp) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This overload of PerformanceCounterCategory.Create has been deprecated. Use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, string counterName, string counterHelp) instead.")] + [<System.Obsolete("This overload of PerformanceCounterCategory.Create has been deprecated. Use System.Diagnostics.PerformanceCounterCategory.Create(string categoryName, string categoryHelp, PerformanceCounterCategoryType categoryType, string counterName, string counterHelp) instead.")>] + [System.Obsolete("Use another overload that uses PerformanceCounterCategoryType instead")] [<System.Obsolete("Use another overload that uses PerformanceCounterCategoryType instead")>] diff --git a/xml/System.Diagnostics/PerformanceCounterManager.xml b/xml/System.Diagnostics/PerformanceCounterManager.xml index 2d2e7c6dded..f2897324203 100644 --- a/xml/System.Diagnostics/PerformanceCounterManager.xml +++ b/xml/System.Diagnostics/PerformanceCounterManager.xml @@ -85,10 +85,14 @@ [System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")] + [<System.Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] @@ -142,10 +146,14 @@ [System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")] + [<System.Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")>] + System.Void @@ -187,10 +195,14 @@ [System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")] + [<System.Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")>] + System.Void diff --git a/xml/System.Diagnostics/Process.xml b/xml/System.Diagnostics/Process.xml index a0452632fd1..b11c0395f18 100644 --- a/xml/System.Diagnostics/Process.xml +++ b/xml/System.Diagnostics/Process.xml @@ -2263,10 +2263,6 @@ You cannot cause processes on remote computers to exit. You can only view inform [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2310,10 +2306,6 @@ You cannot cause processes on remote computers to exit. You can only view inform [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2735,10 +2727,6 @@ The calling process is a member of the associated process' descendant tree.[get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2842,10 +2830,6 @@ The calling process is a member of the associated process' descendant tree.[get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -3018,8 +3002,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.NonpagedSystemMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead.")] + [<System.Obsolete("Process.NonpagedSystemMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -3311,8 +3295,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PagedMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PagedMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PagedMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.PagedMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PagedMemorySize64 instead.")] + [<System.Obsolete("Process.PagedMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PagedMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PagedMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -3456,8 +3440,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PagedSystemMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PagedSystemMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PagedSystemMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.PagedSystemMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PagedSystemMemorySize64 instead.")] + [<System.Obsolete("Process.PagedSystemMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PagedSystemMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PagedSystemMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -3599,8 +3583,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PeakPagedMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PeakPagedMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PeakPagedMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.PeakPagedMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakPagedMemorySize64 instead.")] + [<System.Obsolete("Process.PeakPagedMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakPagedMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PeakPagedMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -3749,8 +3733,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PeakVirtualMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PeakVirtualMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PeakVirtualMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.PeakVirtualMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakVirtualMemorySize64 instead.")] + [<System.Obsolete("Process.PeakVirtualMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakVirtualMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PeakVirtualMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -3891,8 +3875,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PeakWorkingSet64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PeakWorkingSet64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PeakWorkingSet64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.PeakWorkingSet has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakWorkingSet64 instead.")] + [<System.Obsolete("Process.PeakWorkingSet has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakWorkingSet64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PeakWorkingSet64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -4215,8 +4199,8 @@ The calling process is a member of the associated process' descendant tree.[<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PrivateMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PrivateMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.PrivateMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.PrivateMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PrivateMemorySize64 instead.")] + [<System.Obsolete("Process.PrivateMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PrivateMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.PrivateMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -4489,6 +4473,14 @@ The calling process is a member of the associated process' descendant tree.2.1.0.0 + + [System.Runtime.Versioning.SupportedOSPlatform("windows")] + [<System.Runtime.Versioning.SupportedOSPlatform("windows")>] + + + [System.Runtime.Versioning.SupportedOSPlatform("linux")] + [<System.Runtime.Versioning.SupportedOSPlatform("linux")>] + [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] @@ -5143,10 +5135,6 @@ There is a similar issue when you read all text from both the standard output an [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -5249,10 +5237,6 @@ The member [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -5371,10 +5355,6 @@ The member [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -5463,10 +5443,6 @@ The file specified in the could not be found.[System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -5521,10 +5497,6 @@ The file specified in the could not be found.[System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -6305,8 +6277,8 @@ The file specified in the could not be found. [<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.VirtualMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.VirtualMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.VirtualMemorySize64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.VirtualMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.VirtualMemorySize64 instead.")] + [<System.Obsolete("Process.VirtualMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.VirtualMemorySize64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.VirtualMemorySize64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -6813,8 +6785,8 @@ Calling this method will set [<System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.WorkingSet64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.WorkingSet64 instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated because the type of the property can't represent all valid results. Please use System.Diagnostics.Process.WorkingSet64 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Process.WorkingSet has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.WorkingSet64 instead.")] + [<System.Obsolete("Process.WorkingSet has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.WorkingSet64 instead.")>] [System.Obsolete("This property has been deprecated. Please use System.Diagnostics.Process.WorkingSet64 instead. http://go.microsoft.com/fwlink/?linkid=14202")] diff --git a/xml/System.Diagnostics/ProcessThread.xml b/xml/System.Diagnostics/ProcessThread.xml index ce88cc85f0a..a5c46347782 100644 --- a/xml/System.Diagnostics/ProcessThread.xml +++ b/xml/System.Diagnostics/ProcessThread.xml @@ -454,6 +454,18 @@ [set: System.Runtime.Versioning.SupportedOSPlatform("windows")] [<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>] + + [get: System.Runtime.Versioning.SupportedOSPlatform("windows")] + [<get: System.Runtime.Versioning.SupportedOSPlatform("windows")>] + + + [get: System.Runtime.Versioning.SupportedOSPlatform("linux")] + [<get: System.Runtime.Versioning.SupportedOSPlatform("linux")>] + + + [get: System.Runtime.Versioning.SupportedOSPlatform("freebsd")] + [<get: System.Runtime.Versioning.SupportedOSPlatform("freebsd")>] + [System.Diagnostics.MonitoringDescription("ThreadPriorityLevel")] [<System.Diagnostics.MonitoringDescription("ThreadPriorityLevel")>] @@ -787,6 +799,14 @@ 2.1.0.0 + + [System.Runtime.Versioning.SupportedOSPlatform("windows")] + [<System.Runtime.Versioning.SupportedOSPlatform("windows")>] + + + [System.Runtime.Versioning.SupportedOSPlatform("linux")] + [<System.Runtime.Versioning.SupportedOSPlatform("linux")>] + [System.Diagnostics.MonitoringDescription("ThreadStartTime")] [<System.Diagnostics.MonitoringDescription("ThreadStartTime")>] diff --git a/xml/System.Diagnostics/TagList+Enumerator.xml b/xml/System.Diagnostics/TagList+Enumerator.xml new file mode 100644 index 00000000000..35be8929b71 --- /dev/null +++ b/xml/System.Diagnostics/TagList+Enumerator.xml @@ -0,0 +1,162 @@ + + + + + + + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.ValueType + + + + System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + System.Collections.IEnumerator + + + System.IDisposable + + + + An enumerator for traversing a tag list collection. + To be added. + + + + + + + + + + Property + + P:System.Collections.Generic.IEnumerator`1.Current + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Collections.Generic.KeyValuePair<System.String,System.Object> + + + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + To be added. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerator.MoveNext + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Boolean + + + + Advances the enumerator to the next element of the collection. + + if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerator.Reset + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + Sets the enumerator to its initial position, which is before the first element in the collection. + To be added. + + + + + + + + + + Property + + P:System.Collections.IEnumerator.Current + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Object + + + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + instance is cast to an interface. + + ]]> + + + + + diff --git a/xml/System.Diagnostics/TagList.xml b/xml/System.Diagnostics/TagList.xml new file mode 100644 index 00000000000..68202ab9d92 --- /dev/null +++ b/xml/System.Diagnostics/TagList.xml @@ -0,0 +1,546 @@ + + + + + + + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.ValueType + + + + System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + System.Collections.Generic.ICollection<T> + + + System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + System.Collections.Generic.IEnumerable<T> + + + System.Collections.Generic.IList<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + System.Collections.Generic.IReadOnlyCollection<T> + + + System.Collections.Generic.IReadOnlyList<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + System.Collections.IEnumerable + + + + Represents a list of tags that can be accessed by index. Provides methods to search, sort, and manipulate lists. + + + + + + + + + + + + + Constructor + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + + + A span of tags to initialize the list with. + Initializes a new instance of using the specified . + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Add(`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + The key-value pair of the tag to add to the list. + Adds a tag to the list. + To be added. + + + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + The tag key. + The tag value. + Adds a tag with the specified and to the list. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Clear + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + Removes all elements from the . + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Contains(`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Boolean + + + + + + The tag to locate in the . + Determines whether a tag is in the . + + if item is found in the ; otherwise, . + To be added. + + + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Void + + + + + + The destination object. + Copies the contents of this into a destination span. + To be added. + + The number of elements in the source is greater than the number of elements that the destination span. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Void + + + + + + + The one-dimensional Array that is the destination of the elements copied from . The Array must have zero-based indexing. + The zero-based index in at which copying begins. + Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. + To be added. + + is . + + is less than 0 or greater than or equal to the length. + + + + + + + + + + Property + + P:System.Collections.Generic.ICollection`1.Count + P:System.Collections.Generic.IReadOnlyCollection`1.Count + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Int32 + + + Gets the number of tags contained in the . + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.IEnumerable`1.GetEnumerator + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String,System.Object>> + + + + Returns an enumerator that iterates through the . + An enumerator that iterates through the . + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.IList`1.IndexOf(`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Int32 + + + + + + The tag to locate in the . + Searches for the specified tag and returns the zero-based index of the first occurrence within the entire . + The zero-based index of the first ocurrence of in the tag list. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.IList`1.Insert(System.Int32,`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + The zero-based index at which the item should be inserted. + The tag to insert. + Inserts an element into the at the specified index. + To be added. + + is less than 0 or is greater than . + + + + + + + + + + Property + + P:System.Collections.Generic.ICollection`1.IsReadOnly + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Boolean + + + Gets a value indicating whether the is read-only. This property will always return . + To be added. + To be added. + + + + + + + + + + Property + + P:System.Collections.Generic.IList`1.Item(System.Int32) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Collections.Generic.KeyValuePair<System.String,System.Object> + + + + + + The item index. + Gets or sets the tags at the specified index. + To be added. + To be added. + + is not a valid index in the . + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Remove(`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Boolean + + + + + + The tag to remove from the . + Removes the first occurrence of a specific object from the . + + if is successfully removed; otherwise, . This method also returns if was not found in the . + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.IList`1.RemoveAt(System.Int32) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + The zero-based index of the element to remove. + Removes the element at the specified index of the . + To be added. + + index is less than 0 or is greater than . + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Collections.IEnumerator + + + + Returns an enumerator that iterates through the . + An enumerator that iterates through the . + To be added. + + + + diff --git a/xml/System.Drawing.Configuration/SystemDrawingSection.xml b/xml/System.Drawing.Configuration/SystemDrawingSection.xml index ba7dcafc803..6a2eff31f09 100644 --- a/xml/System.Drawing.Configuration/SystemDrawingSection.xml +++ b/xml/System.Drawing.Configuration/SystemDrawingSection.xml @@ -1,11 +1,11 @@ - + - + System.Drawing 4.0.0.0 @@ -73,7 +73,7 @@ 6.0.0.0 - + [System.Configuration.ConfigurationProperty("bitmapSuffix")] [<System.Configuration.ConfigurationProperty("bitmapSuffix")>] @@ -95,12 +95,15 @@ - + - + - + + + + Property System.Drawing diff --git a/xml/System.Drawing.Design/ToolboxItem.xml b/xml/System.Drawing.Design/ToolboxItem.xml index 11e965f7e18..d44106e76d9 100644 --- a/xml/System.Drawing.Design/ToolboxItem.xml +++ b/xml/System.Drawing.Design/ToolboxItem.xml @@ -1029,6 +1029,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("SingleFile", "IL3002", Justification="Single-file case is handled")] + [<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("SingleFile", "IL3002", Justification="Single-file case is handled")>] + + System.Type diff --git a/xml/System.Drawing.Imaging/EncoderParameter.xml b/xml/System.Drawing.Imaging/EncoderParameter.xml index ba03c98a4aa..9619b683a18 100644 --- a/xml/System.Drawing.Imaging/EncoderParameter.xml +++ b/xml/System.Drawing.Imaging/EncoderParameter.xml @@ -555,10 +555,14 @@ [System.Obsolete("This constructor has been deprecated. Use EncoderParameter(Encoder encoder, int numberValues, EncoderParameterValueType type, IntPtr value) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Use EncoderParameter(Encoder encoder, int numberValues, EncoderParameterValueType type, IntPtr value) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - + [System.Obsolete("This constructor has been deprecated. Use EncoderParameter(Encoder encoder, int numberValues, EncoderParameterValueType type, IntPtr value) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Use EncoderParameter(Encoder encoder, int numberValues, EncoderParameterValueType type, IntPtr value) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated. Use EncoderParameter(Encoder encoder, int numberValues, EncoderParameterValueType type, IntPtr value) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use EncoderParameter(Encoder encoder, int numberValues, EncoderParameterValueType type, IntPtr value) instead.")>] + diff --git a/xml/System.Drawing/FontFamily.xml b/xml/System.Drawing/FontFamily.xml index da2eb03e5e0..6c72c2ebf35 100644 --- a/xml/System.Drawing/FontFamily.xml +++ b/xml/System.Drawing/FontFamily.xml @@ -648,10 +648,14 @@ 6.0.0.0 - + [System.Obsolete("Do not use method GetFamilies, use property Families instead")] [<System.Obsolete("Do not use method GetFamilies, use property Families instead")>] + + [System.Obsolete("FontFamily.GetFamilies has been deprecated. Use Families instead.")] + [<System.Obsolete("FontFamily.GetFamilies has been deprecated. Use Families instead.")>] + System.Drawing.FontFamily[] diff --git a/xml/System.Drawing/PointF.xml b/xml/System.Drawing/PointF.xml index 3fde0a1afba..dfe47e3bfae 100644 --- a/xml/System.Drawing/PointF.xml +++ b/xml/System.Drawing/PointF.xml @@ -83,7 +83,7 @@ - To be added. + The source vector. Initializes a new instance of the struct from the specified . To be added. @@ -680,9 +680,9 @@ - To be added. + The point to convert from. Converts the specified to a . - To be added. + The vector that represents the converted . To be added. @@ -708,9 +708,9 @@ - To be added. + The vector to convert. Converts the specified to a . - To be added. + The pair of coordinates that represents the converted . To be added. @@ -1073,7 +1073,7 @@ Creates a new from this . - To be added. + The vector that was created from this . To be added. diff --git a/xml/System.Drawing/RectangleF.xml b/xml/System.Drawing/RectangleF.xml index a0d1b1130f4..a9a58e1f4e3 100644 --- a/xml/System.Drawing/RectangleF.xml +++ b/xml/System.Drawing/RectangleF.xml @@ -89,7 +89,7 @@ - To be added. + The source vector. Initializes a new instance of the struct from the specified . To be added. @@ -1349,9 +1349,9 @@ - To be added. + The rectangle to convert. Converts the specified to a . - To be added. + The vector that represents the converted . To be added. @@ -1377,9 +1377,9 @@ - To be added. - Converts the specified to a . - To be added. + The vector to convert. + Converts the specified to a . + The rectangle that represents the converted . To be added. @@ -1702,7 +1702,7 @@ Creates a new from this . - To be added. + The rectangle, converted into a new instance. To be added. diff --git a/xml/System.Drawing/SizeF.xml b/xml/System.Drawing/SizeF.xml index 582eb6843ee..58a35d39092 100644 --- a/xml/System.Drawing/SizeF.xml +++ b/xml/System.Drawing/SizeF.xml @@ -192,7 +192,7 @@ - To be added. + The source vector. Initializes a new instance of the struct from the specified . To be added. @@ -795,9 +795,9 @@ - To be added. + The pair of numbers to convert. Converts the specified to a . - To be added. + The size, converted into a instance. To be added. @@ -823,9 +823,9 @@ - To be added. + The vector to convert. Converts the specified to a . - To be added. + The vector, converted into a instance. To be added. @@ -1193,7 +1193,7 @@ Creates a new from this . - To be added. + The vector that was created from this . To be added. diff --git a/xml/System.Formats.Cbor/CborContentException.xml b/xml/System.Formats.Cbor/CborContentException.xml index 03dc0873d8b..26c2d1e3ca4 100644 --- a/xml/System.Formats.Cbor/CborContentException.xml +++ b/xml/System.Formats.Cbor/CborContentException.xml @@ -40,8 +40,8 @@ - To be added. - To be added. + The exception message. + Initializes a new instance of the using the specified message. To be added. @@ -62,9 +62,9 @@ - To be added. - To be added. - To be added. + The containing all the data needed to deserialize the object. + The describing the source and destination of the given serialized stream. + Initializes a new instance from a state file, using binary serialization. To be added. @@ -85,9 +85,9 @@ - To be added. - To be added. - To be added. + The exception message. + The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. + Initializes a new instance of the using the specified message and inner exception. To be added. diff --git a/xml/System.Globalization/CultureTypes.xml b/xml/System.Globalization/CultureTypes.xml index fbd2c27d29b..1e82b493562 100644 --- a/xml/System.Globalization/CultureTypes.xml +++ b/xml/System.Globalization/CultureTypes.xml @@ -160,10 +160,14 @@ On .NET Framework 4 and later versions and .NET Core running on Windows, it incl 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Please use other values in CultureTypes.")] [<System.Obsolete("This value has been deprecated. Please use other values in CultureTypes.")>] + + [System.Obsolete("CultureTypes.FrameworkCultures has been deprecated. Use other values in CultureTypes instead.")] + [<System.Obsolete("CultureTypes.FrameworkCultures has been deprecated. Use other values in CultureTypes instead.")>] + System.Globalization.CultureTypes @@ -379,10 +383,14 @@ On .NET Framework 4 and later versions and .NET Core running on Windows, it incl 6.0.0.0 - + [System.Obsolete("This value has been deprecated. Please use other values in CultureTypes.")] [<System.Obsolete("This value has been deprecated. Please use other values in CultureTypes.")>] + + [System.Obsolete("CultureTypes.WindowsOnlyCultures has been deprecated. Use other values in CultureTypes instead.")] + [<System.Obsolete("CultureTypes.WindowsOnlyCultures has been deprecated. Use other values in CultureTypes instead.")>] + System.Globalization.CultureTypes diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorage.xml b/xml/System.IO.IsolatedStorage/IsolatedStorage.xml index c1e8508ffea..919d358a855 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorage.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorage.xml @@ -273,10 +273,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("IsolatedStorage.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorage.UsedSize")] [<System.Obsolete("IsolatedStorage.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorage.UsedSize")>] + + [System.Obsolete("IsolatedStorage.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorage.UsedSize instead.")] + [<System.Obsolete("IsolatedStorage.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorage.UsedSize instead.")>] + [System.Obsolete] [<System.Obsolete>] @@ -595,10 +599,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("IsolatedStorage.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorage.Quota")] [<System.Obsolete("IsolatedStorage.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorage.Quota")>] + + [System.Obsolete("IsolatedStorage.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorage.Quota instead.")] + [<System.Obsolete("IsolatedStorage.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorage.Quota instead.")>] + [System.Obsolete] [<System.Obsolete>] diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml b/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml index da424e58849..120d65f9467 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml @@ -520,10 +520,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("IsolatedStorageFile.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorageFile.UsedSize")] [<System.Obsolete("IsolatedStorageFile.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorageFile.UsedSize")>] + + [System.Obsolete("IsolatedStorageFile.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorageFile.UsedSize instead.")] + [<System.Obsolete("IsolatedStorageFile.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorageFile.UsedSize instead.")>] + [get: System.Security.SecuritySafeCritical] [<get: System.Security.SecuritySafeCritical>] @@ -2579,10 +2583,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("IsolatedStorageFile.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorageFile.Quota")] [<System.Obsolete("IsolatedStorageFile.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorageFile.Quota")>] + + [System.Obsolete("IsolatedStorageFile.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorageFile.Quota instead.")] + [<System.Obsolete("IsolatedStorageFile.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorageFile.Quota instead.")>] + [get: System.Security.SecuritySafeCritical] [<get: System.Security.SecuritySafeCritical>] diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml index 407411dcbbb..7dd21680df1 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml @@ -1344,10 +1344,14 @@ Dim source As New IsolatedStorageFileStream(UserName,FileMode.Open,isoFile) 6.0.0.0 - + [System.Obsolete("This property has been deprecated. Please use IsolatedStorageFileStream's SafeFileHandle property instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use IsolatedStorageFileStream's SafeFileHandle property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("IsolatedStorageFileStream.Handle has been deprecated. Use IsolatedStorageFileStream's SafeFileHandle property instead.")] + [<System.Obsolete("IsolatedStorageFileStream.Handle has been deprecated. Use IsolatedStorageFileStream's SafeFileHandle property instead.")>] + [System.Obsolete("This property has been deprecated. Please use IsolatedStorageFileStream's SafeFileHandle property instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use IsolatedStorageFileStream's SafeFileHandle property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.IO.Packaging/PackUriHelper.xml b/xml/System.IO.Packaging/PackUriHelper.xml index beece52e6ef..7694cdbb58f 100644 --- a/xml/System.IO.Packaging/PackUriHelper.xml +++ b/xml/System.IO.Packaging/PackUriHelper.xml @@ -1,11 +1,11 @@ - + - + System.IO.Packaging 4.0.0.0 diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index 630f629ba32..7d10e772df5 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -409,10 +409,14 @@ The canceled 6.0.0.0 - + [System.Obsolete("OnWriterCompleted may not be invoked on all implementations of PipeReader. This will be removed in a future release.")] [<System.Obsolete("OnWriterCompleted may not be invoked on all implementations of PipeReader. This will be removed in a future release.")>] + + [System.Obsolete("OnWriterCompleted has been deprecated and may not be invoked on all implementations of PipeReader.")] + [<System.Obsolete("OnWriterCompleted has been deprecated and may not be invoked on all implementations of PipeReader.")>] + System.Void diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index d58c17772c6..e73c9cb2a82 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -418,10 +418,14 @@ You must request a new buffer after calling 6.0.0.0 - + [System.Obsolete("OnReaderCompleted may not be invoked on all implementations of PipeWriter. This will be removed in a future release.")] [<System.Obsolete("OnReaderCompleted may not be invoked on all implementations of PipeWriter. This will be removed in a future release.")>] + + [System.Obsolete("OnReaderCompleted has been deprecated and may not be invoked on all implementations of PipeWriter.")] + [<System.Obsolete("OnReaderCompleted has been deprecated and may not be invoked on all implementations of PipeWriter.")>] + System.Void diff --git a/xml/System.IO/Directory.xml b/xml/System.IO/Directory.xml index 3f6660e32f9..2c5e7666443 100644 --- a/xml/System.IO/Directory.xml +++ b/xml/System.IO/Directory.xml @@ -365,7 +365,7 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html"); - The absolute path where the symbolic link should be created. + The path where the symbolic link should be created. The target directory of the symbolic link. Creates a directory symbolic link identified by that points to . A instance that wraps the newly created directory symbolic link. @@ -374,10 +374,17 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html"); or is . or is empty. - -or- is not an absolute path. - -or- or contains invalid path characters. + +-or- + + or contains invalid path characters. A file or directory already exists in the location of . - -or- An I/O error occurred. + +-or- + +An I/O error occurred. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations @@ -4092,11 +4099,21 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html"); When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows. +Symbolic links and junctions are the types of links this API can resolve. + ]]> The directory on does not exist. - -or- The link's file system entry type is inconsistent with that of its target. - -or- Too many levels of symbolic links. + +-or- + +The link's file system entry type is inconsistent with that of its target. + +-or- + +There are too many levels of symbolic links. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml index 432f95c1508..4f86f4221c0 100644 --- a/xml/System.IO/File.xml +++ b/xml/System.IO/File.xml @@ -1391,9 +1391,17 @@ or is . or is empty. - -or- or contains a character. + +-or- + + or contains a character. A file or directory already exists in the location of . - -or- An I/O error occurred. + +-or- + +An I/O error occurred. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations @@ -4716,11 +4724,21 @@ The following example moves a file. When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows. +Symbolic links and junctions are the types of links this API can resolve. + ]]> The file on does not exist. - -or- The link's file system entry type is inconsistent with that of its target. - -or- Too many levels of symbolic links. + +-or- + +The link's file system entry type is inconsistent with that of its target. + +-or- + +There are too many levels of symbolic links. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations diff --git a/xml/System.IO/FileFormatException.xml b/xml/System.IO/FileFormatException.xml index 73bfd503c85..0610f9bf1e2 100644 --- a/xml/System.IO/FileFormatException.xml +++ b/xml/System.IO/FileFormatException.xml @@ -1,10 +1,11 @@ - + + @@ -36,7 +37,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("WindowsBase, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("WindowsBase, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.IO/FileStream.xml b/xml/System.IO/FileStream.xml index 1af3deac82f..b7499713785 100644 --- a/xml/System.IO/FileStream.xml +++ b/xml/System.IO/FileStream.xml @@ -228,7 +228,7 @@ System.IO.FileSystem - + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -236,6 +236,10 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access) instead.")>] + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -576,7 +580,7 @@ The file was too large (when + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -584,6 +588,10 @@ The file was too large (when [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access) and optionally make a new SafeFileHandle with ownsHandle=false if needed instead.")] + [<System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access) and optionally make a new SafeFileHandle with ownsHandle=false if needed instead.")>] + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -856,7 +864,7 @@ The file was too large (when + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -864,6 +872,10 @@ The file was too large (when [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access, int bufferSize) and optionally make a new SafeFileHandle with ownsHandle=false if needed instead.")] + [<System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access, int bufferSize) and optionally make a new SafeFileHandle with ownsHandle=false if needed instead.")>] + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1061,7 +1073,7 @@ The file was too large (when + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1069,6 +1081,10 @@ The file was too large (when [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync) and optionally make a new SafeFileHandle with ownsHandle=false if needed instead.")] + [<System.Obsolete("This constructor has been deprecated. Use FileStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync) and optionally make a new SafeFileHandle with ownsHandle=false if needed instead.")>] + [System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use new FileStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync) instead, and optionally make a new SafeFileHandle with ownsHandle=false if needed. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -2795,10 +2811,14 @@ Calling `DisposeAsync` allows the resources used by the System.IO.FileSystem - + [System.Obsolete("This property has been deprecated. Please use FileStream's SafeFileHandle property instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use FileStream's SafeFileHandle property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("FileStream.Handle has been deprecated. Use FileStream's SafeFileHandle property instead.")] + [<System.Obsolete("FileStream.Handle has been deprecated. Use FileStream's SafeFileHandle property instead.")>] + [System.Obsolete("This property has been deprecated. Please use FileStream's SafeFileHandle property instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use FileStream's SafeFileHandle property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -3007,10 +3027,6 @@ Calling `DisposeAsync` allows the resources used by the [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] @@ -3898,10 +3914,6 @@ The following example shows how to read from a file asynchronously. [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("macos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("macos")>] diff --git a/xml/System.IO/FileSystemInfo.xml b/xml/System.IO/FileSystemInfo.xml index 5c8927969f9..48e75bf98a8 100644 --- a/xml/System.IO/FileSystemInfo.xml +++ b/xml/System.IO/FileSystemInfo.xml @@ -361,10 +361,17 @@ is . is empty. - -or- This instance was not created passing an absolute path. - -or- contains invalid path characters. + +-or- + + contains invalid path characters. A file or directory already exists in the location of . - -or- An I/O error occurred. + +-or- + +An I/O error occurred. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations @@ -1315,7 +1322,9 @@ The `Extension` property returns the extension, If this instance represents a link, returns the link target's path. If a link does not exist in , or this instance does not represent a link, returns . To be added. - To be added. + Symbolic links and junctions are the types of links this API can resolve. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations @@ -1530,11 +1539,21 @@ Call `Refresh` before attempting to get the attribute information, or the inform When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows. +Symbolic links and junctions are the types of links this API can resolve. + ]]> The file or directory does not exist. - -or- The link's file system entry type is inconsistent with that of its target. - -or- Too many levels of symbolic links. + +-or- + +The link's file system entry type is inconsistent with that of its target. + +-or- + +There are too many levels of symbolic links. + Windows Developer - Symbolic Links + Windows Developer - Reparse Points and File Operations diff --git a/xml/System.IO/Path.xml b/xml/System.IO/Path.xml index a9833c57a6f..1b7567582c9 100644 --- a/xml/System.IO/Path.xml +++ b/xml/System.IO/Path.xml @@ -2131,10 +2131,14 @@ A trailing period in `path` is not considered an extension. 6.0.0.0 - + [System.Obsolete("Please use GetInvalidPathChars or GetInvalidFileNameChars instead.")] [<System.Obsolete("Please use GetInvalidPathChars or GetInvalidFileNameChars instead.")>] + + [System.Obsolete("Path.InvalidPathChars has been deprecated. Use GetInvalidPathChars or GetInvalidFileNameChars instead.")] + [<System.Obsolete("Path.InvalidPathChars has been deprecated. Use GetInvalidPathChars or GetInvalidFileNameChars instead.")>] + [System.Obsolete("see GetInvalidPathChars and GetInvalidFileNameChars methods.")] [<System.Obsolete("see GetInvalidPathChars and GetInvalidFileNameChars methods.")>] diff --git a/xml/System.IO/Stream.xml b/xml/System.IO/Stream.xml index 54aa81e5d82..92826636a54 100644 --- a/xml/System.IO/Stream.xml +++ b/xml/System.IO/Stream.xml @@ -1097,10 +1097,14 @@ System.IO - + [System.Obsolete("CreateWaitHandle will be removed eventually. Please use "new ManualResetEvent(false)" instead.")] [<System.Obsolete("CreateWaitHandle will be removed eventually. Please use "new ManualResetEvent(false)" instead.")>] + + [System.Obsolete("Stream.CreateWaitHandle has been deprecated. Use the ManualResetEvent(false) constructor instead.")] + [<System.Obsolete("Stream.CreateWaitHandle has been deprecated. Use the ManualResetEvent(false) constructor instead.")>] + System.Threading.WaitHandle diff --git a/xml/System.Linq.Expressions/Expression.xml b/xml/System.Linq.Expressions/Expression.xml index 6b776dc1243..f541ea5f633 100644 --- a/xml/System.Linq.Expressions/Expression.xml +++ b/xml/System.Linq.Expressions/Expression.xml @@ -131,10 +131,14 @@ 6.0.0.0 - + [System.Obsolete("use a different constructor that does not take ExpressionType. Then override NodeType and Type properties to provide the values that would be specified to this constructor.")] [<System.Obsolete("use a different constructor that does not take ExpressionType. Then override NodeType and Type properties to provide the values that would be specified to this constructor.")>] + + [System.Obsolete("This constructor has been deprecated. Use a different constructor that does not take ExpressionType. Then override NodeType and Type properties to provide the values that would be specified to this constructor.")] + [<System.Obsolete("This constructor has been deprecated. Use a different constructor that does not take ExpressionType. Then override NodeType and Type properties to provide the values that would be specified to this constructor.")>] + @@ -4909,12 +4913,6 @@ 2.0.0.0 2.1.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")>] - - System.Linq.Expressions.UnaryExpression @@ -5026,10 +5024,6 @@ 2.1.0.0 - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")>] - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] @@ -5115,12 +5109,6 @@ 2.0.0.0 2.1.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")>] - - System.Linq.Expressions.UnaryExpression @@ -12459,10 +12447,6 @@ As with `Func`, the last argument is the return type. It can be set to `System.V 2.1.0.0 - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")>] - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] @@ -12527,12 +12511,6 @@ As with `Func`, the last argument is the return type. It can be set to `System.V 2.0.0.0 2.1.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Creating Expressions requires unreferenced code because the members being referenced by the Expression may be trimmed.")>] - - System.Linq.Expressions.UnaryExpression diff --git a/xml/System.Linq.Expressions/MemberBinding.xml b/xml/System.Linq.Expressions/MemberBinding.xml index 8d9ed64e3e8..9e1bf16e236 100644 --- a/xml/System.Linq.Expressions/MemberBinding.xml +++ b/xml/System.Linq.Expressions/MemberBinding.xml @@ -69,10 +69,14 @@ 6.0.0.0 - + [System.Obsolete("Do not use this constructor. It will be removed in future releases.")] [<System.Obsolete("Do not use this constructor. It will be removed in future releases.")>] + + [System.Obsolete("This constructor has been deprecated and is not supported.")] + [<System.Obsolete("This constructor has been deprecated and is not supported.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] diff --git a/xml/System.Linq/Enumerable.xml b/xml/System.Linq/Enumerable.xml index cca9f0cd1cd..7fe50d5578b 100644 --- a/xml/System.Linq/Enumerable.xml +++ b/xml/System.Linq/Enumerable.xml @@ -3364,13 +3364,13 @@ Only unique elements are returned. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the elements of the input sequence. + The type of key to identify elements by. + An whose keys that are not also in will be returned. + An whose keys that also occur in the first sequence will cause those elements to be removed from the returned sequence. + A function to extract the key for each element. + Produces the set difference of two sequences according to a specified key selector function. + A sequence that contains the set difference of the elements of two sequences. To be added. @@ -3406,14 +3406,14 @@ Only unique elements are returned. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the elements of the input sequence. + The type of key to identify elements by. + An whose keys that are not also in will be returned. + An whose keys that also occur in the first sequence will cause those elements to be removed from the returned sequence. + A function to extract the key for each element. + The to compare values. + Produces the set difference of two sequences according to a specified key selector function. + A sequence that contains the set difference of the elements of two sequences. To be added. diff --git a/xml/System.Linq/Queryable.xml b/xml/System.Linq/Queryable.xml index 9009d720cd2..cf5477f31b3 100644 --- a/xml/System.Linq/Queryable.xml +++ b/xml/System.Linq/Queryable.xml @@ -3184,13 +3184,13 @@ The last chunk will contain the remaining elements and may be of a smaller size. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the elements of the input sequence. + The type of key to identify elements by. + An whose keys that are not also in will be returned. + An whose keys that also occur in the first sequence will cause those elements to be removed from the returned sequence. + A function to extract the key for each element. + Produces the set difference of two sequences according to a specified key selector function. + A that contains the set difference of the elements of two sequences. To be added. @@ -3226,14 +3226,14 @@ The last chunk will contain the remaining elements and may be of a smaller size. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the elements of the input sequence. + The type of key to identify elements by. + An whose keys that are not also in will be returned. + An whose keys that also occur in the first sequence will cause those elements to be removed from the returned sequence. + A function to extract the key for each element. + An to compare keys. + Produces the set difference of two sequences according to a specified key selector function. + A that contains the set difference of the elements of two sequences. To be added. diff --git a/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml b/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml index e8096ef2a1f..cf66e6b06ed 100644 --- a/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml +++ b/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml @@ -213,7 +213,7 @@ Multiple header values associated with the same header name are considered to be - To be added. + The key to locate. Determines whether the read-only dictionary contains an element that has the specified key. if the read-only dictionary contains an element that has the specified key; otherwise, . @@ -264,10 +264,11 @@ Multiple header values associated with the same header name are considered to be - To be added. - To be added. - To be added. - To be added. + The key to locate. + When this method returns, contains the value associated with the specified key, if the key is found; otherwise, contains the default value of . This parameter is passed uninitialized. + Gets the value that is associated with the specified key. + + if the collection contains the specified header; otherwise, . To be added. diff --git a/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml b/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml index 8fdda310d4d..7686f9e2f45 100644 --- a/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml +++ b/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml @@ -170,13 +170,13 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The client used to send the request. + The Uri the request is sent to. + The type of the object to deserialize to and return. + Source generated JsonSerializerContext used to control the deserialization behavior. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. + The task object representing the asynchronous operation. To be added. @@ -241,13 +241,13 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The client used to send the request. + The Uri the request is sent to. + The type of the object to deserialize to and return. + Source generated JsonSerializerContext used to control the deserialization behavior. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. + The task object representing the asynchronous operation. To be added. @@ -410,13 +410,13 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The target type to deserialize to. + The client used to send the request. + The Uri the request is sent to. + Source generated JsonTypeInfo to control the behavior during deserialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. + The task object representing the asynchronous operation. To be added. @@ -485,13 +485,13 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The target type to deserialize to. + The client used to send the request. + The Uri the request is sent to. + Source generated JsonTypeInfo to control the behavior during deserialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. + The task object representing the asynchronous operation. To be added. @@ -663,14 +663,14 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to serialize. + The client used to send the request. + The Uri the request is sent to. + The value to serialize. + Source generated JsonTypeInfo to control the behavior during serialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends a POST request to the specified Uri containing the serialized as JSON in the request body. + The task object representing the asynchronous operation. To be added. @@ -742,14 +742,14 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to serialize. + The client used to send the request. + The Uri the request is sent to. + The value to serialize. + Source generated JsonTypeInfo to control the behavior during serialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends a POST request to the specified Uri containing the serialized as JSON in the request body. + The task object representing the asynchronous operation. To be added. @@ -921,14 +921,14 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to serialize. + The client used to send the request. + The Uri the request is sent to. + The value to serialize. + Source generated JsonTypeInfo to control the behavior during serialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Send a PUT request to the specified Uri containing the serialized as JSON in the request body. + The task object representing the asynchronous operation. To be added. @@ -1000,14 +1000,14 @@ This method uses - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to serialize. + The client used to send the request. + The Uri the request is sent to. + The value to serialize. + Source generated JsonTypeInfo to control the behavior during serialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Send a PUT request to the specified Uri containing the serialized as JSON in the request body. + The task object representing the asynchronous operation. To be added. diff --git a/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml b/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml index fff374be735..d0aeb4bf912 100644 --- a/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml +++ b/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml @@ -77,12 +77,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The content to read from. + The type of the object to deserialize to and return. + Source generated JsonSerializerContext used to control the behavior during deserialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. + The task object representing the asynchronous operation. To be added. @@ -148,12 +148,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The target type to deserialize to. + The content to read from. + Source generated JsonTypeInfo to control the behavior during deserialization. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. + The task object representing the asynchronous operation. To be added. diff --git a/xml/System.Net.Http/HeaderEncodingSelector`1.xml b/xml/System.Net.Http/HeaderEncodingSelector`1.xml index 932c2de1b4b..8da6264f7a1 100644 --- a/xml/System.Net.Http/HeaderEncodingSelector`1.xml +++ b/xml/System.Net.Http/HeaderEncodingSelector`1.xml @@ -24,7 +24,7 @@ System.Text.Encoding - To be added. + The type of the headers that are being encoded/decoded. The name of the header to specify for the encoding. The type we are encoding/decoding the headers for. Represents a method that specifies the encoding to use when interpreting header values. diff --git a/xml/System.Net.Http/HttpClientHandler.xml b/xml/System.Net.Http/HttpClientHandler.xml index bcbc89d6eaf..3df2c2cd3ca 100644 --- a/xml/System.Net.Http/HttpClientHandler.xml +++ b/xml/System.Net.Http/HttpClientHandler.xml @@ -187,18 +187,6 @@ You can configure your app to use the older HTTP protocol stacks in one of the f [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - System.Net.DecompressionMethods @@ -249,22 +237,6 @@ After NuGet package v4.3.2, the default value of [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -305,24 +277,6 @@ After NuGet package v4.3.2, the default value of 2.0.0.0 2.1.0.0 - - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - - System.Net.Http.ClientCertificateOption @@ -361,22 +315,6 @@ After NuGet package v4.3.2, the default value of [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -501,26 +439,10 @@ After NuGet package v4.3.2, the default value of 2.1.0.0 - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - System.Func<System.Net.Http.HttpRequestMessage,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors,System.Boolean> @@ -578,22 +500,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -683,18 +589,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - System.Int32 @@ -741,22 +635,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -840,22 +718,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -899,18 +761,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - System.Boolean @@ -959,22 +809,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA 2.1.0.0 - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -1019,18 +853,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [set: System.Security.SecuritySafeCritical] [<set: System.Security.SecuritySafeCritical>] @@ -1200,22 +1022,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -1271,22 +1077,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] @@ -1521,18 +1311,6 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - System.Boolean diff --git a/xml/System.Net.Http/HttpContent.xml b/xml/System.Net.Http/HttpContent.xml index c2acd9a919a..336270efc40 100644 --- a/xml/System.Net.Http/HttpContent.xml +++ b/xml/System.Net.Http/HttpContent.xml @@ -311,10 +311,21 @@ - To be added. - To be added. - To be added. - To be added. + The cancellation token to cancel the operation. + Serializes the HTTP content to a memory stream. + The output memory stream which contains the serialized HTTP content. + + method buffers the content to a memory stream. + Derived classes can override this behavior if there is a better way to retrieve the content as stream. + For example, a byte array or a string could use a more efficient method way such as wrapping a read-only MemoryStream around the bytes or string. + + ]]> + diff --git a/xml/System.Net.Http/HttpRequestMessage.xml b/xml/System.Net.Http/HttpRequestMessage.xml index 24a0c2aad64..92bded12b97 100644 --- a/xml/System.Net.Http/HttpRequestMessage.xml +++ b/xml/System.Net.Http/HttpRequestMessage.xml @@ -391,7 +391,7 @@ System.Net.Http.HttpRequestOptions - To be added. + Gets the collection of options to configure the HTTP request. To be added. To be added. @@ -422,10 +422,14 @@ 2.1.0.0 - + [System.Obsolete("Use Options instead.")] [<System.Obsolete("Use Options instead.")>] + + [System.Obsolete("HttpRequestMessage.Properties has been deprecated. Use Options instead.")] + [<System.Obsolete("HttpRequestMessage.Properties has been deprecated. Use Options instead.")>] + System.Collections.Generic.IDictionary<System.String,System.Object> diff --git a/xml/System.Net.Http/HttpRequestOptions.xml b/xml/System.Net.Http/HttpRequestOptions.xml index 46c17078d18..e4ac05e00e0 100644 --- a/xml/System.Net.Http/HttpRequestOptions.xml +++ b/xml/System.Net.Http/HttpRequestOptions.xml @@ -37,7 +37,7 @@ - To be added. + Represents a collection of options for an HTTP request. To be added. @@ -55,7 +55,7 @@ - To be added. + Initializes a new instance of the HttpRequestOptions class. To be added. @@ -83,10 +83,10 @@ - To be added. - To be added. - To be added. - To be added. + The type of the HTTP value as defined by . + The strongly typed key for the HTTP request option. + The value of the HTTP request option. + Sets the value of a specified HTTP request option. To be added. @@ -545,11 +545,20 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. + The key of the value to get. + When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized. + Gets the value associated with the specified key. + + if the contains an element with the specified key; otherwise, . + + instance is cast to an interface. + + ]]> + @@ -684,11 +693,12 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the HTTP value as defined by . + The strongly typed key to get the value of an HTTP request option. + When this method returns, contains the value of the specified HTTP request option. + Gets the value of a specified HTTP request option. + + if the collection contains an element with the specified key; otherwise, . To be added. diff --git a/xml/System.Net.Http/HttpRequestOptionsKey`1.xml b/xml/System.Net.Http/HttpRequestOptionsKey`1.xml index f6125f767b5..4ca1f386f35 100644 --- a/xml/System.Net.Http/HttpRequestOptionsKey`1.xml +++ b/xml/System.Net.Http/HttpRequestOptionsKey`1.xml @@ -24,8 +24,8 @@ - To be added. - To be added. + The type of the value of the option. + Represents a key in the options collection for an HTTP request. To be added. @@ -46,8 +46,8 @@ - To be added. - To be added. + Name of the HTTP request option. + Initializes a new instance of the class using the specified key name. To be added. @@ -68,7 +68,7 @@ System.String - To be added. + Gets the name of the option. To be added. To be added. diff --git a/xml/System.Net.Http/SocketsHttpConnectionContext.xml b/xml/System.Net.Http/SocketsHttpConnectionContext.xml index f78b79e92e7..90ff022f01f 100644 --- a/xml/System.Net.Http/SocketsHttpConnectionContext.xml +++ b/xml/System.Net.Http/SocketsHttpConnectionContext.xml @@ -58,8 +58,8 @@ System.Net.Http.HttpRequestMessage - The initial HttpRequestMessage that is causing the connection to be created. - To be added. + Gets the initial HttpRequestMessage that is causing the connection to be created. + The request message that's causing the connection to be created. To be added. diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 563c084b93d..d0bc27e5f22 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -660,7 +660,7 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r Gets or sets a custom callback that provides access to the plaintext HTTP protocol stream. - To be added. + A callback that provides access to the plaintext HTTP protocol stream. To be added. @@ -768,7 +768,7 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r System.Collections.Generic.IDictionary<System.String,System.Object> - To be added. + Gets a writable dictionary (that is, a map) of custom properties for the HttpClient requests. The dictionary is initialized empty; you can insert and query key-value pairs for your custom handlers and special processing. To be added. To be added. diff --git a/xml/System.Net.Http/SocketsHttpPlaintextStreamFilterContext.xml b/xml/System.Net.Http/SocketsHttpPlaintextStreamFilterContext.xml index 37ef2075d4f..1268b4dd820 100644 --- a/xml/System.Net.Http/SocketsHttpPlaintextStreamFilterContext.xml +++ b/xml/System.Net.Http/SocketsHttpPlaintextStreamFilterContext.xml @@ -36,8 +36,8 @@ System.Net.Http.HttpRequestMessage - The initial HttpRequestMessage that is causing the stream to be used. - To be added. + Gets the initial HttpRequestMessage that is causing the stream to be used. + The HTTP request message that is causing the stream to be used. To be added. @@ -58,8 +58,8 @@ System.Version - The version of HTTP in use for this stream. - To be added. + Gets the version of HTTP in use for this stream. + The version of HTTP in use for this stream. To be added. @@ -80,8 +80,8 @@ System.IO.Stream - The plaintext Stream that will be used for HTTP protocol requests and responses. - To be added. + Gets the plaintext Stream that will be used for HTTP protocol requests and responses. + The plaintext stream that will be used for HTTP protocol requests and responses. To be added. diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index 8d6628f8bb7..c43d11c8e72 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -934,12 +934,6 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Net.Http.WinHttpHandler 6.0.0.0 - - - [System.Runtime.Versioning.SupportedOSPlatform("windows10.0.19041")] - [<System.Runtime.Versioning.SupportedOSPlatform("windows10.0.19041")>] - - System.Boolean @@ -971,12 +965,6 @@ Only supported on Windows 10 version 2004 or newer. System.Net.Http.WinHttpHandler 6.0.0.0 - - - [System.Runtime.Versioning.SupportedOSPlatform("windows10.0.19041")] - [<System.Runtime.Versioning.SupportedOSPlatform("windows10.0.19041")>] - - System.TimeSpan @@ -1008,12 +996,6 @@ Only supported on Windows 10 version 2004 or newer. System.Net.Http.WinHttpHandler 6.0.0.0 - - - [System.Runtime.Versioning.SupportedOSPlatform("windows10.0.19041")] - [<System.Runtime.Versioning.SupportedOSPlatform("windows10.0.19041")>] - - System.TimeSpan diff --git a/xml/System.Net.Mail/MailMessage.xml b/xml/System.Net.Mail/MailMessage.xml index 5771ed585da..bef22cda1d0 100644 --- a/xml/System.Net.Mail/MailMessage.xml +++ b/xml/System.Net.Mail/MailMessage.xml @@ -1235,10 +1235,14 @@ 6.0.0.0 - + [System.Obsolete("ReplyTo is obsoleted for this type. Please use ReplyToList instead which can accept multiple addresses. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("ReplyTo is obsoleted for this type. Please use ReplyToList instead which can accept multiple addresses. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("ReplyTo has been deprecated. Use ReplyToList instead, which can accept multiple addresses.")] + [<System.Obsolete("ReplyTo has been deprecated. Use ReplyToList instead, which can accept multiple addresses.")>] + [System.Obsolete("ReplyTo is obsoleted for this type. Please use ReplyToList instead which can accept multiple addresses. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("ReplyTo is obsoleted for this type. Please use ReplyToList instead which can accept multiple addresses. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net.NetworkInformation/IPGlobalProperties.xml b/xml/System.Net.NetworkInformation/IPGlobalProperties.xml index 5453185113c..fec98d4520e 100644 --- a/xml/System.Net.NetworkInformation/IPGlobalProperties.xml +++ b/xml/System.Net.NetworkInformation/IPGlobalProperties.xml @@ -646,6 +646,16 @@ 2.0.0.0 2.1.0.0 + + + [System.Runtime.Versioning.UnsupportedOSPlatform("illumos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("illumos")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("solaris")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("solaris")>] + + System.Net.NetworkInformation.IPGlobalProperties diff --git a/xml/System.Net.NetworkInformation/NetworkInterface.xml b/xml/System.Net.NetworkInformation/NetworkInterface.xml index 50a2507a6f2..b628811020e 100644 --- a/xml/System.Net.NetworkInformation/NetworkInterface.xml +++ b/xml/System.Net.NetworkInformation/NetworkInterface.xml @@ -203,6 +203,16 @@ System.Net + + + [System.Runtime.Versioning.UnsupportedOSPlatform("illumos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("illumos")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("solaris")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("solaris")>] + + System.Net.NetworkInformation.NetworkInterface[] @@ -407,6 +417,16 @@ System.Net + + + [System.Runtime.Versioning.UnsupportedOSPlatform("illumos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("illumos")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("solaris")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("solaris")>] + + System.Boolean diff --git a/xml/System.Net.Security/NegotiateStream.xml b/xml/System.Net.Security/NegotiateStream.xml index 0c87966e287..4c27648fb5f 100644 --- a/xml/System.Net.Security/NegotiateStream.xml +++ b/xml/System.Net.Security/NegotiateStream.xml @@ -1023,6 +1023,7 @@ The following example demonstrates calling this constructor. This code example i The authentication failed. You can use this object to retry the authentication. The authentication failed. You can use this object to retry the authentication. This object has been closed. + Windows 95 and Windows 98 are not supported. @@ -1091,6 +1092,7 @@ The following example demonstrates calling this constructor. This code example i The parameter was set to on a platform that does not support extended protection. Integrated Windows Authentication with Extended Protection + Windows 95 and Windows 98 are not supported. @@ -1167,6 +1169,7 @@ The following example demonstrates calling this constructor. This code example i -or- This stream was used previously to attempt authentication as the client. You cannot use the stream to retry authentication as the server. + Windows 95 and Windows 98 are not supported. @@ -1248,6 +1251,7 @@ The following example demonstrates calling this constructor. This code example i The parameter was set to on a platform that does not support extended protection. Integrated Windows Authentication with Extended Protection + Windows 95 and Windows 98 are not supported. @@ -1309,6 +1313,7 @@ The following example demonstrates calling this constructor. This code example i The authentication failed. You can use this object to retry the authentication. The authentication failed. You can use this object to retry the authentication. This object has been closed. + Windows 95 and Windows 98 are not supported. @@ -1370,6 +1375,7 @@ The following example demonstrates calling this constructor. This code example i The parameter was set to on a platform that does not support extended protection. Integrated Windows Authentication with Extended Protection + Windows 95 and Windows 98 are not supported. @@ -1435,6 +1441,7 @@ The following example demonstrates calling this constructor. This code example i -or- This stream was used previously to attempt authentication as the client. You cannot use the stream to retry authentication as the server. + Windows 95 and Windows 98 are not supported. @@ -1509,6 +1516,7 @@ The following example demonstrates calling this constructor. This code example i The parameter was set to on a platform that does not support extended protection. Integrated Windows Authentication with Extended Protection + Windows 95 and Windows 98 are not supported. @@ -2033,6 +2041,7 @@ The following example demonstrates calling this method to begin an asynchronous The authentication failed. You can use this object to retry the authentication. The authentication failed. You can use this object to retry the authentication. This object has been closed. + Windows 95 and Windows 98 are not supported. @@ -2106,6 +2115,7 @@ The following example demonstrates calling this method to begin an asynchronous The parameter was set to on a platform that does not support extended protection. Integrated Windows Authentication with Extended Protection + Windows 95 and Windows 98 are not supported. @@ -2190,6 +2200,7 @@ The following example demonstrates calling this method to begin an asynchronous -or- This stream was used previously to attempt authentication as the client. You cannot use the stream to retry authentication as the server. + Windows 95 and Windows 98 are not supported. @@ -2278,6 +2289,7 @@ The following example demonstrates calling this method to begin an asynchronous The parameter was set to on a platform that does not support extended protection. Integrated Windows Authentication with Extended Protection + Windows 95 and Windows 98 are not supported. @@ -4131,7 +4143,7 @@ This method reads asynchronously as much data as is available into `buffer` and A region of memory that contains the data to write to the . The token to monitor for cancellation requests. Write asynchronously the specified number of s to the underlying stream. - To be added. + A that represents the asynchronous read operation. A containing the number of bytes to read from . To be added. Write asynchronously the specified number of s to the underlying stream. - To be added. + A that represents the asynchronous read operation. To be added. + + + + + + + + Field + + System.Net.Security + 6.0.0.0 + + + netstandard + + + System.Net.Security.SslApplicationProtocol + + + Defines a instance for HTTP 3.0. + To be added. + + diff --git a/xml/System.Net.Security/SslCertificateTrust.xml b/xml/System.Net.Security/SslCertificateTrust.xml index 71435478876..e0b964aa6de 100644 --- a/xml/System.Net.Security/SslCertificateTrust.xml +++ b/xml/System.Net.Security/SslCertificateTrust.xml @@ -14,7 +14,7 @@ - To be added. + Represents a trust policy for use with SSL/TLS connections. To be added. @@ -43,11 +43,23 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The collection containing the trusted certificates. + + for the server to send a list of trusted certificate authorities during the TLS handshake; not to send the list. + Creates a new . + Represents a trust policy. + + [!WARNING] +> The list of trusted CAs increases the size of the handshake message. It could also be viewed as an information leak about the system's configuration. For these reasons, we recommend setting `sendTrustInHandshake` to `false`. + +]]> + @@ -69,11 +81,23 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The store containing the trusted certificates. + + for the server to send a list of trusted certificate authorities during the TLS handshake; not to send the list. + Creates a new . + Represents a trust policy. + + [!WARNING] +> The list of trusted CAs increases the size of the handshake message. It could also be viewed as an information leak about the system's configuration. For these reasons, we recommend setting `sendTrustInHandshake` to `false`. + +]]> + diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index aa26875468e..f0ca08d1bd7 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -1092,6 +1092,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -1161,6 +1162,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -1225,6 +1227,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -1296,6 +1299,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -1370,6 +1374,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -1968,6 +1973,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -2042,6 +2048,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -2123,6 +2130,7 @@ Authentication is already in progress. This object has been closed. + The method is not supported on Windows 95, Windows 98, or Windows Millennium. @@ -3788,10 +3796,10 @@ Authentication has not occurred. - To be added. - To be added. - To be added. - To be added. + The token to monitor for cancellation requests. + Negotiates the client certificate on the authenticated connection. + The task object representing the asynchronous operation. + You can negotiate the client certificate once authentication is successfully processed via one of the AuthenticateAs... methods. diff --git a/xml/System.Net.Security/SslStreamCertificateContext.xml b/xml/System.Net.Security/SslStreamCertificateContext.xml index ffc155f4ede..aadae3bd96f 100644 --- a/xml/System.Net.Security/SslStreamCertificateContext.xml +++ b/xml/System.Net.Security/SslStreamCertificateContext.xml @@ -65,7 +65,7 @@ The can be used across mu to indicate that the missing certificates can be downloaded from the network; to indicate that only available X509Certificate stores should be searched for missing certificates. Attempts to build the certificate chain from the provided certificates. The certificate context with the newly created certificate chain. - To be added. + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The server certificate. + Supplementary certificates used to build the certificate chain. + + to indicate that the missing certificates can be downloaded from the network; to indicate that only available X509Certificate stores should be searched for missing certificates. + An optional trust policy, to replace the default system trust. + Attempts to build the certificate chain from the provided certificates. + The certificate context with the newly created certificate chain. + + . + +> [!IMPORTANT] +> The target certificate must include a private key. + +]]> + + doesn't have an associated private key. diff --git a/xml/System.Net.Sockets/NetworkStream.xml b/xml/System.Net.Sockets/NetworkStream.xml index 2baf276d720..761f69a8dc5 100644 --- a/xml/System.Net.Sockets/NetworkStream.xml +++ b/xml/System.Net.Sockets/NetworkStream.xml @@ -410,7 +410,7 @@ An array of type that is the location in memory to store data read from the . The location in to begin storing the data. The number of bytes to read from the . - To be added. + The number of bytes to read from the . The delegate that is executed when completes. An object that contains any additional user-defined data. Begins an asynchronous read from the . @@ -519,7 +519,7 @@ An array of type that contains the data to write to the . The location in to begin sending the data. The number of bytes to write to the . - To be added. + The number of bytes to write to the . The delegate that is executed when completes. An object that contains any additional user-defined data. Begins an asynchronous write to a stream. @@ -1485,7 +1485,7 @@ There is a failure reading from the network. An array of type that is the location in memory to store data read from the . The location in to begin storing the data to. The number of bytes to read from the . - To be added. + The number of bytes to read from the . Reads data from the and stores it to a byte array. The number of bytes read from the . @@ -1703,7 +1703,7 @@ There is a failure reading from the network. The location in to begin storing the data to. The number of bytes to read from the . The token to monitor for cancellation requests. - To be added. + The number of bytes to read from the . Reads data from the and stores it to a specified range of a byte array as an asynchronous operation. A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into . @@ -2123,7 +2123,7 @@ There was a failure while writing to the network. An array of type that contains the data to write to the . The location in from which to start writing data. The number of bytes to write to the . - To be added. + The number of bytes to write to the . Writes data to the from a specified range of a byte array. The location in from which to start writing data. The number of bytes to write to the . The token to monitor for cancellation requests. - To be added. + The number of bytes to write to the . Writes data to the from the specified range of a byte array as an asynchronous operation. A task that represents the asynchronous write operation. diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index f90734af744..d59b6d77ef8 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -12965,10 +12965,14 @@ The System.Net - + [System.Obsolete("SupportsIPv4 is obsoleted for this type, please use OSSupportsIPv4 instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("SupportsIPv4 is obsoleted for this type, please use OSSupportsIPv4 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SupportsIPv4 has been deprecated. Use OSSupportsIPv4 instead.")] + [<System.Obsolete("SupportsIPv4 has been deprecated. Use OSSupportsIPv4 instead.")>] + [System.Obsolete("SupportsIPv4 is obsoleted for this type, please use OSSupportsIPv4 instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("SupportsIPv4 is obsoleted for this type, please use OSSupportsIPv4 instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -13028,10 +13032,14 @@ The System.Net - + [System.Obsolete("SupportsIPv6 is obsoleted for this type, please use OSSupportsIPv6 instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("SupportsIPv6 is obsoleted for this type, please use OSSupportsIPv6 instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SupportsIPv6 has been deprecated. Use OSSupportsIPv6 instead.")] + [<System.Obsolete("SupportsIPv6 has been deprecated. Use OSSupportsIPv6 instead.")>] + [System.Obsolete("SupportsIPv6 is obsoleted for this type, please use OSSupportsIPv6 instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("SupportsIPv6 is obsoleted for this type, please use OSSupportsIPv6 instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -13205,8 +13213,8 @@ Call IDisposable.Dispose when you are finished using the [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - [System.Obsolete("This property has no effect in .NET 5+ and .NET Core.")] - [<System.Obsolete("This property has no effect in .NET 5+ and .NET Core.")>] + [System.Obsolete("UseOnlyOverlappedIO has been deprecated and is not supported.")] + [<System.Obsolete("UseOnlyOverlappedIO has been deprecated and is not supported.")>] [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] diff --git a/xml/System.Net.Sockets/SocketInformationOptions.xml b/xml/System.Net.Sockets/SocketInformationOptions.xml index 2bc983067d1..5e040d05e2c 100644 --- a/xml/System.Net.Sockets/SocketInformationOptions.xml +++ b/xml/System.Net.Sockets/SocketInformationOptions.xml @@ -180,8 +180,8 @@ [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - [System.Obsolete("This flag has no effect in .NET 5+ and .NET Core.")] - [<System.Obsolete("This flag has no effect in .NET 5+ and .NET Core.")>] + [System.Obsolete("SocketInformationOptions.UseOnlyOverlappedIO has been deprecated and is not supported.")] + [<System.Obsolete("SocketInformationOptions.UseOnlyOverlappedIO has been deprecated and is not supported.")>] diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 453f90f8671..314ce4f1beb 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -104,10 +104,14 @@ 6.0.0.0 - + [System.Obsolete("This method has been deprecated. Please use TcpListener(IPAddress localaddr, int port) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use TcpListener(IPAddress localaddr, int port) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated. Use TcpListener(IPAddress localaddr, int port) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use TcpListener(IPAddress localaddr, int port) instead.")>] + [System.Obsolete("This method has been deprecated. Please use TcpListener(IPAddress localaddr, int port) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use TcpListener(IPAddress localaddr, int port) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index bcb28f30d06..b23c63a8bb0 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -820,6 +820,10 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.")] + [<System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.")>] + [System.MonoTODO] [<System.MonoTODO>] @@ -954,12 +958,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The buffer to be sent over the connection. + One of the enumeration values that indicates whether the application is sending a binary or text message. + Flags for controlling how the should send a message. + The cancellation token to use to cancel the send operation. + Sends data over the connection asynchronously. + The task object representing the asynchronous operation. To be added. diff --git a/xml/System.Net.WebSockets/WebSocketCreationOptions.xml b/xml/System.Net.WebSockets/WebSocketCreationOptions.xml index 4bc2b02d9ff..76ddb03d8a9 100644 --- a/xml/System.Net.WebSockets/WebSocketCreationOptions.xml +++ b/xml/System.Net.WebSockets/WebSocketCreationOptions.xml @@ -31,7 +31,7 @@ - To be added. + Creates an instance of the class. To be added. diff --git a/xml/System.Net.WebSockets/WebSocketDeflateOptions.xml b/xml/System.Net.WebSockets/WebSocketDeflateOptions.xml index aac6e515f68..3c347870120 100644 --- a/xml/System.Net.WebSockets/WebSocketDeflateOptions.xml +++ b/xml/System.Net.WebSockets/WebSocketDeflateOptions.xml @@ -39,7 +39,7 @@ Although the WebSocket spec allows window bits from 8 to 15, the current impleme - To be added. + Creates an instance of the class. To be added. diff --git a/xml/System.Net/Dns.xml b/xml/System.Net/Dns.xml index 9c8ec71bf67..0da6b1f86a8 100644 --- a/xml/System.Net/Dns.xml +++ b/xml/System.Net/Dns.xml @@ -161,10 +161,14 @@ 6.0.0.0 - + [System.Obsolete("BeginGetHostByName is obsoleted for this type, please use BeginGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("BeginGetHostByName is obsoleted for this type, please use BeginGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("BeginGetHostByName has been deprecated. Use BeginGetHostEntry instead.")] + [<System.Obsolete("BeginGetHostByName has been deprecated. Use BeginGetHostEntry instead.")>] + [System.Obsolete("BeginGetHostByName is obsoleted for this type, please use BeginGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("BeginGetHostByName is obsoleted for this type, please use BeginGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -398,10 +402,14 @@ 6.0.0.0 - + [System.Obsolete("BeginResolve is obsoleted for this type, please use BeginGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("BeginResolve is obsoleted for this type, please use BeginGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("BeginResolve has been deprecated. Use BeginGetHostEntry instead.")] + [<System.Obsolete("BeginResolve has been deprecated. Use BeginGetHostEntry instead.")>] + [System.Obsolete("BeginResolve is obsoleted for this type, please use BeginGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("BeginResolve is obsoleted for this type, please use BeginGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -536,10 +544,14 @@ 6.0.0.0 - + [System.Obsolete("EndGetHostByName is obsoleted for this type, please use EndGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("EndGetHostByName is obsoleted for this type, please use EndGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("EndGetHostByName has been deprecated. Use EndGetHostEntry instead.")] + [<System.Obsolete("EndGetHostByName has been deprecated. Use EndGetHostEntry instead.")>] + [System.Obsolete("EndGetHostByName is obsoleted for this type, please use EndGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("EndGetHostByName is obsoleted for this type, please use EndGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -664,10 +676,14 @@ 6.0.0.0 - + [System.Obsolete("EndResolve is obsoleted for this type, please use EndGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("EndResolve is obsoleted for this type, please use EndGetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("EndResolve has been deprecated. Use EndGetHostEntry instead.")] + [<System.Obsolete("EndResolve has been deprecated. Use EndGetHostEntry instead.")>] + [System.Obsolete("EndResolve is obsoleted for this type, please use EndGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("EndResolve is obsoleted for this type, please use EndGetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -972,10 +988,14 @@ 6.0.0.0 - + [System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("GetHostByAddress has been deprecated. Use GetHostEntry instead.")] + [<System.Obsolete("GetHostByAddress has been deprecated. Use GetHostEntry instead.")>] + [System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1048,10 +1068,14 @@ 6.0.0.0 - + [System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("GetHostByAddress has been deprecated. Use GetHostEntry instead.")] + [<System.Obsolete("GetHostByAddress has been deprecated. Use GetHostEntry instead.")>] + [System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("GetHostByAddress is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1117,10 +1141,14 @@ 6.0.0.0 - + [System.Obsolete("GetHostByName is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("GetHostByName is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("GetHostByName has been deprecated. Use GetHostEntry instead.")] + [<System.Obsolete("GetHostByName has been deprecated. Use GetHostEntry instead.")>] + [System.Obsolete("GetHostByName is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("GetHostByName is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1657,10 +1685,14 @@ 6.0.0.0 - + [System.Obsolete("Resolve is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Resolve is obsoleted for this type, please use GetHostEntry instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Resolve has been deprecated. Use GetHostEntry instead.")] + [<System.Obsolete("Resolve has been deprecated. Use GetHostEntry instead.")>] + [System.Obsolete("Resolve is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Resolve is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net/FileWebRequest.xml b/xml/System.Net/FileWebRequest.xml index 74000101fc9..42e1fe2d14c 100644 --- a/xml/System.Net/FileWebRequest.xml +++ b/xml/System.Net/FileWebRequest.xml @@ -106,10 +106,14 @@ 6.0.0.0 - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for FileWebRequest.")] + [<System.Obsolete("Serialization has been deprecated for FileWebRequest.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net/FileWebResponse.xml b/xml/System.Net/FileWebResponse.xml index 9c1275d8661..c23d071a06f 100644 --- a/xml/System.Net/FileWebResponse.xml +++ b/xml/System.Net/FileWebResponse.xml @@ -102,10 +102,14 @@ 6.0.0.0 - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for FileWebResponse.")] + [<System.Obsolete("Serialization has been deprecated for FileWebResponse.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net/GlobalProxySelection.xml b/xml/System.Net/GlobalProxySelection.xml index 21aa0c459c8..b9ef47a6737 100644 --- a/xml/System.Net/GlobalProxySelection.xml +++ b/xml/System.Net/GlobalProxySelection.xml @@ -34,10 +34,14 @@ - + [System.Obsolete("This class has been deprecated. Please use WebRequest.DefaultWebProxy instead to access and set the global default proxy. Use 'null' instead of GetEmptyWebProxy. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Please use WebRequest.DefaultWebProxy instead to access and set the global default proxy. Use 'null' instead of GetEmptyWebProxy. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("GlobalProxySelection has been deprecated. Use WebRequest.DefaultWebProxy instead to access and set the global default proxy. Use 'null' instead of GetEmptyWebProxy.")] + [<System.Obsolete("GlobalProxySelection has been deprecated. Use WebRequest.DefaultWebProxy instead to access and set the global default proxy. Use 'null' instead of GetEmptyWebProxy.")>] + [System.Obsolete("This class has been deprecated. Please use WebRequest.DefaultWebProxy instead to access and set the global default proxy. Use 'null' instead of GetEmptyWebProxy. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This class has been deprecated. Please use WebRequest.DefaultWebProxy instead to access and set the global default proxy. Use 'null' instead of GetEmptyWebProxy. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net/HttpWebRequest.xml b/xml/System.Net/HttpWebRequest.xml index a3d2a1b3a92..6f1006019c3 100644 --- a/xml/System.Net/HttpWebRequest.xml +++ b/xml/System.Net/HttpWebRequest.xml @@ -262,8 +262,8 @@ Both constructors are obsolete and should not b [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete. Use HttpClient instead.", DiagnosticId="SYSLIB0014", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete. Use HttpClient instead.", DiagnosticId="SYSLIB0014", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete. Use HttpClient instead", DiagnosticId="SYSLIB0014", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete. Use HttpClient instead", DiagnosticId="SYSLIB0014", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -2834,10 +2834,14 @@ The GetHashCode method returns a hash code of the web request. This value can be System.Net - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for HttpWebRequest.")] + [<System.Obsolete("Serialization has been deprecated for HttpWebRequest.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -4540,10 +4544,14 @@ The GetHashCode method returns a hash code of the web request. This value can be System.Net - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for HttpWebRequest.")] + [<System.Obsolete("Serialization has been deprecated for HttpWebRequest.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -4866,7 +4874,7 @@ The GetHashCode method returns a hash code of the web request. This value can be ## Remarks -The value for this property is stored in . If WebHeaderCollection is set, the property value is lost. +The value for this property is stored in . If `WebHeaderCollection` is set, the property value is lost. ## Examples The following code example sets the property. diff --git a/xml/System.Net/HttpWebResponse.xml b/xml/System.Net/HttpWebResponse.xml index d1aad05f881..457747a750f 100644 --- a/xml/System.Net/HttpWebResponse.xml +++ b/xml/System.Net/HttpWebResponse.xml @@ -202,10 +202,14 @@ The contents of the response from the Internet resource are returned as a System.Net - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for HttpWebResponse.")] + [<System.Obsolete("Serialization has been deprecated for HttpWebResponse.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -733,10 +737,14 @@ The GetHashCode method returns a hash code of the web response instance. This va System.Net - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for HttpWebResponse.")] + [<System.Obsolete("Serialization has been deprecated for HttpWebResponse.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1549,10 +1557,14 @@ Call `Dispose` when you are finished using the System.Net - + [System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Serialization has been deprecated for HttpWebResponse.")] + [<System.Obsolete("Serialization has been deprecated for HttpWebResponse.")>] + [System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Serialization is obsoleted for this type. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net/IPAddress.xml b/xml/System.Net/IPAddress.xml index ce58dc17793..75edd331706 100644 --- a/xml/System.Net/IPAddress.xml +++ b/xml/System.Net/IPAddress.xml @@ -376,10 +376,14 @@ System.Net - + [System.Obsolete("This property has been deprecated. It is address family dependent. Please use IPAddress.Equals method to perform comparisons. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. It is address family dependent. Please use IPAddress.Equals method to perform comparisons. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("IPAddress.Address is address family dependent and has been deprecated. Use IPAddress.Equals to perform comparisons.")] + [<System.Obsolete("IPAddress.Address is address family dependent and has been deprecated. Use IPAddress.Equals to perform comparisons.")>] + [System.Obsolete("This property has been deprecated. It is address family dependent. Please use IPAddress.Equals method to perform comparisons. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. It is address family dependent. Please use IPAddress.Equals method to perform comparisons. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -2173,6 +2177,8 @@ ]]> + + is . diff --git a/xml/System.Net/SecurityProtocolType.xml b/xml/System.Net/SecurityProtocolType.xml index dea1ba0674c..c06776782b7 100644 --- a/xml/System.Net/SecurityProtocolType.xml +++ b/xml/System.Net/SecurityProtocolType.xml @@ -82,10 +82,14 @@ The Transport Layer Security (TLS) protocols assume that a connection-oriented p 6.0.0.0 - + [System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SecurityProtocolType.Ssl3 has been deprecated and is not supported.")] + [<System.Obsolete("SecurityProtocolType.Ssl3 has been deprecated and is not supported.")>] + [System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Net/WebProxy.xml b/xml/System.Net/WebProxy.xml index fefcece6d3c..f67a415798a 100644 --- a/xml/System.Net/WebProxy.xml +++ b/xml/System.Net/WebProxy.xml @@ -1070,10 +1070,14 @@ 6.0.0.0 - + [System.Obsolete("This method has been deprecated. Please use the proxy selected for you by default. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use the proxy selected for you by default. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("WebProxy.GetDefaultProxy has been deprecated. Use the proxy selected for you by default.")] + [<System.Obsolete("WebProxy.GetDefaultProxy has been deprecated. Use the proxy selected for you by default.")>] + [System.Obsolete("This method has been deprecated. Please use the proxy selected for you by default. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use the proxy selected for you by default. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Reflection.Context/CustomReflectionContext.xml b/xml/System.Reflection.Context/CustomReflectionContext.xml index 798cb4c48ec..57414818927 100644 --- a/xml/System.Reflection.Context/CustomReflectionContext.xml +++ b/xml/System.Reflection.Context/CustomReflectionContext.xml @@ -9,6 +9,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Reflection.ReflectionContext @@ -71,6 +72,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 @@ -90,6 +92,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 @@ -104,17 +107,22 @@ - + - + Method System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 + + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Reflection.Context.CustomReflectionContext+<AddProperties>d__7))] + [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Reflection.Context.CustomReflectionContext+<AddProperties>d__7))>] + [System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Reflection.Context.CustomReflectionContext+<AddProperties>d__1))] [<System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Reflection.Context.CustomReflectionContext+<AddProperties>d__1))>] @@ -168,6 +176,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Reflection.PropertyInfo @@ -209,6 +218,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Reflection.PropertyInfo @@ -264,6 +274,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Collections.Generic.IEnumerable<System.Object> @@ -292,6 +303,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Collections.Generic.IEnumerable<System.Object> @@ -320,6 +332,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Reflection.Assembly @@ -346,6 +359,7 @@ System.Reflection.Context 2.0.5.0 4.0.0.0 + 4.0.3.0 System.Reflection.TypeInfo diff --git a/xml/System.Reflection.Emit/AssemblyBuilder.xml b/xml/System.Reflection.Emit/AssemblyBuilder.xml index 239bb1c11d7..a3f4fa42895 100644 --- a/xml/System.Reflection.Emit/AssemblyBuilder.xml +++ b/xml/System.Reflection.Emit/AssemblyBuilder.xml @@ -1725,6 +1725,10 @@ netstandard + + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] @@ -1778,6 +1782,10 @@ netstandard + + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] diff --git a/xml/System.Reflection.Emit/FlowControl.xml b/xml/System.Reflection.Emit/FlowControl.xml index 9961cd6063e..840e09fd477 100644 --- a/xml/System.Reflection.Emit/FlowControl.xml +++ b/xml/System.Reflection.Emit/FlowControl.xml @@ -308,10 +308,14 @@ 6.0.0.0 - + [System.Obsolete("This API has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("FlowControl.Phi has been deprecated and is not supported.")] + [<System.Obsolete("FlowControl.Phi has been deprecated and is not supported.")>] + [System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml b/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml index cd90598e311..95dd6e34cae 100644 --- a/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml +++ b/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml @@ -3085,6 +3085,12 @@ netstandard 2.1.0.0 + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")>] + + System.Type diff --git a/xml/System.Reflection.Emit/MethodBuilder.xml b/xml/System.Reflection.Emit/MethodBuilder.xml index 9455f423026..a3cfeb023b3 100644 --- a/xml/System.Reflection.Emit/MethodBuilder.xml +++ b/xml/System.Reflection.Emit/MethodBuilder.xml @@ -1680,6 +1680,12 @@ netstandard 2.1.0.0 + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")>] + + System.Reflection.MethodInfo diff --git a/xml/System.Reflection.Emit/ModuleBuilder.xml b/xml/System.Reflection.Emit/ModuleBuilder.xml index 3775c278de2..62696f55f1b 100644 --- a/xml/System.Reflection.Emit/ModuleBuilder.xml +++ b/xml/System.Reflection.Emit/ModuleBuilder.xml @@ -808,6 +808,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] @@ -902,6 +906,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] diff --git a/xml/System.Reflection.Emit/OpCodeType.xml b/xml/System.Reflection.Emit/OpCodeType.xml index 35e70d69418..94e250fd5ac 100644 --- a/xml/System.Reflection.Emit/OpCodeType.xml +++ b/xml/System.Reflection.Emit/OpCodeType.xml @@ -80,10 +80,14 @@ 6.0.0.0 - + [System.Obsolete("This API has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("OpCodeType.Annotation has been deprecated and is not supported.")] + [<System.Obsolete("OpCodeType.Annotation has been deprecated and is not supported.")>] + [System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Reflection.Emit/OperandType.xml b/xml/System.Reflection.Emit/OperandType.xml index c92983fefe1..9fd3ae832f3 100644 --- a/xml/System.Reflection.Emit/OperandType.xml +++ b/xml/System.Reflection.Emit/OperandType.xml @@ -308,10 +308,14 @@ 6.0.0.0 - + [System.Obsolete("This API has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("OperandType.InlinePhi has been deprecated and is not supported.")] + [<System.Obsolete("OperandType.InlinePhi has been deprecated and is not supported.")>] + [System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Reflection.Emit/TypeBuilder.xml b/xml/System.Reflection.Emit/TypeBuilder.xml index 9fd1638e0ba..1b53b02bc43 100644 --- a/xml/System.Reflection.Emit/TypeBuilder.xml +++ b/xml/System.Reflection.Emit/TypeBuilder.xml @@ -2412,6 +2412,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] @@ -2515,6 +2519,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] @@ -2619,6 +2627,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("P/Invoke marshalling may dynamically access members that could be trimmed.")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] @@ -6322,6 +6334,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] diff --git a/xml/System.Reflection.Metadata/AssemblyExtensions.xml b/xml/System.Reflection.Metadata/AssemblyExtensions.xml index 8ab2357f261..34ffae23d5d 100644 --- a/xml/System.Reflection.Metadata/AssemblyExtensions.xml +++ b/xml/System.Reflection.Metadata/AssemblyExtensions.xml @@ -28,38 +28,6 @@ To be added. - - - - - - - - Method - - System.Runtime.Loader - 6.0.0.0 - - - System.Void - - - - - - - - - The assembly to update. - The metadata changes to be applied. - The IL changes to be applied. - The PDB changes to be applied. - Updates the specified assembly using the provided metadata, IL and PDB deltas. - Currently executing methods will continue to use the existing IL. New executions of modified methods will use the new IL. Different runtimes may have different limitations on what kinds of changes are supported, and runtimes make no guarantees as to the state of the assembly and process if the delta includes unsupported changes. - The assembly argument is null. - The update could not be applied. - - diff --git a/xml/System.Reflection.Metadata/MetadataUpdateHandlerAttribute.xml b/xml/System.Reflection.Metadata/MetadataUpdateHandlerAttribute.xml index bc0a934528a..9e27664faac 100644 --- a/xml/System.Reflection.Metadata/MetadataUpdateHandlerAttribute.xml +++ b/xml/System.Reflection.Metadata/MetadataUpdateHandlerAttribute.xml @@ -20,8 +20,20 @@ - To be added. - To be added. + Indicates that a type that should receive notifications of metadata updates. + + specified by this attribute should implement static methods matching the signature of one or more of the following (visibility of the methods does not matter): + - `static void ClearCache(Type[]? updatedTypes)` + - `static void UpdateApplication(Type[]? updatedTypes)` + +After a metadata update is applied, `ClearCache` is invoked for every handler that specifies one. This gives update handlers an opportunity to clear any caches that are inferred based on the application's metadata. After all `ClearCache` methods have been invoked, `UpdateApplication` is invoked for every handler that specifies one. This enables applications to refresh the application state, trigger a UI re-render, or other such reactions. When specified, the `updatedTypes` parameter contains the set of types that were affected by the metadata update; if it's `null`, any type may have been updated. + + ]]> + @@ -47,8 +59,8 @@ - To be added. - To be added. + A type that handles metadata updates and that should be notified when any occur. + Initializes the attribute. To be added. @@ -74,7 +86,7 @@ System.Type - To be added. + Gets the type that handles metadata updates and that should be notified when any occur. To be added. To be added. diff --git a/xml/System.Reflection.Metadata/MetadataUpdater.xml b/xml/System.Reflection.Metadata/MetadataUpdater.xml index 0a83755e1b8..e23316cf57f 100644 --- a/xml/System.Reflection.Metadata/MetadataUpdater.xml +++ b/xml/System.Reflection.Metadata/MetadataUpdater.xml @@ -40,12 +40,24 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The assembly to update. + The metadata changes to be applied. + The IL changes to be applied. + The PDB changes to be applied. + Updates the specified assembly using the provided metadata, IL, and PDB deltas. + + + + The assembly argument is not a runtime assembly. + The assembly argument is . + The assembly is not editable. + The update could not be applied. @@ -64,8 +76,9 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates whether the assembly update is enabled and available. + + if the assembly update is enabled and available; otherwise, . To be added. diff --git a/xml/System.Reflection/Assembly.xml b/xml/System.Reflection/Assembly.xml index 13879fefbc6..5b48df4b486 100644 --- a/xml/System.Reflection/Assembly.xml +++ b/xml/System.Reflection/Assembly.xml @@ -233,13 +233,17 @@ 6.0.0.0 - + [System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location instead.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location instead.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("The code will throw for assemblies embedded in a single-file app")] - [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("The code will throw for assemblies embedded in a single-file app")>] + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] + + + [System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -877,13 +881,17 @@ In .NET 5.0 and later versions, for bundled assemblies, this property throws an System.Reflection - + [System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location instead.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location instead.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("The code will throw for assemblies embedded in a single-file app")] - [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("The code will throw for assemblies embedded in a single-file app")>] + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] + + + [System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location.", DiagnosticId="SYSLIB0012", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [get: System.Security.SecuritySafeCritical] @@ -1638,6 +1646,12 @@ In .NET 5.0 and later versions, for bundled assemblies, this property throws an System.Reflection + + + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] + + System.IO.FileStream @@ -1715,8 +1729,8 @@ In .NET 5.0 and later versions, for bundled assemblies, this method throws an ex - [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("The code will throw for assemblies embedded in a single-file app")] - [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("The code will throw for assemblies embedded in a single-file app")>] + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] @@ -1775,6 +1789,12 @@ In .NET 5.0 and later versions, for bundled assemblies, this method throws an ex System.Reflection + + + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")>] + + System.IO.FileStream[] @@ -5242,10 +5262,14 @@ The ability to execute code in remote assemblies is disabled. See + [System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Assembly.LoadWithPartialName has been deprecated. Use Assembly.Load() instead.")] + [<System.Obsolete("Assembly.LoadWithPartialName has been deprecated. Use Assembly.Load() instead.")>] + [System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Reflection/AssemblyFlagsAttribute.xml b/xml/System.Reflection/AssemblyFlagsAttribute.xml index 3e871cbb84e..ef457d03cd2 100644 --- a/xml/System.Reflection/AssemblyFlagsAttribute.xml +++ b/xml/System.Reflection/AssemblyFlagsAttribute.xml @@ -119,10 +119,14 @@ 6.0.0.0 - + [System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated. Use AssemblyFlagsAttribute(AssemblyNameFlags) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use AssemblyFlagsAttribute(AssemblyNameFlags) instead.")>] + [System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -229,10 +233,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated. Use AssemblyFlagsAttribute(AssemblyNameFlags) instead.")] + [<System.Obsolete("This constructor has been deprecated. Use AssemblyFlagsAttribute(AssemblyNameFlags) instead.")>] + [System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor has been deprecated. Please use AssemblyFlagsAttribute(AssemblyNameFlags) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -346,10 +354,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("This property has been deprecated. Please use AssemblyFlags instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use AssemblyFlags instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AssemblyFlagsAttribute.Flags has been deprecated. Use AssemblyFlags instead.")] + [<System.Obsolete("AssemblyFlagsAttribute.Flags has been deprecated. Use AssemblyFlags instead.")>] + [System.Obsolete("This property has been deprecated. Please use AssemblyFlags instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use AssemblyFlags instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Reflection/MethodInfo.xml b/xml/System.Reflection/MethodInfo.xml index d8b08e89bc7..92a1f96bfb8 100644 --- a/xml/System.Reflection/MethodInfo.xml +++ b/xml/System.Reflection/MethodInfo.xml @@ -1039,6 +1039,12 @@ Console::WriteLine("\tIs this a generic method definition? {0}", 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")>] + + System.Reflection.MethodInfo diff --git a/xml/System.Reflection/Module.xml b/xml/System.Reflection/Module.xml index 07cbd27484b..3ae6436f4c2 100644 --- a/xml/System.Reflection/Module.xml +++ b/xml/System.Reflection/Module.xml @@ -534,6 +534,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("Returns <Unknown> for modules with no file path")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("Returns <Unknown> for modules with no file path")>] + + System.String @@ -2266,6 +2272,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("Returns <Unknown> for modules with no file path")] + [<System.Diagnostics.CodeAnalysis.RequiresAssemblyFiles("Returns <Unknown> for modules with no file path")>] + + System.String diff --git a/xml/System.Reflection/NullabilityInfo.xml b/xml/System.Reflection/NullabilityInfo.xml index 280366e2ebb..8558d480923 100644 --- a/xml/System.Reflection/NullabilityInfo.xml +++ b/xml/System.Reflection/NullabilityInfo.xml @@ -14,7 +14,7 @@ - To be added. + Represents nullability information. To be added. @@ -34,8 +34,8 @@ System.Reflection.NullabilityInfo - To be added. - To be added. + Gets the nullability information for the element type of the array. + If the member type is an array, the of the elements of the array; otherwise, . To be added. @@ -55,8 +55,8 @@ System.Reflection.NullabilityInfo[] - To be added. - To be added. + Gets the nullability information for each type parameter. + If the member type is a generic type, the nullability information for each type parameter. To be added. @@ -76,7 +76,7 @@ System.Reflection.NullabilityState - To be added. + Gets the nullability read state of the member. To be added. To be added. @@ -97,7 +97,7 @@ System.Type - To be added. + Gets the type of the member or generic parameter to which this instance belongs. To be added. To be added. @@ -118,7 +118,7 @@ System.Reflection.NullabilityState - To be added. + Gets the nullability write state of the member. To be added. To be added. diff --git a/xml/System.Reflection/NullabilityInfoContext.xml b/xml/System.Reflection/NullabilityInfoContext.xml index 550e40790c6..4054a28f2d1 100644 --- a/xml/System.Reflection/NullabilityInfoContext.xml +++ b/xml/System.Reflection/NullabilityInfoContext.xml @@ -14,7 +14,7 @@ - To be added. + Provides APIs for populating nullability information and context from reflection members: , , , and . To be added. @@ -31,7 +31,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -47,12 +47,6 @@ System.Runtime 6.0.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")>] - - System.Reflection.NullabilityInfo @@ -60,10 +54,12 @@ - To be added. - To be added. - To be added. + The event for which to populate nullability information. + Populates a for the given . If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the state. + A instance. To be added. + + is . @@ -78,12 +74,6 @@ System.Runtime 6.0.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")>] - - System.Reflection.NullabilityInfo @@ -91,10 +81,12 @@ - To be added. - To be added. - To be added. + The field for which to populate the nullability information. + Populates a for the given . If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the state. + A instance. To be added. + + is . @@ -109,12 +101,6 @@ System.Runtime 6.0.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")>] - - System.Reflection.NullabilityInfo @@ -122,10 +108,12 @@ - To be added. - To be added. - To be added. + The parameter for which to populate the nullability information. + Populates a for the given . If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the state. + A instance. To be added. + + is . @@ -140,12 +128,6 @@ System.Runtime 6.0.0.0 - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("By default nullability attributes are trimmed by the trimmer")>] - - System.Reflection.NullabilityInfo @@ -153,10 +135,12 @@ - To be added. - To be added. - To be added. + The property for which to populate the nullability information. + Populates a for the given . If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the state. + A instance. To be added. + + is . diff --git a/xml/System.Reflection/NullabilityState.xml b/xml/System.Reflection/NullabilityState.xml index 7da1d89c239..83a1e9bcde1 100644 --- a/xml/System.Reflection/NullabilityState.xml +++ b/xml/System.Reflection/NullabilityState.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Describes nullability states. To be added. @@ -34,7 +34,7 @@ 1 - To be added. + Non-nullable value or reference type. @@ -54,7 +54,7 @@ 2 - To be added. + Nullable value or reference type. @@ -74,7 +74,7 @@ 0 - To be added. + Nullability context not enabled (oblivious). diff --git a/xml/System.Resources.Extensions/DeserializingResourceReader.xml b/xml/System.Resources.Extensions/DeserializingResourceReader.xml index 2eede5908f2..570739df54e 100644 --- a/xml/System.Resources.Extensions/DeserializingResourceReader.xml +++ b/xml/System.Resources.Extensions/DeserializingResourceReader.xml @@ -3,11 +3,11 @@ - + - + System.Resources.Extensions diff --git a/xml/System.Resources.Extensions/PreserializedResourceWriter.xml b/xml/System.Resources.Extensions/PreserializedResourceWriter.xml index 3feabe8833d..edd7c77056b 100644 --- a/xml/System.Resources.Extensions/PreserializedResourceWriter.xml +++ b/xml/System.Resources.Extensions/PreserializedResourceWriter.xml @@ -3,9 +3,9 @@ - + - + System.Resources.Extensions 4.0.0.0 diff --git a/xml/System.Runtime.CompilerServices/CreateNewOnMetadataUpdateAttribute.xml b/xml/System.Runtime.CompilerServices/CreateNewOnMetadataUpdateAttribute.xml index cada3f58825..078f333b019 100644 --- a/xml/System.Runtime.CompilerServices/CreateNewOnMetadataUpdateAttribute.xml +++ b/xml/System.Runtime.CompilerServices/CreateNewOnMetadataUpdateAttribute.xml @@ -37,7 +37,7 @@ - To be added. + Creates a new instance. To be added. diff --git a/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml b/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml index 89df59d1ae1..12923b91c3e 100644 --- a/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml +++ b/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml @@ -675,10 +675,14 @@ 2.1.0.0 - + [System.Obsolete("OffsetToStringData is obsolete. Use string.GetPinnableReference() instead.")] [<System.Obsolete("OffsetToStringData is obsolete. Use string.GetPinnableReference() instead.")>] + + [System.Obsolete("OffsetToStringData has been deprecated. Use string.GetPinnableReference() instead.")] + [<System.Obsolete("OffsetToStringData has been deprecated. Use string.GetPinnableReference() instead.")>] + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] @@ -1160,6 +1164,10 @@ 2.1.0.0 + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Trimmer can't guarantee existence of class constructor")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Trimmer can't guarantee existence of class constructor")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] diff --git a/xml/System.Runtime.ExceptionServices/HandleProcessCorruptedStateExceptionsAttribute.xml b/xml/System.Runtime.ExceptionServices/HandleProcessCorruptedStateExceptionsAttribute.xml index 1356c7de7da..29176a08d32 100644 --- a/xml/System.Runtime.ExceptionServices/HandleProcessCorruptedStateExceptionsAttribute.xml +++ b/xml/System.Runtime.ExceptionServices/HandleProcessCorruptedStateExceptionsAttribute.xml @@ -37,6 +37,10 @@ [System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)] [<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>] + + [System.Obsolete("Recovery from corrupted process state exceptions is not supported; HandleProcessCorruptedStateExceptionsAttribute is ignored.", DiagnosticId="SYSLIB0032", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Recovery from corrupted process state exceptions is not supported; HandleProcessCorruptedStateExceptionsAttribute is ignored.", DiagnosticId="SYSLIB0032", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + Enables managed code to handle exceptions that indicate a corrupted process state. diff --git a/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml b/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml index 13678d1f52e..25aef008241 100644 --- a/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml +++ b/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml @@ -25,7 +25,7 @@ Last managed method. Context provided to the returned function pointer. Handler for unhandled Exceptions crossing the managed -> native boundary (that is, Reverse P/Invoke). - To be added. + Exception propagation callback. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Called when tracking begins and ends. + Called to determine if a managed object instance is referenced elsewhere, and must not be collected by the GC. + Called when a tracked object enters the finalization queue. + Handler for the propagation of unhandled Exceptions across a managed -> native boundary (that is, Reverse P/Invoke). + Initialize the Objective-C marshalling API. + +All unmanaged function pointers must be written in native code since they will be called by the GC and +managed code is not able to run at that time. + +The will be called when reference tracking begins and ends. +The associated begin/end pair will never be nested. When using Workstation GC, the begin/end pair +will be called on the same thread. When using Server GC, the begin/end pair is not guaranteed to +be called on the same thread. + +The should return 0 for not reference or 1 for +referenced. Any other value has undefined behavior. + diff --git a/xml/System.Runtime.InteropServices/Architecture.xml b/xml/System.Runtime.InteropServices/Architecture.xml index cd35f21cf2b..aa376a4cf61 100644 --- a/xml/System.Runtime.InteropServices/Architecture.xml +++ b/xml/System.Runtime.InteropServices/Architecture.xml @@ -142,7 +142,7 @@ 5 - To be added. + The S390x platform architecture. diff --git a/xml/System.Runtime.InteropServices/CollectionsMarshal.xml b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml index c273119809f..aef0125674e 100644 --- a/xml/System.Runtime.InteropServices/CollectionsMarshal.xml +++ b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml @@ -75,13 +75,13 @@ - To be added. - To be added. + The type of a key. + The type of a value. The dictionary to get the reference to from. The key used for lookup. When this method returns, contains if already existed in the dictionary, and if a new entry was added. Gets a reference to a in the specified dictionary, adding a new entry with a default value if the key does not exist. - To be added. + A reference to a in the specified dictionary. - To be added. - To be added. + The type of a key. + The type of a value. The dictionary to get the ref to from. The key used for lookup. - Gets either a ref to a in the or a ref if it does not exist in the . - To be added. + Gets either a reference to a in the or a reference if it does not exist in the . + A reference to a in the or a reference if it does not exist in the .. [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Runtime.Versioning.SupportedOSPlatform("windows")] [<System.Runtime.Versioning.SupportedOSPlatform("windows")>] + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + Class for managing wrappers of COM IUnknown types. @@ -382,6 +398,12 @@ If the `wrapper` instance already has an associated external object a 5.0.0.0 6.0.0.0 + + + [System.Runtime.Versioning.SupportedOSPlatform("windows")] + [<System.Runtime.Versioning.SupportedOSPlatform("windows")>] + + System.Void diff --git a/xml/System.Runtime.InteropServices/MemoryMarshal.xml b/xml/System.Runtime.InteropServices/MemoryMarshal.xml index 0bba1f03524..04e6ccbf65f 100644 --- a/xml/System.Runtime.InteropServices/MemoryMarshal.xml +++ b/xml/System.Runtime.InteropServices/MemoryMarshal.xml @@ -682,9 +682,9 @@ This method can be useful if part of a managed object represents a fixed array. - To be added. + The array to analyze. Returns a reference to the 0th element of . If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced. - To be added. + A reference to the 0th element of . - To be added. + The signal that occurred. Initializes a new instance of the class. To be added. diff --git a/xml/System.Runtime.InteropServices/PosixSignalRegistration.xml b/xml/System.Runtime.InteropServices/PosixSignalRegistration.xml index 0f4e8ee491c..00c868cd548 100644 --- a/xml/System.Runtime.InteropServices/PosixSignalRegistration.xml +++ b/xml/System.Runtime.InteropServices/PosixSignalRegistration.xml @@ -47,10 +47,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml b/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml index 2b5d7b98422..141f34844e4 100644 --- a/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml +++ b/xml/System.Runtime.InteropServices/RuntimeEnvironment.xml @@ -227,8 +227,8 @@ - [System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are no longer supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are no longer supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.InteropServices.ComVisible(false)] @@ -304,8 +304,8 @@ - [System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are no longer supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are no longer supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.InteropServices.ComVisible(false)] @@ -425,8 +425,8 @@ - [System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are no longer supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are no longer supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("RuntimeEnvironment members SystemConfigurationFile, GetRuntimeInterfaceAsIntPtr, and GetRuntimeInterfaceAsObject are not supported and throw PlatformNotSupportedException.", DiagnosticId="SYSLIB0019", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [get: System.Security.SecuritySafeCritical] diff --git a/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml b/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml index 006f355ecb1..18206ebf06d 100644 --- a/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml +++ b/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml @@ -37,7 +37,7 @@ - To be added. + Initializes a new instance. To be added. diff --git a/xml/System.Runtime.InteropServices/UnmanagedType.xml b/xml/System.Runtime.InteropServices/UnmanagedType.xml index ce12e411f6c..f2244ef3c06 100644 --- a/xml/System.Runtime.InteropServices/UnmanagedType.xml +++ b/xml/System.Runtime.InteropServices/UnmanagedType.xml @@ -163,10 +163,14 @@ [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("Marshalling arbitrary types may be unavailable in future releases. Please specify the type you wish to marshal as.")] [<System.Obsolete("Marshalling arbitrary types may be unavailable in future releases. Please specify the type you wish to marshal as.")>] + + [System.Obsolete("Marshalling arbitrary types may be unavailable in future releases. Specify the type you wish to marshal as.")] + [<System.Obsolete("Marshalling arbitrary types may be unavailable in future releases. Specify the type you wish to marshal as.")>] + System.Runtime.InteropServices.UnmanagedType diff --git a/xml/System.Runtime.Loader/AssemblyDependencyResolver.xml b/xml/System.Runtime.Loader/AssemblyDependencyResolver.xml index 7200a8cb96d..60fe7cb7f01 100644 --- a/xml/System.Runtime.Loader/AssemblyDependencyResolver.xml +++ b/xml/System.Runtime.Loader/AssemblyDependencyResolver.xml @@ -29,10 +29,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml b/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml index ce98ed77328..e0df9897931 100644 --- a/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml +++ b/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml @@ -20,8 +20,9 @@ - To be added. + Indicates that an API is in preview. This attribute allows call sites to be flagged with a diagnostic that indicates that a preview feature is used. Authors can use this attribute to ship preview features in their assemblies. To be added. + Preview Features @@ -41,5 +42,68 @@ To be added. + + + + + + + + Constructor + + System.Runtime + 6.0.0.0 + + + + + + An optional message associated with this attribute instance. + Initializes a new instance of the class with the specified message. + To be added. + + + + + + + + + + Property + + System.Runtime + 6.0.0.0 + + + System.String + + + Gets the optional message associated with this attribute instance. + To be added. + To be added. + + + + + + + + + + Property + + System.Runtime + 6.0.0.0 + + + System.String + + + Gets or sets the optional URL associated with this attribute instance. + To be added. + To be added. + + diff --git a/xml/System.Runtime.Versioning/SupportedOSPlatformGuardAttribute.xml b/xml/System.Runtime.Versioning/SupportedOSPlatformGuardAttribute.xml index 439993e9a1e..52c60a4d96a 100644 --- a/xml/System.Runtime.Versioning/SupportedOSPlatformGuardAttribute.xml +++ b/xml/System.Runtime.Versioning/SupportedOSPlatformGuardAttribute.xml @@ -52,8 +52,8 @@ Callers can apply a - To be added. - To be added. + The supported OS platform name the attributed member would guard, optionally including a version. + Initializes a new instance of the attribute class for the specified supported OS platform. To be added. diff --git a/xml/System.Runtime.Versioning/UnsupportedOSPlatformGuardAttribute.xml b/xml/System.Runtime.Versioning/UnsupportedOSPlatformGuardAttribute.xml index 32fb9a089a2..0e6f8c983c1 100644 --- a/xml/System.Runtime.Versioning/UnsupportedOSPlatformGuardAttribute.xml +++ b/xml/System.Runtime.Versioning/UnsupportedOSPlatformGuardAttribute.xml @@ -52,8 +52,8 @@ Callers can apply a - To be added. - To be added. + The unsupported OS platform name the attributed member would guard, optionally including a version. + Initializes a new instance of the attribute class for the specified unsupported OS platform. To be added. diff --git a/xml/System.Security.Authentication/SslProtocols.xml b/xml/System.Security.Authentication/SslProtocols.xml index 318bd14c074..9726141fd8a 100644 --- a/xml/System.Security.Authentication/SslProtocols.xml +++ b/xml/System.Security.Authentication/SslProtocols.xml @@ -79,10 +79,14 @@ 6.0.0.0 - + [System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SslProtocols.Default has been deprecated and is not supported.")] + [<System.Obsolete("SslProtocols.Default has been deprecated and is not supported.")>] + [System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -161,10 +165,14 @@ 2.1.0.0 - + [System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SslProtocols.Ssl2 has been deprecated and is not supported.")] + [<System.Obsolete("SslProtocols.Ssl2 has been deprecated and is not supported.")>] + [System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -207,10 +215,14 @@ 2.1.0.0 - + [System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("SslProtocols.Ssl3 has been deprecated and is not supported.")] + [<System.Obsolete("SslProtocols.Ssl3 has been deprecated and is not supported.")>] + [System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This value has been deprecated. It is no longer supported. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml b/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml index d5db00fda5b..f5258898564 100644 --- a/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml +++ b/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml @@ -100,10 +100,14 @@ 6.0.0.0 - + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("CmsSigner(CspParameters) is obsolete and is not supported. Use an alternative constructor instead.", DiagnosticId="SYSLIB0034", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("CmsSigner(CspParameters) is obsolete and is not supported. Use an alternative constructor instead.", DiagnosticId="SYSLIB0034", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml index 1da48e7e991..86e73f5f3a3 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml @@ -99,6 +99,38 @@ The primary use of the LocalKeyId attribute is to associate an X.509 Public Key + + + + + + + + Method + + System.Security.Cryptography.Pkcs + 6.0.0.0 + + + System.Void + + + + + + The object from which to copy information. + Copies information from a object. + + object with the specified object. + + ]]> + + + diff --git a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml index 5a4bf71205e..db51ae1165f 100644 --- a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml +++ b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml @@ -167,7 +167,7 @@ A object that specifies the content information as the inner content of the message. - To be added. + A object that specifies the content information as the inner content of the message. The constructor creates an instance of the class by using the specified content information as the inner content. A object that specifies the content information as the inner content of the message. - To be added. + A object that specifies the content information as the inner content of the message. A value that specifies whether the object is for a detached signature. If is , the signature is detached. If is , the signature is not detached. The constructor creates an instance of the class by using the specified content information as the inner content and by using the detached state. @@ -267,7 +267,7 @@ A member that specifies the default subject identifier type for signers. A object that specifies the content information as the inner content of the message. - To be added. + A object that specifies the content information as the inner content of the message. The constructor creates an instance of the class by using the specified subject identifier type as the default subject identifier type for signers and content information as the inner content. A member that specifies the default subject identifier type for signers. A object that specifies the content information as the inner content of the message. - To be added. + A object that specifies the content information as the inner content of the message. A value that specifies whether the object is for a detached signature. If is , the signature is detached. If detached is , the signature is not detached. The constructor creates an instance of the class by using the specified subject identifier type as the default subject identifier type for signers, the content information as the inner content, and by using the detached state. @@ -616,7 +616,7 @@ 6.0.0.0 - + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] diff --git a/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml b/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml index 885139c0944..a4deafd8599 100644 --- a/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml +++ b/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml @@ -71,7 +71,7 @@ The ASN.1 encoded attribute to add to the document. - To be added. + The ASN.1 encoded attribute to add to the document. Adds the specified attribute to the current document. 6.0.0.0 - + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + [System.Obsolete("ComputeCounterSignature without specifying a CmsSigner is obsolete and is not supported. Use the overload that accepts a CmsSigner.", DiagnosticId="SYSLIB0035", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("ComputeCounterSignature without specifying a CmsSigner is obsolete and is not supported. Use the overload that accepts a CmsSigner.", DiagnosticId="SYSLIB0035", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + System.Void @@ -656,7 +660,7 @@ ASN1 corrupted data. The ASN.1 encoded attribute to remove from the document. - To be added. + The ASN.1 encoded attribute to remove from the document. Removes the specified attribute from the current document. [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml b/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml index 3ab291db9f4..0f409cbf441 100644 --- a/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml +++ b/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml @@ -304,10 +304,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml b/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml index 94a7ebdecac..68babdadd88 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml @@ -2125,10 +2125,14 @@ 6.0.0.0 - + [System.Obsolete("This method has been deprecated. Please use the Issuer property instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use the Issuer property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("X509Certificate.GetIssuerName has been deprecated. Use the Issuer property instead.")] + [<System.Obsolete("X509Certificate.GetIssuerName has been deprecated. Use the Issuer property instead.")>] + [System.Obsolete("This method has been deprecated. Please use the Issuer property instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use the Issuer property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -2373,10 +2377,14 @@ 6.0.0.0 - + [System.Obsolete("This method has been deprecated. Please use the Subject property instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use the Subject property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("X509Certificate.GetName has been deprecated. Use the Subject property instead.")] + [<System.Obsolete("X509Certificate.GetName has been deprecated. Use the Subject property instead.")>] + [System.Obsolete("This method has been deprecated. Please use the Subject property instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use the Subject property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml b/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml index c3cceb34ee0..4a83220e849 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml @@ -1256,8 +1256,7 @@ The password specified for the private key is incorrect. This loads the first well-formed PEM found with a CERTIFICATE label. -For PEM-encoded certificates with a private key, use - . +For PEM-encoded certificates with a private key, use . For PEM-encoded certificates in a file, use . ]]> diff --git a/xml/System.Security.Cryptography.Xml/CipherReference.xml b/xml/System.Security.Cryptography.Xml/CipherReference.xml index 396e56a77eb..95f5bbff0cc 100644 --- a/xml/System.Security.Cryptography.Xml/CipherReference.xml +++ b/xml/System.Security.Cryptography.Xml/CipherReference.xml @@ -218,7 +218,7 @@ EncryptedXml exml = new EncryptedXml(doc, ev); A Uniform Resource Identifier (URI) pointing to the encrypted data. A object that describes transforms to do on the encrypted data. - To be added. + A object that describes transforms to do on the encrypted data. Initializes a new instance of the class using the specified Uniform Resource Identifier (URI) and transform chain information. + + + + + + + + System.Security.Cryptography.Xml + 6.0.0.0 + + + System.Xml.XmlException + + + + + [System.Runtime.CompilerServices.TypeForwardedFrom("System.Security, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("System.Security, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.Serializable] + [<System.Serializable>] + + + + The exception that's thrown when the signed XML recursion limit is reached. + Catch this exception when computing the hash, in addition to the other exceptions that ComputeHash can throw. + To be added. + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + + + The error message that explains the reason for the exception. + Initializes a new instance of the class with a specified error message. + To be added. + + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + + + + The object that holds the serialized object data. + The contextual information about the source or destination. + Initializes a new instance of the class with serialized data. + + + + + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + + + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception. + Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. + To be added. + + + + diff --git a/xml/System.Security.Cryptography.Xml/DSAKeyValue.xml b/xml/System.Security.Cryptography.Xml/DSAKeyValue.xml index 3c8bf27ceb3..a470ae05ad6 100644 --- a/xml/System.Security.Cryptography.Xml/DSAKeyValue.xml +++ b/xml/System.Security.Cryptography.Xml/DSAKeyValue.xml @@ -91,10 +91,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System.Security.Cryptography.Xml/DataReference.xml b/xml/System.Security.Cryptography.Xml/DataReference.xml index d518381e88c..628a86b0732 100644 --- a/xml/System.Security.Cryptography.Xml/DataReference.xml +++ b/xml/System.Security.Cryptography.Xml/DataReference.xml @@ -171,7 +171,7 @@ A Uniform Resource Identifier (URI) that points to the encrypted data. A object that describes transforms to do on the encrypted data. - To be added. + A object that describes transforms to do on the encrypted data. Initializes a new instance of the class using the specified Uniform Resource Identifier (URI) and a object. The Uniform Resource Identifier (URI) that points to the data to encrypt. A object that describes transforms to be done on the data to encrypt. - To be added. + A object that describes transforms to be done on the data to encrypt. Initializes a new instance of the class using the specified Uniform Resource Identifier (URI) and transform chain. The data to decrypt. The symmetric key used to decrypt . - To be added. + The symmetric key used to decrypt . Decrypts an element using the specified symmetric algorithm. A byte array that contains the raw decrypted plain text. @@ -599,7 +599,7 @@ An array of bytes that represents an encrypted element. The symmetric key used to decrypt . - To be added. + The symmetric key used to decrypt . Decrypts an element using a symmetric algorithm. A byte array that contains the plain text key. @@ -657,7 +657,7 @@ An array of bytes that represents an encrypted element. The asymmetric key used to decrypt . A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP). - To be added. + A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP). Decrypts an element using an asymmetric algorithm. A byte array that contains the plain text key. @@ -972,9 +972,9 @@ The data to encrypt. - To be added. + The data to encrypt. The symmetric algorithm to use for encryption. - To be added. + The symmetric algorithm to use for encryption. Encrypts data in the specified byte array using the specified symmetric algorithm. A byte array of encrypted data. @@ -1052,7 +1052,7 @@ The element or its contents to encrypt. The symmetric algorithm to use for encryption. - To be added. + The symmetric algorithm to use for encryption. to encrypt only the contents of the element; to encrypt the entire element. Encrypts the specified element or its contents using the specified symmetric algorithm. @@ -1144,7 +1144,7 @@ The key to encrypt. The symmetric key used to encrypt . - To be added. + The symmetric key used to encrypt . Encrypts a key using a symmetric algorithm that a recipient uses to decrypt an element. A byte array that represents the encrypted value of the parameter. @@ -1204,7 +1204,7 @@ The key to encrypt. The asymmetric key used to encrypt . A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP). - To be added. + A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP). Encrypts the key that a recipient uses to decrypt an element. A byte array that represents the encrypted value of the parameter. @@ -1270,7 +1270,7 @@ The object that contains the initialization vector (IV) to retrieve. The Uniform Resource Identifier (URI) that describes the cryptographic algorithm associated with the value. - To be added. + The Uniform Resource Identifier (URI) that describes the cryptographic algorithm associated with the value. Retrieves the decryption initialization vector (IV) from an object. A byte array that contains the decryption initialization vector (IV). @@ -1328,7 +1328,7 @@ The object that contains the decryption key to retrieve. The size of the decryption key to retrieve. - To be added. + The size of the decryption key to retrieve. Retrieves the decryption key from the specified object. A object associated with the decryption key. diff --git a/xml/System.Security.Cryptography.Xml/EncryptionMethod.xml b/xml/System.Security.Cryptography.Xml/EncryptionMethod.xml index 4342382d0b4..b31272adbdb 100644 --- a/xml/System.Security.Cryptography.Xml/EncryptionMethod.xml +++ b/xml/System.Security.Cryptography.Xml/EncryptionMethod.xml @@ -127,7 +127,7 @@ The Uniform Resource Identifier (URI) that describes the algorithm represented by an instance of the class. - To be added. + The Uniform Resource Identifier (URI) that describes the algorithm represented by an instance of the class. Initializes a new instance of the class specifying an algorithm Uniform Resource Identifier (URI). An object to use for initialization. - To be added. + An object to use for initialization. Initializes a new instance of the class using an object. - + - + System.Security 2.0.0.0 diff --git a/xml/System.Security.Cryptography.Xml/KeyInfoEncryptedKey.xml b/xml/System.Security.Cryptography.Xml/KeyInfoEncryptedKey.xml index ac4f55294c0..286f9e95ed5 100644 --- a/xml/System.Security.Cryptography.Xml/KeyInfoEncryptedKey.xml +++ b/xml/System.Security.Cryptography.Xml/KeyInfoEncryptedKey.xml @@ -129,7 +129,7 @@ An object that encapsulates an encrypted key. - To be added. + An object that encapsulates an encrypted key. Initializes a new instance of the class using an object. The Uniform Resource Identifier (URI) of the information to be referenced by the new instance of . The URI that describes the type of data to retrieve. - To be added. + The URI that describes the type of data to retrieve. Initializes a new instance of the class with the specified Uniform Resource Identifier (URI) pointing to the referenced object and the URI that describes the type of data to retrieve. To be added. diff --git a/xml/System.Security.Cryptography.Xml/KeyReference.xml b/xml/System.Security.Cryptography.Xml/KeyReference.xml index 42047383f14..3f81470d404 100644 --- a/xml/System.Security.Cryptography.Xml/KeyReference.xml +++ b/xml/System.Security.Cryptography.Xml/KeyReference.xml @@ -181,7 +181,7 @@ A Uniform Resource Identifier (URI) that points to the encrypted key. A object that describes transforms to do on the encrypted key. - To be added. + A object that describes transforms to do on the encrypted key. Initializes a new instance of the class for XML encryption using the specified Uniform Resource Identifier (URI) and a object. - + - + System.Security 2.0.0.0 diff --git a/xml/System.Security.Cryptography/AesCcm.xml b/xml/System.Security.Cryptography/AesCcm.xml index 327d789f911..ce399061f07 100644 --- a/xml/System.Security.Cryptography/AesCcm.xml +++ b/xml/System.Security.Cryptography/AesCcm.xml @@ -37,10 +37,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -388,8 +384,8 @@ The parameter length is not permitted by if the algorithm is supported; otherwise, . To be added. diff --git a/xml/System.Security.Cryptography/AesGcm.xml b/xml/System.Security.Cryptography/AesGcm.xml index 2245885745b..a92671ab5e0 100644 --- a/xml/System.Security.Cryptography/AesGcm.xml +++ b/xml/System.Security.Cryptography/AesGcm.xml @@ -37,10 +37,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -388,8 +384,8 @@ The parameter length is not permitted by if the algorithm is supported; otherwise, . To be added. diff --git a/xml/System.Security.Cryptography/ChaCha20Poly1305.xml b/xml/System.Security.Cryptography/ChaCha20Poly1305.xml index dc971545825..47f9476901b 100644 --- a/xml/System.Security.Cryptography/ChaCha20Poly1305.xml +++ b/xml/System.Security.Cryptography/ChaCha20Poly1305.xml @@ -26,17 +26,13 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - To be added. + Represents a symmetric key to be used with the ChaCha20 stream cipher in the combined mode with the Poly1305 authenticator. To be added. @@ -56,9 +52,10 @@ - To be added. - To be added. + The secret key to use for this instance. + Initializes a new instance of the class with a provided key. To be added. + The parameter length is not 32 bytes (256 bits). @@ -77,9 +74,10 @@ - To be added. - To be added. + The secret key to use for this instance. + Initializes a new instance of the class with a provided key. To be added. + The parameter length is not 32 bytes (256 bits). @@ -104,13 +102,32 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The nonce associated with this message, which must match the value provided during encryption. + The encrypted content to decrypt. + The authentication tag produced for this message during encryption. + The byte array to receive the decrypted contents. + Extra data associated with this message, which must match the value provided during encryption. + Decrypts the ciphertext into the provided destination buffer if the authentication tag can be validated. + + + + The parameter and the do not have the same length. + +-or- + +The parameter length is not 12 bytes (96 bits). + +-or- + +The parameter length is not 16 bytes (128 bits). + The , , , or parameter is . + The tag value could not be verified, or the decryption operation otherwise failed. @@ -135,13 +152,31 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The nonce associated with this message, which must match the value provided during encryption. + The encrypted content to decrypt. + The authentication tag produced for this message during encryption. + The byte array to receive the decrypted contents. + Extra data associated with this message, which must match the value provided during encryption. + Decrypts the ciphertext into the provided destination buffer if the authentication tag can be validated. + + + + The parameter and the do not have the same length. + +-or- + +The parameter length is not 12 bytes (96 bits). + +-or- + +The parameter length is not 16 bytes (128 bits). + The tag value could not be verified, or the decryption operation otherwise failed. @@ -190,13 +225,32 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The nonce associated with this message, which should be a unique value for every operation with the same key. + The content to encrypt. + The byte array to receive the encrypted contents. + The byte array to receive the generated authentication tag. + Extra data associated with this message, which must also be provided during decryption. + Encrypts the plaintext into the ciphertext destination buffer and generates the authentication tag into a separate buffer. + + + + The parameter and the do not have the same length. + +-or- + +The parameter length is not 12 bytes (96 bits). + +-or- + +The parameter length is not 16 bytes (128 bits). + The , , , or parameter is . + The encryption operation failed. @@ -221,13 +275,32 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The nonce associated with this message, which should be a unique value for every operation with the same key. + The content to encrypt. + The byte array to receive the encrypted contents. + The byte array to receive the generated authentication tag. + Extra data associated with this message, which must also be provided during decryption. + Encrypts the plaintext into the ciphertext destination buffer and generates the authentication tag into a separate buffer. + + + + The parameter and the do not have the same length. + +-or- + +The parameter length is not 12 bytes (96 bits). + +-or- + +The parameter length is not 16 bytes (128 bits). + The , , , or parameter is . + The encryption operation failed. @@ -246,8 +319,8 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates whether the algorithm is supported on the current platform. + if the algorithm is supported; otherwise, . To be added. diff --git a/xml/System.Security.Cryptography/CryptoStream.xml b/xml/System.Security.Cryptography/CryptoStream.xml index 494a289c914..ed66393668e 100644 --- a/xml/System.Security.Cryptography/CryptoStream.xml +++ b/xml/System.Security.Cryptography/CryptoStream.xml @@ -524,10 +524,30 @@ - To be added. - To be added. - To be added. - To be added. + The stream to which the contents of the current stream will be copied. + The size, in bytes, of the buffer to use for reading from the underlying stream. This value must be greater than zero. The default size is 81920 bytes. + Reads the bytes from the underlying stream, applies the relevant cryptographic transforms, and writes the result to the destination stream. + + + + + is . + + is negative or zero. + The current stream does not support reading. + + -or- + + does not support writing. + Either the current stream or were closed before the method was called. + An I/O error occurred. + An error occurred during a cryptographic operation. @@ -557,12 +577,27 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to which the contents of the current stream will be copied. + The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920. + The token to monitor for cancellation requests. The default value is . + Asynchronously reads the bytes from the underlying stream, applies the relevant cryptographic transforms, and writes the result to the destination stream. + A task that represents the asynchronous copy operation. + + + + + is . + + is negative or zero. + Either the current stream or the destination stream is disposed. + The current stream does not support reading, or the destination stream does not support writing. + An error occurred during a cryptographic operation. @@ -1217,11 +1252,12 @@ - To be added. - To be added. - To be added. - To be added. + The region of memory to write the data into. + The token to monitor for cancellation requests. The default value is . + Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. + A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached. To be added. + The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is write only. @@ -1558,11 +1594,12 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. + The region of memory to write data from. + The token to monitor for cancellation requests. The default value is . + Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. + A task that represents the asynchronous write operation. To be added. + The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is read only. diff --git a/xml/System.Security.Cryptography/DSA.xml b/xml/System.Security.Cryptography/DSA.xml index 653aa06f691..13d8655855a 100644 --- a/xml/System.Security.Cryptography/DSA.xml +++ b/xml/System.Security.Cryptography/DSA.xml @@ -142,10 +142,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -195,10 +191,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -248,10 +240,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System.Security.Cryptography/HMACMD5.xml b/xml/System.Security.Cryptography/HMACMD5.xml index dcc8b50051f..ed44eb8405b 100644 --- a/xml/System.Security.Cryptography/HMACMD5.xml +++ b/xml/System.Security.Cryptography/HMACMD5.xml @@ -567,7 +567,7 @@ The HMAC key. The data to HMAC. The buffer to receive the HMAC value. - When this method returns, the total number of bytes written into . + When this method returns, contains the total number of bytes written into . Attempts to compute the HMAC of data using the MD5 algorithm. if is too small to hold the calculated hash, otherwise. diff --git a/xml/System.Security.Cryptography/HMACSHA1.xml b/xml/System.Security.Cryptography/HMACSHA1.xml index 144fa13f74f..2e610c9a0c1 100644 --- a/xml/System.Security.Cryptography/HMACSHA1.xml +++ b/xml/System.Security.Cryptography/HMACSHA1.xml @@ -695,7 +695,7 @@ Releases the unmanaged resources used by the The HMAC key. The data to HMAC. The buffer to receive the HMAC value. - When this method returns, the total number of bytes written into . + When this method returns, contains the total number of bytes written into . Attempts to compute the HMAC of data using the SHA1 algorithm. if is too small to hold the calculated hash, otherwise. diff --git a/xml/System.Security.Cryptography/HMACSHA384.xml b/xml/System.Security.Cryptography/HMACSHA384.xml index b7fd9e82baa..5102ddc2605 100644 --- a/xml/System.Security.Cryptography/HMACSHA384.xml +++ b/xml/System.Security.Cryptography/HMACSHA384.xml @@ -566,8 +566,8 @@ - [System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is no longer supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is no longer supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is not supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is not supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Security.Cryptography/HMACSHA512.xml b/xml/System.Security.Cryptography/HMACSHA512.xml index 46ab6de378e..b3b1bcc6f62 100644 --- a/xml/System.Security.Cryptography/HMACSHA512.xml +++ b/xml/System.Security.Cryptography/HMACSHA512.xml @@ -566,8 +566,8 @@ - [System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is no longer supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is no longer supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is not supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("ProduceLegacyHmacValues is obsolete. Producing legacy HMAC values is not supported.", DiagnosticId="SYSLIB0029", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -631,7 +631,7 @@ public static void Test() The HMAC key. The data to HMAC. The buffer to receive the HMAC value. - When this method returns, the total number of bytes written into . + When this method returns, contains the total number of bytes written into . Attempts to compute the HMAC of data using the SHA512 algorithm. if is too small to hold the calculated hash, otherwise. diff --git a/xml/System.Security.Cryptography/RC2.xml b/xml/System.Security.Cryptography/RC2.xml index 9fb7da94aa5..95fcb476a4e 100644 --- a/xml/System.Security.Cryptography/RC2.xml +++ b/xml/System.Security.Cryptography/RC2.xml @@ -157,6 +157,10 @@ 6.0.0.0 + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] diff --git a/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml b/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml index 9ea6ed148a1..13882b33f10 100644 --- a/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml +++ b/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml @@ -580,6 +580,10 @@ 6.0.0.0 + + [System.Obsolete("Rfc2898DeriveBytes.CryptDeriveKey is obsolete and is not supported. Use PasswordDeriveBytes.CryptDeriveKey instead.", DiagnosticId="SYSLIB0033", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Rfc2898DeriveBytes.CryptDeriveKey is obsolete and is not supported. Use PasswordDeriveBytes.CryptDeriveKey instead.", DiagnosticId="SYSLIB0033", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Security.SecuritySafeCritical] [<System.Security.SecuritySafeCritical>] @@ -779,7 +783,7 @@ Gets the hash algorithm used for byte derivation. - To be added. + The hash algorithm used for byte derivation. To be added. @@ -1019,7 +1023,7 @@ The hash algorithm to use to derive the key. The size of key to derive. Creates a PBKDF2 derived key from a password. - To be added. + A byte array of length that is filled with pseudo-random key bytes. The hash algorithm to use to derive the key. The size of key to derive. Creates a PBKDF2 derived key from a password. - To be added. + A byte array of length that is filled with pseudo-random key bytes. - To be added. - To be added. + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. To be added. @@ -445,9 +445,17 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the feedback size, in bits, of the cryptographic operation for the Cipher Feedback (CFB) and Output Feedback (OFB) cipher modes. + The feedback size in bits. + + + + The feedback size is larger than the block size. diff --git a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml index e1a83bbf5a2..c9f97a13c4c 100644 --- a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml +++ b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml @@ -44,7 +44,7 @@ - To be added. + Initializes a new instance of the class, representing an invalid handle. To be added. diff --git a/xml/System.Security.Cryptography/SymmetricAlgorithm.xml b/xml/System.Security.Cryptography/SymmetricAlgorithm.xml index 273655e269a..5b9af63cf55 100644 --- a/xml/System.Security.Cryptography/SymmetricAlgorithm.xml +++ b/xml/System.Security.Cryptography/SymmetricAlgorithm.xml @@ -644,12 +644,27 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + Decrypts data using CBC mode with the specified padding mode. + The decrypted plaintext data. + + . + + ]]> + + + or is . + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. @@ -678,12 +693,25 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + Decrypts data using CBC mode with the specified padding mode. + The decrypted plaintext data. + + . + + ]]> + + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. @@ -713,13 +741,27 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + Decrypts data into the specified buffer, using CBC mode with the specified padding mode. + The total number of bytes written to + + . + + ]]> + + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. + The buffer in is too small to hold the plaintext data. @@ -749,13 +791,36 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Decrypts data using CFB mode with the specified padding mode and feedback size. + The decrypted plaintext data. + + . + + ]]> + + + or is . + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. + +-or- + +The feedback size is not valid for the algorithm. @@ -785,13 +850,34 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Decrypts data using CFB mode with the specified padding mode and feedback size. + The decrypted plaintext data. + + . + + ]]> + + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. + +-or- + +The feedback size is not valid for the algorithm. @@ -822,14 +908,39 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Decrypts data into the specified buffer, using CFB mode with the specified padding mode and feedback size. + The total number of bytes written to . + + . + + ]]> + + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + +-or- + +The buffer in is too small to hold the plaintext data. + The ciphertext could not be decrypted successfully. + +-or- + + is not valid for the algorithm. @@ -858,11 +969,24 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The padding mode used to produce the ciphertext and remove during decryption. + Decrypts data using ECB mode with the specified padding mode. + The decrypted plaintext data. + + . + + ]]> + + + is . + + is not a valid padding mode. + The ciphertext could not be decrypted successfully. @@ -891,11 +1015,22 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The padding mode used to produce the ciphertext and remove during decryption. + Decrypts data using ECB mode with the specified padding mode. + The decrypted plaintext data. + + . + + ]]> + + + is not a valid padding mode. + The ciphertext could not be decrypted successfully. @@ -925,12 +1060,24 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + Decrypts data into the specified buffer, using ECB mode with the specified padding mode. + The total number of bytes written to + + . + + ]]> + + + is not a valid padding mode. + The ciphertext could not be decrypted successfully. + The buffer in is too small to hold the plaintext data. @@ -1084,12 +1231,27 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + Encrypts data using CBC mode with the specified padding mode. + The encrypted ciphertext data. + + . + + ]]> + + + or is . + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. @@ -1118,12 +1280,25 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + Encrypts data using CBC mode with the specified padding mode. + The encrypted ciphertext data. + + . + + ]]> + + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. @@ -1153,13 +1328,27 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + Encrypts data into the specified buffer, using CBC mode with the specified padding mode. + The total number of bytes written to . + + . + + ]]> + + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. + The buffer in is too small to hold the ciphertext data. @@ -1189,13 +1378,36 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Encrypts data using CFB mode with the specified padding mode and feedback size. + The encrypted ciphertext data. + + . + + ]]> + + + or is . + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. + +-or- + +The feedback size is not valid for the algorithm. @@ -1225,13 +1437,34 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Encrypts data using CFB mode with the specified padding mode and feedback size. + The encrypted ciphertext data. + + . + + ]]> + + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. + +-or- + +The feedback size is not valid for the algorithm. @@ -1262,14 +1495,35 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Encrypts data into the specified buffer, using CFB mode with the specified padding mode and feedback size. + The total number of bytes written to . + + . + + ]]> + + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. + +-or- + +The feedback size is not valid for the algorithm. @@ -1298,11 +1552,24 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The padding mode used to produce the ciphertext and remove during decryption. + Encrypts data using ECB mode with the specified padding mode. + The encrypted ciphertext data. + + . + + ]]> + + + is . + + is not a valid padding mode. + The plaintext could not be encrypted successfully. @@ -1331,11 +1598,22 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The padding mode used to produce the ciphertext and remove during decryption. + Encrypts data using ECB mode with the specified padding mode. + The encrypted ciphertext data. + + . + + ]]> + + + is not a valid padding mode. + The plaintext could not be encrypted successfully. @@ -1365,12 +1643,24 @@ We recommend that you specify the algorithm by calling the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + Encrypts data into the specified buffer, using ECB mode with the specified padding mode. + The total number of bytes written to . + + . + + ]]> + + + is not a valid padding mode. + The plaintext could not be encrypted successfully. + The buffer in is too small to hold the ciphertext data. @@ -1619,19 +1909,19 @@ Allows an to attempt to free resources and perfor is a negative number. -- or - - - when padded is too large to represent as a signed 32-bit integer. +-or- + + when padded is too large to represent as a signed 32-bit integer. + +-or- -- or - - - is not a valid padding mode. + is not a valid padding mode. is not a positive integer. -- or - - - is not a whole number of bytes. It must be divisible by 8. +-or- + + is not a whole number of bytes. It must be divisible by 8. The padding mode was used, but is not a whole number of blocks. @@ -1679,22 +1969,22 @@ Allows an to attempt to free resources and perfor is not a positive number. -- or - - - is a negative number. +-or- + + is a negative number. + +-or- -- or - - - when padded is too large to represent as a signed 32-bit integer. + when padded is too large to represent as a signed 32-bit integer. -- or - +-or- - is not a valid padding mode. + is not a valid padding mode. The padding mode was used, but is not a whole number of blocks. -- or - +-or- - is not a whole number of bytes. It must be divisible by 8. + is not a whole number of bytes. It must be divisible by 8. @@ -1731,19 +2021,19 @@ Allows an to attempt to free resources and perfor is a negative number. -- or - +-or- - when padded is too large to represent as a signed 32-bit integer. + when padded is too large to represent as a signed 32-bit integer. -- or - +-or- - is not a valid padding mode. + is not a valid padding mode. is not a positive integer. -- or - +-or- - is not a whole number of bytes. It must be divisible by 8. + is not a whole number of bytes. It must be divisible by 8. The padding mode was used, but is not a whole number of blocks. @@ -2510,14 +2800,28 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The buffer to receive the plaintext data. + When this method returns, contains the total number of bytes written to . + The padding mode used to produce the ciphertext and remove during decryption. + Attempts to decrypt data into the specified buffer, using CBC mode with the specified padding mode. + + if was large enough to receive the decrypted data; otherwise, . + + . + + ]]> + + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. @@ -2549,14 +2853,24 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + When this method returns, contains the total number of bytes written to . + When overridden in a derived class, attempts to decrypt data into the specified buffer, using CBC mode with the specified padding mode. + + if was large enough to receive the decrypted data; otherwise, . + + + + A derived class has not provided an implementation. @@ -2588,15 +2902,37 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The buffer to receive the plaintext data. + When this method returns, contains the total number of bytes written to . + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Attempts to decrypt data into the specified buffer, using CFB mode with the specified padding mode and feedback size. + + if was large enough to receive the decrypted data; otherwise, . + + . + + ]]> + + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The ciphertext could not be decrypted successfully. + +-or- + + is not valid for the algorithm. @@ -2629,15 +2965,25 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The initialization vector. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + When this method returns, contains the total number of bytes written to . + When overridden in a derived class, attempts to decrypt data into the specified buffer, using CFB mode with the specified padding mode and feedback size. + + if was large enough to receive the decrypted data; otherwise, . + + + + A derived class has not provided an implementation. @@ -2668,13 +3014,25 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + When this method returns, contains the total number of bytes written to . + Attempts to decrypt data into the specified buffer, using ECB mode with the specified padding mode. + + if was large enough to receive the decrypted data; otherwise, . + + . + + ]]> + + + is not a valid padding mode. + The ciphertext could not be decrypted successfully. @@ -2705,13 +3063,23 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to decrypt. + The buffer to receive the plaintext data. + The padding mode used to produce the ciphertext and remove during decryption. + When this method returns, contains the total number of bytes written to . + When overridden in a derived class, attempts to decrypt data into the specified buffer, using ECB mode with the specified padding mode. + + if was large enough to receive the decrypted data; otherwise, . + + + + A derived class has not provided an implementation. @@ -2742,14 +3110,28 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The buffer to receive the ciphertext data. + When this method returns, contains the total number of bytes written to . + The padding mode used to produce the ciphertext and remove during decryption. + Attempts to encrypt data into the specified buffer, using CBC mode with the specified padding mode. + + if was large enough to receive the encrypted data; otherwise, . + + . + + ]]> + + + is not a valid padding mode. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. @@ -2781,14 +3163,32 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + When this method returns, contains the total number of bytes written to . + When overridden in a derived class, attempts to encrypt data into the specified buffer, using CBC mode with the specified padding mode. + + if was large enough to receive the encrypted data; otherwise, . + + + + A derived class has not provided an implementation. @@ -2820,15 +3220,37 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The buffer to receive the ciphertext data. + When this method returns, contains the total number of bytes written to . + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + Attempts to encrypt data into the specified buffer, using CFB mode with the specified padding mode and feedback size. + + if was large enough to receive the encrypted data; otherwise, . + + . + + ]]> + + + is not a valid padding mode. + +-or- + + is not positive or represent a whole number of bytes. + + is the incorrect length. Callers are expected to pass an initialization vector that is exactly in length, converted to bytes (BlockSize / 8). + The plaintext could not be encrypted successfully. + +-or- + +The feedback size is not valid for the algorithm. @@ -2861,15 +3283,33 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The initialization vector. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + The feedback size, specified in bits. + When this method returns, contains the total number of bytes written to . + When overridden in a derived class, attempts to encrypt data into the specified buffer, using CFB mode with the specified padding mode and feedback size. + + if was large enough to receive the encrypted data; otherwise, . + + + + A derived class has not provided an implementation. @@ -2900,13 +3340,25 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + When this method returns, contains the total number of bytes written to . + Attempts to encrypt data into the specified buffer, using ECB mode with the specified padding mode. + + if was large enough to receive the encrypted data; otherwise, . + + . + + ]]> + + + is not a valid padding mode. + The plaintext could not be encrypted successfully. @@ -2937,13 +3389,31 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data to encrypt. + The buffer to receive the ciphertext data. + The padding mode used to produce the ciphertext and remove during decryption. + When this method returns, contains the total number of bytes written to . + When overridden in a derived class, attempts to encrypt data into the specified buffer, using ECB mode with the specified padding mode. + + if was large enough to receive the encrypted data; otherwise, . + + + + A derived class has not provided an implementation. diff --git a/xml/System.Security.Permissions/HostProtectionResource.xml b/xml/System.Security.Permissions/HostProtectionResource.xml index 8531c9a127f..5b83df5f4e7 100644 --- a/xml/System.Security.Permissions/HostProtectionResource.xml +++ b/xml/System.Security.Permissions/HostProtectionResource.xml @@ -35,6 +35,10 @@ [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + [System.Runtime.InteropServices.ComVisible(true)] [<System.Runtime.InteropServices.ComVisible(true)>] diff --git a/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml b/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml index 12494cc7f7b..c46dcf2d6a3 100644 --- a/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml +++ b/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml @@ -232,10 +232,14 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] + + [System.Obsolete("ReflectionPermissionAttribute.ReflectionEmit has been deprecated and is not supported.")] + [<System.Obsolete("ReflectionPermissionAttribute.ReflectionEmit has been deprecated and is not supported.")>] + [System.Obsolete("This permission is no longer used by the CLR.")] [<System.Obsolete("This permission is no longer used by the CLR.")>] @@ -329,10 +333,14 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] + + [System.Obsolete("ReflectionPermissionAttribute.TypeInformation has been deprecated and is not supported.")] + [<System.Obsolete("ReflectionPermissionAttribute.TypeInformation has been deprecated and is not supported.")>] + [System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Security.Permissions/ReflectionPermissionFlag.xml b/xml/System.Security.Permissions/ReflectionPermissionFlag.xml index 0a951675ed6..7b340792c00 100644 --- a/xml/System.Security.Permissions/ReflectionPermissionFlag.xml +++ b/xml/System.Security.Permissions/ReflectionPermissionFlag.xml @@ -107,10 +107,14 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] + + [System.Obsolete("ReflectionPermissionFlag.AllFlags has been deprecated. Use PermissionState.Unrestricted to get full access.")] + [<System.Obsolete("ReflectionPermissionFlag.AllFlags has been deprecated. Use PermissionState.Unrestricted to get full access.")>] + [System.Obsolete("This permission has been deprecated. Use PermissionState.Unrestricted to get full access.")] [<System.Obsolete("This permission has been deprecated. Use PermissionState.Unrestricted to get full access.")>] @@ -211,10 +215,14 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] + + [System.Obsolete("ReflectionPermissionFlag.ReflectionEmit has been deprecated and is not supported.")] + [<System.Obsolete("ReflectionPermissionFlag.ReflectionEmit has been deprecated and is not supported.")>] + [System.Obsolete("This permission is no longer used by the CLR.")] [<System.Obsolete("This permission is no longer used by the CLR.")>] @@ -288,10 +296,14 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] + + [System.Obsolete("ReflectionPermissionFlag.TypeInformation has been deprecated and is not supported.")] + [<System.Obsolete("ReflectionPermissionFlag.TypeInformation has been deprecated and is not supported.")>] + [System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This API has been deprecated. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Security.Permissions/RegistryPermissionAttribute.xml b/xml/System.Security.Permissions/RegistryPermissionAttribute.xml index 4991bba14bc..1075a9c0cfc 100644 --- a/xml/System.Security.Permissions/RegistryPermissionAttribute.xml +++ b/xml/System.Security.Permissions/RegistryPermissionAttribute.xml @@ -123,10 +123,14 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] + + [System.Obsolete("RegistryPermissionAttribute.Add has been deprecated. Use ViewAndModify instead.")] + [<System.Obsolete("RegistryPermissionAttribute.Add has been deprecated. Use ViewAndModify instead.")>] + [System.Obsolete("Please use the ViewAndModify property instead.")] [<System.Obsolete("Please use the ViewAndModify property instead.")>] diff --git a/xml/System.Security.Permissions/StorePermission.xml b/xml/System.Security.Permissions/StorePermission.xml index e2b77531bdd..5b5cc359a76 100644 --- a/xml/System.Security.Permissions/StorePermission.xml +++ b/xml/System.Security.Permissions/StorePermission.xml @@ -131,7 +131,7 @@ A bitwise combination of the values. - To be added. + A bitwise combination of the values. Initializes a new instance of the class with the specified access. A that contains the XML encoding to use to reconstruct the permission. - To be added. + A that contains the XML encoding to use to reconstruct the permission. Reconstructs a permission with a specified state from an XML encoding. An that uniquely identifies an application. - To be added. + An that uniquely identifies an application. Initializes a new instance of the class with an . - + @@ -25,7 +25,6 @@ 6.0.0.0 - @@ -210,7 +209,11 @@ [System.Obsolete] [<System.Obsolete>] - + + [System.Obsolete("This constructor is obsolete. Use the constructor which accepts arrays of EvidenceBase instead.")] + [<System.Obsolete("This constructor is obsolete. Use the constructor which accepts arrays of EvidenceBase instead.")>] + + [System.Obsolete("This constructor is obsolete. Please use the constructor which takes arrays of EvidenceBase instead.")] [<System.Obsolete("This constructor is obsolete. Please use the constructor which takes arrays of EvidenceBase instead.")>] @@ -261,8 +264,8 @@ 6.0.0.0 - - + + The host evidence from which to create the new instance. @@ -309,7 +312,11 @@ [System.Obsolete] [<System.Obsolete>] - + + [System.Obsolete("Evidence.AddAssembly has been deprecated. Use AddAssemblyEvidence instead.")] + [<System.Obsolete("Evidence.AddAssembly has been deprecated. Use AddAssemblyEvidence instead.")>] + + [System.Obsolete("This method is obsolete. Please use AddAssemblyEvidence instead.")] [<System.Obsolete("This method is obsolete. Please use AddAssemblyEvidence instead.")>] @@ -389,7 +396,7 @@ - + The type of the object in . @@ -441,7 +448,11 @@ [System.Obsolete] [<System.Obsolete>] - + + [System.Obsolete("Evidence.AddHost has been deprecated. Use AddHostEvidence instead.")] + [<System.Obsolete("Evidence.AddHost has been deprecated. Use AddHostEvidence instead.")>] + + [System.Obsolete("This method is obsolete. Please use AddHostEvidence instead.")] [<System.Obsolete("This method is obsolete. Please use AddHostEvidence instead.")>] @@ -525,7 +536,7 @@ - + The type of the object in . @@ -611,7 +622,7 @@ - + Method mscorlib @@ -686,7 +697,11 @@ [System.Obsolete] [<System.Obsolete>] - + + [System.Obsolete("Evidence should not be treated as an ICollection. Use the GetHostEnumerator and GetAssemblyEnumerator methods rather than using CopyTo.")] + [<System.Obsolete("Evidence should not be treated as an ICollection. Use the GetHostEnumerator and GetAssemblyEnumerator methods rather than using CopyTo.")>] + + [System.Obsolete("Evidence should not be treated as an ICollection. Please use the GetHostEnumerator and GetAssemblyEnumerator methods rather than using CopyTo.")] [<System.Obsolete("Evidence should not be treated as an ICollection. Please use the GetHostEnumerator and GetAssemblyEnumerator methods rather than using CopyTo.")>] @@ -754,7 +769,11 @@ [System.Obsolete] [<System.Obsolete>] - + + [System.Obsolete("Evidence should not be treated as an ICollection. Use GetHostEnumerator and GetAssemblyEnumerator to iterate over the evidence to collect a count.")] + [<System.Obsolete("Evidence should not be treated as an ICollection. Use GetHostEnumerator and GetAssemblyEnumerator to iterate over the evidence to collect a count.")>] + + [System.Obsolete("Evidence should not be treated as an ICollection. Please use GetHostEnumerator and GetAssemblyEnumerator to iterate over the evidence to collect a count.")] [<System.Obsolete("Evidence should not be treated as an ICollection. Please use GetHostEnumerator and GetAssemblyEnumerator to iterate over the evidence to collect a count.")>] @@ -902,7 +921,7 @@ Console::WriteLine( "Does the copy equal the current evidence? {0}", myEvidence- - + Method mscorlib @@ -984,7 +1003,11 @@ Console::WriteLine( "Does the copy equal the current evidence? {0}", myEvidence- [System.Obsolete] [<System.Obsolete>] - + + [System.Obsolete("GetEnumerator is obsolete. Use GetAssemblyEnumerator and GetHostEnumerator instead.")] + [<System.Obsolete("GetEnumerator is obsolete. Use GetAssemblyEnumerator and GetHostEnumerator instead.")>] + + [System.Obsolete("GetEnumerator is obsolete. Please use GetAssemblyEnumerator and GetHostEnumerator instead.")] [<System.Obsolete("GetEnumerator is obsolete. Please use GetAssemblyEnumerator and GetHostEnumerator instead.")>] @@ -1123,7 +1146,7 @@ Console::WriteLine( "HashCode = {0}", myEvidence->GetHashCode() ); - + Method mscorlib @@ -1416,7 +1439,7 @@ Console::WriteLine( "HashCode = {0}", myEvidence->GetHashCode() ); System.Void - + The type of the evidence to be removed. @@ -1425,9 +1448,7 @@ Console::WriteLine( "HashCode = {0}", myEvidence->GetHashCode() ); method can be confirmed using the method and the method. - - + The results of executing the method can be confirmed using the method and the method. ## Examples The following code example shows the use of the method. This example is part of a larger example provided for the class. diff --git a/xml/System.Security.Policy/FirstMatchCodeGroup.xml b/xml/System.Security.Policy/FirstMatchCodeGroup.xml index 1cf64a17cda..5f37bc16ed3 100644 --- a/xml/System.Security.Policy/FirstMatchCodeGroup.xml +++ b/xml/System.Security.Policy/FirstMatchCodeGroup.xml @@ -33,10 +33,14 @@ [System.Obsolete("This type is obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("This type is obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] - + [System.Obsolete("This type is obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("This type is obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.")>] + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Security.Policy/PermissionRequestEvidence.xml b/xml/System.Security.Policy/PermissionRequestEvidence.xml index 36336b1bafa..06023941bf1 100644 --- a/xml/System.Security.Policy/PermissionRequestEvidence.xml +++ b/xml/System.Security.Policy/PermissionRequestEvidence.xml @@ -39,10 +39,14 @@ [System.Obsolete("This type is obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("This type is obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] - + [System.Obsolete("This type is obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("This type is obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.")>] + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Security.Policy/PolicyException.xml b/xml/System.Security.Policy/PolicyException.xml index 4d41d820037..113e7364104 100644 --- a/xml/System.Security.Policy/PolicyException.xml +++ b/xml/System.Security.Policy/PolicyException.xml @@ -1,11 +1,11 @@ - + - + @@ -38,7 +38,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Security.Policy/PolicyLevel.xml b/xml/System.Security.Policy/PolicyLevel.xml index 79e34e99846..0f75f863809 100644 --- a/xml/System.Security.Policy/PolicyLevel.xml +++ b/xml/System.Security.Policy/PolicyLevel.xml @@ -101,11 +101,11 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] - + [System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")] [<System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")>] @@ -164,11 +164,11 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] - + [System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")] [<System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")>] @@ -343,10 +343,14 @@ [System.Obsolete("AppDomain policy levels are obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("AppDomain policy levels are obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] - + [System.Obsolete("AppDomain policy levels are obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("AppDomain policy levels are obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.")>] + [System.Obsolete("AppDomain policy levels are obsolete and will be removed in a future release of the .NET Framework. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("AppDomain policy levels are obsolete and will be removed in a future release of the .NET Framework. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] @@ -441,11 +445,11 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] - + [System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")] [<System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")>] @@ -683,11 +687,11 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] - + [System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")] [<System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")>] @@ -745,11 +749,11 @@ 6.0.0.0 - + [System.Obsolete] [<System.Obsolete>] - + [System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")] [<System.Obsolete("Because all GAC assemblies always get full trust, the full trust list is no longer meaningful. You should install any assemblies that are used in security policy in the GAC to ensure they are trusted.")>] diff --git a/xml/System.Security.Policy/PolicyStatement.xml b/xml/System.Security.Policy/PolicyStatement.xml index 881351093b5..fd86b215b1a 100644 --- a/xml/System.Security.Policy/PolicyStatement.xml +++ b/xml/System.Security.Policy/PolicyStatement.xml @@ -356,7 +356,7 @@ The object to compare with the current . - To be added. + The object to compare with the current . Determines whether the specified object is equal to the current . if the specified is equal to the current object; otherwise, . @@ -572,7 +572,7 @@ 6.0.0.0 - + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Security.Policy/UnionCodeGroup.xml b/xml/System.Security.Policy/UnionCodeGroup.xml index 964f17f1801..059778b7049 100644 --- a/xml/System.Security.Policy/UnionCodeGroup.xml +++ b/xml/System.Security.Policy/UnionCodeGroup.xml @@ -33,10 +33,14 @@ [System.Obsolete("This type is obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("This type is obsolete. See http://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] - + [System.Obsolete("This type is obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")] [<System.Obsolete("This type is obsolete. See https://go.microsoft.com/fwlink/?LinkID=155570 for more information.")>] + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.")>] + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.Security.Policy/UrlMembershipCondition.xml b/xml/System.Security.Policy/UrlMembershipCondition.xml index 636068db877..82ff5aeda8f 100644 --- a/xml/System.Security.Policy/UrlMembershipCondition.xml +++ b/xml/System.Security.Policy/UrlMembershipCondition.xml @@ -3,8 +3,9 @@ - + + @@ -238,7 +239,7 @@ The object to compare to the current . - The to compare with the current . + The object to compare to the current . Determines whether the URL from the specified object is equivalent to the URL contained in the current . if the URL from the specified object is equivalent to the URL contained in the current ; otherwise, . diff --git a/xml/System.Security.Policy/ZoneMembershipCondition.xml b/xml/System.Security.Policy/ZoneMembershipCondition.xml index d5bed0f4241..d15897361e7 100644 --- a/xml/System.Security.Policy/ZoneMembershipCondition.xml +++ b/xml/System.Security.Policy/ZoneMembershipCondition.xml @@ -3,8 +3,9 @@ - + + diff --git a/xml/System.Security/HostProtectionException.xml b/xml/System.Security/HostProtectionException.xml index af0103fc078..18b329f1d30 100644 --- a/xml/System.Security/HostProtectionException.xml +++ b/xml/System.Security/HostProtectionException.xml @@ -1,11 +1,11 @@ - + - + mscorlib 2.0.0.0 @@ -32,14 +32,18 @@ [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] + + [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] - + [System.Serializable] [<System.Serializable>] + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + The exception that is thrown when a denied host resource is detected. @@ -328,6 +332,7 @@ System.Security.Permissions 4.0.1.0 + 6.0.0.0 @@ -339,8 +344,8 @@ System.Void - - + + The serialized object data about the exception being thrown. diff --git a/xml/System.Security/SecurityContext.xml b/xml/System.Security/SecurityContext.xml index 3cc89bbaf4c..543c8013b25 100644 --- a/xml/System.Security/SecurityContext.xml +++ b/xml/System.Security/SecurityContext.xml @@ -36,6 +36,12 @@ System.IDisposable + + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + Encapsulates and propagates all security-related data for execution contexts transferred across threads. This class cannot be inherited. diff --git a/xml/System.Security/SecurityTreatAsSafeAttribute.xml b/xml/System.Security/SecurityTreatAsSafeAttribute.xml index 89136ca990c..10c240082ee 100644 --- a/xml/System.Security/SecurityTreatAsSafeAttribute.xml +++ b/xml/System.Security/SecurityTreatAsSafeAttribute.xml @@ -38,10 +38,14 @@ [System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)] [<System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)>] - + [System.Obsolete("SecurityTreatAsSafe is only used for .NET 2.0 transparency compatibility. Please use the SecuritySafeCriticalAttribute instead.")] [<System.Obsolete("SecurityTreatAsSafe is only used for .NET 2.0 transparency compatibility. Please use the SecuritySafeCriticalAttribute instead.")>] + + [System.Obsolete("SecurityTreatAsSafe is only used for .NET 2.0 transparency compatibility. Use SecuritySafeCriticalAttribute instead.")] + [<System.Obsolete("SecurityTreatAsSafe is only used for .NET 2.0 transparency compatibility. Use SecuritySafeCriticalAttribute instead.")>] + [System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)] [<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>] diff --git a/xml/System.Security/XmlSyntaxException.xml b/xml/System.Security/XmlSyntaxException.xml index ffa3009288c..105c9a307eb 100644 --- a/xml/System.Security/XmlSyntaxException.xml +++ b/xml/System.Security/XmlSyntaxException.xml @@ -1,11 +1,11 @@ - + - + mscorlib 1.0.5000.0 @@ -29,7 +29,11 @@ - + + [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")] + [<System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>] + + [System.Serializable] [<System.Serializable>] diff --git a/xml/System.ServiceModel/DeliveryRequirementsAttribute.xml b/xml/System.ServiceModel/DeliveryRequirementsAttribute.xml index 2f344194beb..e75d9175ce7 100644 --- a/xml/System.ServiceModel/DeliveryRequirementsAttribute.xml +++ b/xml/System.ServiceModel/DeliveryRequirementsAttribute.xml @@ -240,10 +240,10 @@ - To be added. + The contract description to modify. The contract description. The service endpoint for the contract. - To be added. + The objects that binding elements require to support the behavior. The binding parameters. Implements the method to attach binding parameters correctly. To be added. @@ -285,10 +285,10 @@ - To be added. + The contract description for which the extension is intended. The contract description to which the behavior is attached. The endpoint for the contract. - To be added. + The client runtime. The client runtime on which the behavior operates. Implementation of the method for client support. To be added. @@ -330,10 +330,10 @@ - To be added. + The contract description to be modified. The contract description to which the behavior is attached. The endpoint for the contract. - To be added. + The dispatch runtime that controls service execution. The dispatch runtime that supports the endpoint. Implementation of the method that enables service support. To be added. @@ -373,7 +373,7 @@ - To be added. + The contract to validate. The contract description. The endpoint to be validated. Implements the method to enable validation support. diff --git a/xml/System.ServiceProcess/ServiceControllerPermissionEntryCollection.xml b/xml/System.ServiceProcess/ServiceControllerPermissionEntryCollection.xml index dea336cdea2..3787f0c4145 100644 --- a/xml/System.ServiceProcess/ServiceControllerPermissionEntryCollection.xml +++ b/xml/System.ServiceProcess/ServiceControllerPermissionEntryCollection.xml @@ -1,14 +1,15 @@ - - + + - + - - + + + + + - - System.ServiceProcess 1.0.5000.0 diff --git a/xml/System.Text.Json.Nodes/JsonArray.xml b/xml/System.Text.Json.Nodes/JsonArray.xml index 97898e1e930..d5796305aa5 100644 --- a/xml/System.Text.Json.Nodes/JsonArray.xml +++ b/xml/System.Text.Json.Nodes/JsonArray.xml @@ -541,10 +541,11 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. + The . + Options to control the serialization behavior. + Writes the into the provided as JSON. To be added. + The parameter is . diff --git a/xml/System.Text.Json.Nodes/JsonNode.xml b/xml/System.Text.Json.Nodes/JsonNode.xml index c93bd740b4a..92fde6cda8b 100644 --- a/xml/System.Text.Json.Nodes/JsonNode.xml +++ b/xml/System.Text.Json.Nodes/JsonNode.xml @@ -12,8 +12,7 @@ System.Object - - + The base class that represents a single node within a mutable JSON document. To be added. @@ -110,29 +109,29 @@ To be added. - - - + + + - - - + + + Method System.Text.Json 6.0.0.0 - TValue + T - + - To be added. + The type of the value to obtain from the . Gets the value for the current . - To be added. + A value converted from the instance. A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -254,7 +253,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -279,7 +278,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -304,7 +303,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -329,7 +328,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -354,7 +353,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -379,7 +378,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -404,7 +403,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -429,7 +428,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -454,7 +453,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -479,7 +478,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -504,7 +503,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -529,7 +528,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -554,7 +553,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -579,7 +578,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -604,7 +603,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -629,7 +628,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -654,7 +653,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -679,7 +678,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -704,7 +703,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -729,7 +728,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -754,7 +753,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -785,7 +784,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -810,7 +809,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -841,7 +840,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -872,7 +871,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -903,7 +902,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -934,7 +933,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -959,7 +958,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -984,7 +983,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -1015,7 +1014,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -1046,7 +1045,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -1077,7 +1076,7 @@ A to implicitly convert. Defines an explicit conversion of a given to a . - To be added. + A value converted from the instance. To be added. @@ -1102,7 +1101,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1127,7 +1126,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1152,7 +1151,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1177,7 +1176,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1202,7 +1201,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1227,7 +1226,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1252,7 +1251,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1277,7 +1276,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1302,7 +1301,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1327,7 +1326,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1352,7 +1351,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1377,7 +1376,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1402,7 +1401,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1427,7 +1426,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1452,7 +1451,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1477,7 +1476,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1502,7 +1501,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1527,7 +1526,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1552,7 +1551,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1577,7 +1576,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1602,7 +1601,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1627,7 +1626,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1658,7 +1657,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1683,7 +1682,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1714,7 +1713,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1745,7 +1744,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1776,7 +1775,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1807,7 +1806,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1832,7 +1831,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1857,7 +1856,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1888,7 +1887,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1919,7 +1918,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -1950,7 +1949,7 @@ A to implicitly convert. Defines an implicit conversion of a given to a . - To be added. + A instance converted from the parameter. To be added. @@ -2235,8 +2234,8 @@ The . Options to control the serialization behavior. Write the into the provided as JSON. - To be added. The parameter is . + To be added. diff --git a/xml/System.Text.Json.Nodes/JsonObject.xml b/xml/System.Text.Json.Nodes/JsonObject.xml index 56d544679de..9bec7013164 100644 --- a/xml/System.Text.Json.Nodes/JsonObject.xml +++ b/xml/System.Text.Json.Nodes/JsonObject.xml @@ -587,9 +587,10 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. + The . + Options to control the serialization behavior. + Write the into the provided as JSON. + The parameter is . To be added. diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml b/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml index f79fe641acd..0a81589ce4b 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml @@ -224,7 +224,7 @@ - + @@ -357,7 +357,7 @@ - + @@ -572,7 +572,7 @@ - + @@ -666,7 +666,7 @@ - + @@ -799,12 +799,12 @@ - - - - - - + + + + + + Method System.Text.Json @@ -818,26 +818,21 @@ - - - - + The type of the class or struct. The to initialize the metadata with. - Provides a mechanism to create an instance of the class or struct when deserializing. - Provides a mechanism to initialize metadata for properties and fields of the class or struct. - Specifies how number properties and fields should be processed when serializing and deserializing. - Provides a serialization implementation for instances of the class or struct which assumes options specified by . + Provides serialization metadata about an object type with constructors, properties, and fields. Creates metadata for a complex class or struct. A instance representing the class or struct. To be added. - Thrown when and are both . + + or is . - + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml b/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml new file mode 100644 index 00000000000..e1b53580340 --- /dev/null +++ b/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml @@ -0,0 +1,169 @@ + + + + + + + + + System.Text.Json + 6.0.0.0 + + + + + + System.Object + + + + The object type to serialize or deserialize. + Provides serialization metadata about an object type with constructors, properties, and fields. + To be added. + + + + + + + + + Constructor + + System.Text.Json + 6.0.0.0 + + + + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Func<System.Text.Json.Serialization.Metadata.JsonParameterInfoValues[]> + + + Provides a mechanism to initialize metadata for a parameterized constructor of the class or struct to be used when deserializing. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.Serialization.JsonNumberHandling + + + Gets or sets an object that specifies how number properties and fields should be processed when serializing and deserializing. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Func<T> + + + Gets or sets a mechanism to create an instance of the class or struct using a parameterless constructor during deserialization. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Func<System.Object[],T> + + + Gets or sets a mechanism to create an instance of the class or struct using a parameterized constructor during deserialization. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Func<System.Text.Json.Serialization.JsonSerializerContext,System.Text.Json.Serialization.Metadata.JsonPropertyInfo[]> + + + Gets or sets a mechanism to initialize metadata for properties and fields of the class or struct. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Action<System.Text.Json.Utf8JsonWriter,T> + + + Gets or sets a serialization implementation for instances of the class or struct that assumes options specified by . + To be added. + To be added. + + + + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml new file mode 100644 index 00000000000..bcb9a1c9542 --- /dev/null +++ b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml @@ -0,0 +1,144 @@ + + + + + + + + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + Provides information about a constructor parameter required for JSON deserialization. + To be added. + + + + + + + + + Constructor + + System.Text.Json + 6.0.0.0 + + + + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Object + + + Gets or sets the default value of the parameter. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value that specifies whether a default value was specified for the parameter. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.String + + + Gets or sets the name of the parameter. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Type + + + Gets or sets the type of the parameter. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Int32 + + + Gets or sets the zero-based position of the parameter in the formal parameter list. + To be added. + To be added. + + + + diff --git a/xml/System.Text.Json.Serialization/JsonConverter`1.xml b/xml/System.Text.Json.Serialization/JsonConverter`1.xml index 17ca3b3c8e2..69a97440a78 100644 --- a/xml/System.Text.Json.Serialization/JsonConverter`1.xml +++ b/xml/System.Text.Json.Serialization/JsonConverter`1.xml @@ -163,6 +163,43 @@ For more information, see [How to write custom converters for JSON serialization + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + T + + + + + + + + The to read from. + The type to convert. + The options to use when reading the value. + Reads a dictionary key from a JSON property name. + The value that was converted. + + + + + @@ -200,6 +237,42 @@ A converter may throw any exception, but it should throw + + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Void + + + + + + + + The to write to. + The value to convert. The value of determines if the converter handles values. + The options to use when writing the value. + Writes a dictionary key as a JSON property name. + + diff --git a/xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml b/xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml index 2dd7280ce2d..8ba9f364498 100644 --- a/xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml @@ -1,10 +1,10 @@ - - + + - + - + System.Text.Json 6.0.0.0 @@ -37,7 +37,7 @@ - To be added. + Instructs the System.Text.Json source generator to assume the specified options will be used at run time via . To be added. diff --git a/xml/System.Text.Json.SourceGeneration/JsonSourceGenerator.xml b/xml/System.Text.Json.SourceGeneration/JsonSourceGenerator.xml deleted file mode 100644 index eb68913937c..00000000000 --- a/xml/System.Text.Json.SourceGeneration/JsonSourceGenerator.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - - System.Text.Json.SourceGeneration - 6.0.0.0 - - - System.Object - - - - Microsoft.CodeAnalysis.ISourceGenerator - - - - - [Microsoft.CodeAnalysis.Generator] - [<Microsoft.CodeAnalysis.Generator>] - - - - To be added. - To be added. - - - - - - - - - Constructor - - System.Text.Json.SourceGeneration - 6.0.0.0 - - - - To be added. - To be added. - - - - - - - - - - Method - - M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext) - - - System.Text.Json.SourceGeneration - 6.0.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Text.Json.SourceGeneration - 6.0.0.0 - - - System.Collections.Generic.Dictionary<System.String,System.Type> - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - M:Microsoft.CodeAnalysis.ISourceGenerator.Initialize(Microsoft.CodeAnalysis.GeneratorInitializationContext) - - - System.Text.Json.SourceGeneration - 6.0.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - diff --git a/xml/System.Text.Json/JsonSerializer.xml b/xml/System.Text.Json/JsonSerializer.xml index 8562af52812..00d2206b1be 100644 --- a/xml/System.Text.Json/JsonSerializer.xml +++ b/xml/System.Text.Json/JsonSerializer.xml @@ -2,9 +2,10 @@ - + + System.Text.Json 4.0.0.0 @@ -33,7 +34,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -72,7 +73,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -107,8 +108,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -172,7 +174,7 @@ There is remaining data in the span beyond a single JSON value. - + Method @@ -206,7 +208,7 @@ There is remaining data in the span beyond a single JSON value. - + Method @@ -253,10 +255,14 @@ Using a UTF-16 span is not as efficient as using the is . The JSON is invalid. - -or- - is not compatible with the JSON. - -or- - There is remaining data in the span beyond a single JSON value. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the span beyond a single JSON value. There is no compatible for or its serializable members. @@ -264,7 +270,7 @@ Using a UTF-16 span is not as efficient as using the - + Method @@ -298,13 +304,19 @@ Using a is not as efficient as using the or is . - -or- - is . + +-or- + + is . The JSON is invalid. - -or- - is not compatible with the JSON. - -or- - There is remaining data in the string beyond a single JSON value. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. There is no compatible for or its serializable members. The method of the provided returns for the type to convert. @@ -313,8 +325,9 @@ Using a is not as efficient as using the - + + Method @@ -381,7 +394,7 @@ There is remaining data in the string beyond a single JSON value. - + Method @@ -415,13 +428,276 @@ Using a is not as efficient as using the or is . - -or- - is . + +-or- + + is . + The JSON is invalid. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. + There is no compatible for or its serializable members. + The method of the provided returns for the type to convert. + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Object + + + + + + + + The to convert. + The type of the object to convert to and return. + Options to control the behavior during parsing. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + or is . + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + + + + + The to convert. + The type of the object to convert to and return. + A metadata provider for serializable types. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + +-or- + + is . + +-or- + + is . + The JSON is invalid. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. + There is no compatible for or its serializable members. + The method of the provided returns for the type to convert. + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Object + + + + + + + + The to convert. + The type of the object to convert to and return. + Options to control the behavior during parsing. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + + + + + The to convert. + The type of the object to convert to and return. + A metadata provider for serializable types. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + +-or- + + is . + The JSON is invalid. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. + There is no compatible for or its serializable members. + The method of the provided returns for the type to convert. + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Object + + + + + + + + The to convert. + The type of the object to convert to and return. + Options to control the behavior during parsing. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + + + + + The to convert. + The type of the object to convert to and return. + A metadata provider for serializable types. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + +-or- + + is . The JSON is invalid. - -or- - is not compatible with the JSON. - -or- - There is remaining data in the string beyond a single JSON value. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. There is no compatible for or its serializable members. The method of the provided returns for the type to convert. @@ -430,8 +706,9 @@ Using a is not as efficient as using the - + + Method @@ -504,7 +781,7 @@ A value could not be read from the reader. - + Method @@ -571,7 +848,7 @@ A value could not be read from the reader. - + Method @@ -595,7 +872,7 @@ A value could not be read from the reader. - To be added. + The type to deserialize the JSON value into. JSON data to parse. Options to control the behavior during reading. Reads the UTF-8 encoded text representing a single JSON value into a . @@ -612,7 +889,7 @@ A value could not be read from the reader. - + Method @@ -631,7 +908,7 @@ A value could not be read from the reader. - To be added. + The type to deserialize the JSON value into. JSON data to parse. Metadata about the type to convert. Reads the UTF-8 encoded text representing a single JSON value into a . @@ -648,8 +925,9 @@ A value could not be read from the reader. - + + Method @@ -706,7 +984,7 @@ There is remaining data in the span beyond a single JSON value. - + Method @@ -725,7 +1003,7 @@ There is remaining data in the span beyond a single JSON value. - To be added. + The type to deserialize the JSON value into. JSON text to parse. Metadata about the type to convert. Parses the UTF-8 encoded text representing a single JSON value into a . @@ -739,7 +1017,7 @@ There is remaining data in the span beyond a single JSON value. - + Method @@ -763,7 +1041,7 @@ There is remaining data in the span beyond a single JSON value. - To be added. + The type to deserialize the JSON value into. The JSON text to parse. Options to control the behavior during parsing. Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter. @@ -779,10 +1057,14 @@ Using a UTF-16 span is not as efficient as using the ]]> The JSON is invalid. - -or- - is not compatible with the JSON. - -or- - There is remaining data in the span beyond a single JSON value. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the span beyond a single JSON value. There is no compatible for or its serializable members. @@ -790,7 +1072,7 @@ Using a UTF-16 span is not as efficient as using the - + Method @@ -809,7 +1091,7 @@ Using a UTF-16 span is not as efficient as using the - To be added. + The type to deserialize the JSON value into. JSON text to parse. Metadata about the type to convert. Parses the text representing a single JSON value into a . @@ -826,13 +1108,19 @@ Using a is not as efficient as using the is . - -or- - is . + +-or- + + is . The JSON is invalid. - -or- - is not compatible with the JSON. - -or- - There is remaining data in the string beyond a single JSON value. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. There is no compatible for or its serializable members. @@ -840,8 +1128,9 @@ Using a is not as efficient as using the - + + Method @@ -902,7 +1191,7 @@ There is remaining data in the string beyond a single JSON value. - + Method @@ -921,7 +1210,7 @@ There is remaining data in the string beyond a single JSON value. - To be added. + The type to deserialize the JSON value into. JSON text to parse. Metadata about the type to convert. Parses the text representing a single JSON value into a . @@ -938,29 +1227,31 @@ Using a is not as efficient as using the is . - -or- - is . + +-or- + + is . The JSON is invalid. - -or- - is not compatible with the JSON. - -or- - There is remaining data in the string beyond a single JSON value. + +-or- + + is not compatible with the JSON. + +-or- + +There is remaining data in the string beyond a single JSON value. There is no compatible for or its serializable members. - - - - - - + + + + + Method System.Text.Json - 4.0.0.0 - 4.0.1.0 - 5.0.0.0 6.0.0.0 @@ -976,8 +1267,244 @@ Using a is not as efficient as using the - - + + + + + The type to deserialize the JSON value into. + The to convert. + Options to control the behavior during parsing. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + TValue + + + + + + + + + + The type to deserialize the JSON value into. + The to convert. + Metadata about the type to convert. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + +-or- + + is . + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + TValue + + + + + + + + + + The type to deserialize the JSON value into. + The to convert. + Options to control the behavior during parsing. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + TValue + + + + + + + + + + The type to deserialize the JSON value into. + The to convert. + Metadata about the type to convert. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + TValue + + + + + + + + + + The type to deserialize the JSON value into. + The to convert. + Options to control the behavior during parsing. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + TValue + + + + + + + + + + The type to deserialize the JSON value into. + The to convert. + Metadata about the type to convert. + Converts the representing a single JSON value into a . + A representation of the JSON value. + To be added. + + is . + + is not compatible with the JSON. + There is no compatible for or its serializable members. + + + + + + + + + + + Method + + System.Text.Json + 4.0.0.0 + 4.0.1.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + TValue + + + + + + + The target type of the JSON value. @@ -1020,7 +1547,7 @@ A value could not be read from the reader. - + Method @@ -1039,7 +1566,7 @@ A value could not be read from the reader. - To be added. + The type to deserialize the JSON value into. The reader to read. Metadata about the type to convert. Reads one JSON value (including objects or arrays) from the provided reader into a . @@ -1086,8 +1613,9 @@ A value could not be read from the reader. - + + Method @@ -1153,7 +1681,7 @@ There is remaining data in the stream. - + Method @@ -1189,8 +1717,9 @@ There is remaining data in the stream. - + + Method @@ -1251,7 +1780,7 @@ There is remaining data in the stream. - + Method @@ -1270,7 +1799,7 @@ There is remaining data in the stream. - To be added. + The type to deserialize the JSON value into. JSON data to parse. Metadata about the type to convert. The which may be used to cancel the read operation. @@ -1288,7 +1817,7 @@ There is remaining data in the stream. - + Method @@ -1313,7 +1842,7 @@ There is remaining data in the stream. - To be added. + The element type to deserialize asynchronously. JSON data to parse. Options to control the behavior during reading. The which may be used to cancel the read operation. @@ -1328,8 +1857,9 @@ There is remaining data in the stream. - + + Method @@ -1388,7 +1918,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1431,7 +1961,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1471,7 +2001,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1506,8 +2036,9 @@ Using a is not as efficient as using UTF-8 - + + Method @@ -1567,7 +2098,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1585,7 +2116,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. + A JSON writer to write to. The value to convert and write. The type of the to convert. A metadata provider for serializable types. @@ -1603,8 +2134,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -1654,7 +2186,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1673,7 +2205,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. + The type of the value to serialize. The value to convert. Metadata about the type to convert. Converts the provided value into a . @@ -1698,7 +2230,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1723,7 +2255,7 @@ Using a is not as efficient as using UTF-8 - To be added. + The type of the value to serialize. The UTF-8 to write to. The value to convert. Options to control the conversion behavior. @@ -1738,7 +2270,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1758,7 +2290,7 @@ Using a is not as efficient as using UTF-8 - To be added. + The type of the value to serialize. The UTF-8 to write to. The value to convert. Metadata about the type to convert. @@ -1773,8 +2305,9 @@ Using a is not as efficient as using UTF-8 - + + Method @@ -1827,7 +2360,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1847,7 +2380,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. + The type of the value to serialize. The writer to write. The value to convert and write. Metadata about the type to convert. @@ -1862,8 +2395,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -1924,7 +2458,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1961,8 +2495,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -2016,7 +2551,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -2036,7 +2571,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. + The type of the value to serialize. The UTF-8 to write to. The value to convert. Metadata about the type to convert. @@ -2049,12 +2584,444 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa There is no compatible for or its serializable members. + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Text.Json.JsonDocument + + + + + + + + The value to convert. + The type of the to convert. + Options to control the conversion behavior. + Converts the provided value into a . + A representation of the value. + To be added. + + is not compatible with . + + is . + + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonDocument + + + + + + + + The value to convert. + The type of the to convert. + A metadata provider for serializable types. + Converts the provided value into a . + A representation of the value. + To be added. + There is no compatible for or its serializable members. + The method of the provided returns for the type to convert. + + or is . + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Text.Json.JsonDocument + + + + + + + + + + The type of the value to serialize. + The value to convert. + Options to control the conversion behavior. + Converts the provided value into a . + A representation of the JSON value. + To be added. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonDocument + + + + + + + + + + The type of the value to serialize. + The value to convert. + Metadata about the type to convert. + Converts the provided value into a . + A representation of the value. + To be added. + There is no compatible for or its serializable members. + + is . + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Text.Json.JsonElement + + + + + + + + The value to convert. + The type of the to convert. + Options to control the conversion behavior. + Converts the provided value into a . + A representation of the value. + To be added. + + is not compatible with . + + is . + + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonElement + + + + + + + + The value to convert. + The type of the to convert. + A metadata provider for serializable types. + Converts the provided value into a . + A representation of the value. + To be added. + There is no compatible for or its serializable members. + The method of the provided returns for the type to convert. + + or is . + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Text.Json.JsonElement + + + + + + + + + + The type of the value to serialize. + The value to convert. + Options to control the conversion behavior. + Converts the provided value into a . + A representation of the JSON value. + To be added. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonElement + + + + + + + + + + The type of the value to serialize. + The value to convert. + Metadata about the type to convert. + Converts the provided value into a . + A representation of the value. + To be added. + There is no compatible for or its serializable members. + + is . + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Text.Json.Nodes.JsonNode + + + + + + + + The value to convert. + The type of the to convert. + Options to control the conversion behavior. + Converts the provided value into a . + A representation of the value. + To be added. + + is not compatible with . + + is . + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.Nodes.JsonNode + + + + + + + + The value to convert. + The type of the to convert. + A metadata provider for serializable types. + Converts the provided value into a . + A representation of the value. + To be added. + There is no compatible for or its serializable members. + The method of the provided returns for the type to convert. + + or is . + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>] + + + + System.Text.Json.Nodes.JsonNode + + + + + + + + + + The type of the value to serialize. + The value to convert. + Options to control the conversion behavior. + Converts the provided value into a . + A representation of the JSON value. + To be added. + There is no compatible for or its serializable members. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.Nodes.JsonNode + + + + + + + + + + The type of the value to serialize. + The value to convert. + Metadata about the type to convert. + Converts the provided value into a . + A representation of the value. + To be added. + There is no compatible for or its serializable members. + + is . + + - + + Method @@ -2111,7 +3078,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -2146,8 +3113,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -2195,7 +3163,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -2214,7 +3182,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. + The type of the value to serialize. The value to convert. Metadata about the type to convert. Converts the provided value into a array. diff --git a/xml/System.Text.RegularExpressions/Capture.xml b/xml/System.Text.RegularExpressions/Capture.xml index 4991ed1c377..04bcbfa785b 100644 --- a/xml/System.Text.RegularExpressions/Capture.xml +++ b/xml/System.Text.RegularExpressions/Capture.xml @@ -313,5 +313,32 @@ + + + + + + + + Property + + System.Text.RegularExpressions + 6.0.0.0 + + + System + + + netstandard + + + System.ReadOnlySpan<System.Char> + + + Gets the captured span from the input string. + The span that is captured by the match. + To be added. + + diff --git a/xml/System.Text/Rune.xml b/xml/System.Text/Rune.xml index ce2d16bef24..f883d9dd240 100644 --- a/xml/System.Text/Rune.xml +++ b/xml/System.Text/Rune.xml @@ -1750,8 +1750,7 @@ For more information, see - The object to compare with the current instance. - To be added. + The object to compare with the current instance. Compares the current instance to the specified object. A signed integer indicating the position of this instance in the sort order in relation to :
- Less than zero: This instance precedes .
- Zero: The instance has the same position in the sort order as . diff --git a/xml/System.Text/SpanLineEnumerator.xml b/xml/System.Text/SpanLineEnumerator.xml index ec6bdd33aa1..91e65bd9a1b 100644 --- a/xml/System.Text/SpanLineEnumerator.xml +++ b/xml/System.Text/SpanLineEnumerator.xml @@ -49,7 +49,7 @@ To get an instance of this type, use Gets the line at the current position of the enumerator. - To be added. + The line at the current position of the enumerator. To be added. @@ -71,8 +71,8 @@ To get an instance of this type, use Returns this instance as an enumerator. - To be added. - To be added. + This instance as an enumerator. + This method is called automatically by the compiler. It is not intended to be called directly by application code. @@ -94,7 +94,8 @@ To get an instance of this type, use Advances the enumerator to the next line of the span. - if the enumerator successfully advanced to the next line; if the enumerator has advanced past the end of the span. + if the enumerator successfully advanced to the next line; if the enumerator has advanced past the end of the span. + To be added. diff --git a/xml/System.Text/StringBuilder+AppendInterpolatedStringHandler.xml b/xml/System.Text/StringBuilder+AppendInterpolatedStringHandler.xml index b354f805734..8896fb83d2a 100644 --- a/xml/System.Text/StringBuilder+AppendInterpolatedStringHandler.xml +++ b/xml/System.Text/StringBuilder+AppendInterpolatedStringHandler.xml @@ -250,7 +250,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. Writes the specified value to the handler. To be added. @@ -279,7 +279,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. The minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. Writes the specified value to the handler. @@ -309,7 +309,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. The format string. Writes the specified value to the handler. @@ -340,7 +340,7 @@ This is intended to be called only by compiler-generated code. Arguments are not - To be added. + The type of the value to write. The value to write. The minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. The format string. diff --git a/xml/System.Threading/Overlapped.xml b/xml/System.Threading/Overlapped.xml index 140f6b13c1d..7ab7e727680 100644 --- a/xml/System.Threading/Overlapped.xml +++ b/xml/System.Threading/Overlapped.xml @@ -133,10 +133,14 @@ 6.0.0.0 - + [System.Obsolete("This constructor is not 64-bit compatible. Use the constructor that takes an IntPtr for the event handle. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor is not 64-bit compatible. Use the constructor that takes an IntPtr for the event handle. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor is not 64-bit compatible and has been deprecated. Use the constructor that accepts an IntPtr for the event handle instead.")] + [<System.Obsolete("This constructor is not 64-bit compatible and has been deprecated. Use the constructor that accepts an IntPtr for the event handle instead.")>] + [System.Obsolete("This constructor is not 64-bit compatible. Use the constructor that takes an IntPtr for the event handle. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This constructor is not 64-bit compatible. Use the constructor that takes an IntPtr for the event handle. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -289,10 +293,14 @@ 6.0.0.0 - + [System.Obsolete("This property is not 64-bit compatible. Use EventHandleIntPtr instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property is not 64-bit compatible. Use EventHandleIntPtr instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Overlapped.EventHandle is not 64-bit compatible and has been deprecated. Use EventHandleIntPtr instead.")] + [<System.Obsolete("Overlapped.EventHandle is not 64-bit compatible and has been deprecated. Use EventHandleIntPtr instead.")>] + [System.Obsolete("This property is not 64-bit compatible. Use EventHandleIntPtr instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property is not 64-bit compatible. Use EventHandleIntPtr instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -544,10 +552,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("This method is not safe. Use Pack (iocb, userData) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method is not safe. Use Pack (iocb, userData) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This overload is not safe and has been deprecated. Use Pack(IOCompletionCallback?, object?) instead.")] + [<System.Obsolete("This overload is not safe and has been deprecated. Use Pack(IOCompletionCallback?, object?) instead.")>] + [System.Obsolete("This method is not safe. Use Pack (iocb, userData) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method is not safe. Use Pack (iocb, userData) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -756,10 +768,14 @@ [System.CLSCompliant(false)] [<System.CLSCompliant(false)>] - + [System.Obsolete("This method is not safe. Use UnsafePack (iocb, userData) instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method is not safe. Use UnsafePack (iocb, userData) instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This overload is not safe and has been deprecated. Use UnsafePack(IOCompletionCallback?, object?) instead.")] + [<System.Obsolete("This overload is not safe and has been deprecated. Use UnsafePack(IOCompletionCallback?, object?) instead.")>] + [System.Obsolete("This method is not safe. Use UnsafePack (iocb, userData) instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method is not safe. Use UnsafePack (iocb, userData) instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Threading/Thread.xml b/xml/System.Threading/Thread.xml index a1b153549b2..e080d174d0d 100644 --- a/xml/System.Threading/Thread.xml +++ b/xml/System.Threading/Thread.xml @@ -927,10 +927,14 @@ This method is obsolete. On .NET 5.0 and later versions, calling this method pro 6.0.0.0 - + [System.Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.", false)] [<System.Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.", false)>] + + [System.Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.")] + [<System.Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.")>] + [get: System.Security.SecuritySafeCritical] [<get: System.Security.SecuritySafeCritical>] @@ -1887,10 +1891,14 @@ This method is obsolete. On .NET 5.0 and later versions, calling this method pro 6.0.0.0 - + [System.Obsolete("Thread.GetCompressedStack is no longer supported. Please use the System.Threading.CompressedStack class")] [<System.Obsolete("Thread.GetCompressedStack is no longer supported. Please use the System.Threading.CompressedStack class")>] + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Security.SecurityCritical] [<System.Security.SecurityCritical>] @@ -3066,10 +3074,14 @@ The value is not guaranteed to be a zero-based processor number. 6.0.0.0 - + [System.Obsolete("Thread.Resume has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. https://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("Thread.Resume has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. https://go.microsoft.com/fwlink/?linkid=14202", false)>] + + [System.Obsolete("Thread.Resume has been deprecated. Use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources.")] + [<System.Obsolete("Thread.Resume has been deprecated. Use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources.")>] + [System.Obsolete("Thread.Resume has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. http://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("Thread.Resume has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. http://go.microsoft.com/fwlink/?linkid=14202", false)>] @@ -3206,10 +3218,14 @@ The value is not guaranteed to be a zero-based processor number. 6.0.0.0 - + [System.Obsolete("Thread.SetCompressedStack is no longer supported. Please use the System.Threading.CompressedStack class")] [<System.Obsolete("Thread.SetCompressedStack is no longer supported. Please use the System.Threading.CompressedStack class")>] + + [System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Security.SecurityCritical] [<System.Security.SecurityCritical>] @@ -3709,10 +3725,14 @@ The value is not guaranteed to be a zero-based processor number. 6.0.0.0 - + [System.Obsolete("Thread.Suspend has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. https://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("Thread.Suspend has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. https://go.microsoft.com/fwlink/?linkid=14202", false)>] + + [System.Obsolete("Thread.Suspend has been deprecated. Use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources.")] + [<System.Obsolete("Thread.Suspend has been deprecated. Use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources.")>] + [System.Obsolete("Thread.Suspend has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. http://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("Thread.Suspend has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. http://go.microsoft.com/fwlink/?linkid=14202", false)>] diff --git a/xml/System.Threading/ThreadPool.xml b/xml/System.Threading/ThreadPool.xml index 64a33502adb..2483b7d1975 100644 --- a/xml/System.Threading/ThreadPool.xml +++ b/xml/System.Threading/ThreadPool.xml @@ -147,10 +147,14 @@ 6.0.0.0 - + [System.Obsolete("ThreadPool.BindHandle(IntPtr) has been deprecated. Please use ThreadPool.BindHandle(SafeHandle) instead.", false)] [<System.Obsolete("ThreadPool.BindHandle(IntPtr) has been deprecated. Please use ThreadPool.BindHandle(SafeHandle) instead.", false)>] + + [System.Obsolete("ThreadPool.BindHandle(IntPtr) has been deprecated. Use ThreadPool.BindHandle(SafeHandle) instead.")] + [<System.Obsolete("ThreadPool.BindHandle(IntPtr) has been deprecated. Use ThreadPool.BindHandle(SafeHandle) instead.")>] + [System.Runtime.Versioning.SupportedOSPlatform("windows")] [<System.Runtime.Versioning.SupportedOSPlatform("windows")>] diff --git a/xml/System.Threading/WaitHandle.xml b/xml/System.Threading/WaitHandle.xml index 67b290f6dd5..45cb2f48959 100644 --- a/xml/System.Threading/WaitHandle.xml +++ b/xml/System.Threading/WaitHandle.xml @@ -403,10 +403,14 @@ Application code does not call this method; it is automatically invoked during g 6.0.0.0 - + [System.Obsolete("Use the SafeWaitHandle property instead.")] [<System.Obsolete("Use the SafeWaitHandle property instead.")>] + + [System.Obsolete("WaitHandle.Handle has been deprecated. Use the SafeWaitHandle property instead.")] + [<System.Obsolete("WaitHandle.Handle has been deprecated. Use the SafeWaitHandle property instead.")>] + [get: System.Security.SecuritySafeCritical] [<get: System.Security.SecuritySafeCritical>] diff --git a/xml/System.Windows.Automation.Peers/RibbonTabDataAutomationPeer.xml b/xml/System.Windows.Automation.Peers/RibbonTabDataAutomationPeer.xml index 1ef0d55fdce..36f072cddcf 100644 --- a/xml/System.Windows.Automation.Peers/RibbonTabDataAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/RibbonTabDataAutomationPeer.xml @@ -1,329 +1,337 @@ - - - - - - - - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.SelectorItemAutomationPeer - - - - System.Windows.Automation.Provider.IExpandCollapseProvider - - - System.Windows.Automation.Provider.IScrollItemProvider - - - System.Windows.Automation.Provider.ISelectionItemProvider - - - - Exposes types to UI Automation. - To be added. - - - - - - - - - - Constructor - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The element associated with this automation peer. - The that is associated with the that holds the . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationControlType - - - - Gets the control type for the that is associated with this . This method is called by . - The enumeration value. - To be added. - - - - - - - - - - Method - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the class name of the that is associated with this . This method is called by . - The class name of the that is associated with this . - To be added. - - - - - - - - - - Method - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - A value enumeration that specifies the control pattern. - Gets the control pattern for the that is associated with the . - An object that supports the control pattern if is , , , , , , or ; otherwise, . - To be added. - - - - - - - - - - Method - - M:System.Windows.Automation.Provider.IExpandCollapseProvider.Collapse - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Hides all nodes, controls, or content that are descendants of the control. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Automation.Provider.IExpandCollapseProvider.Expand - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Displays all child nodes, controls, or content of the control. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Property - - P:System.Windows.Automation.Provider.IExpandCollapseProvider.ExpandCollapseState - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.ExpandCollapseState - - - Gets the state, expanded or collapsed, of the control that is associated with this . - The state of the control that is associated with this . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Automation.Provider.IScrollItemProvider.ScrollIntoView - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Scrolls the content area of a container object in order to display the control within the visible region of the container. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Automation.Provider.ISelectionItemProvider.AddToSelection - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - This API is not implemented. - To be added. - The user cannot interact with the that is associated with the . - A element other than the that is associated with this is selected. - - - - - - - - - - Method - - M:System.Windows.Automation.Provider.ISelectionItemProvider.RemoveFromSelection - - - System.Windows.Controls.Ribbon - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - This API is not implemented. - - instance is cast to an interface. - - ]]> - - The that is associated with this is selected. - - - - + + + + + + + + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.SelectorItemAutomationPeer + + + + System.Windows.Automation.Provider.IExpandCollapseProvider + + + System.Windows.Automation.Provider.IScrollItemProvider + + + System.Windows.Automation.Provider.ISelectionItemProvider + + + + Exposes types to UI Automation. + To be added. + + + + + + + + + + Constructor + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The element associated with this automation peer. + The that is associated with the that holds the . + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationControlType + + + + Gets the control type for the that is associated with this . This method is called by . + The enumeration value. + To be added. + + + + + + + + + + Method + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the class name of the that is associated with this . This method is called by . + The class name of the that is associated with this . + To be added. + + + + + + + + + + Method + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + A value enumeration that specifies the control pattern. + Gets the control pattern for the that is associated with the . + An object that supports the control pattern if is , , , , , , or ; otherwise, . + To be added. + + + + + + + + + + Method + + M:System.Windows.Automation.Provider.IExpandCollapseProvider.Collapse + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Hides all nodes, controls, or content that are descendants of the control. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Automation.Provider.IExpandCollapseProvider.Expand + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Displays all child nodes, controls, or content of the control. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + P:System.Windows.Automation.Provider.IExpandCollapseProvider.ExpandCollapseState + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.ExpandCollapseState + + + Gets the state, expanded or collapsed, of the control that is associated with this . + The state of the control that is associated with this . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Automation.Provider.IScrollItemProvider.ScrollIntoView + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Scrolls the content area of a container object in order to display the control within the visible region of the container. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Automation.Provider.ISelectionItemProvider.AddToSelection + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + This API is not implemented. + + instance is cast to an interface. + + ]]> + + The user cannot interact with the that is associated with the . + A element other than the that is associated with this is selected. + + + + + + + + + + Method + + M:System.Windows.Automation.Provider.ISelectionItemProvider.RemoveFromSelection + + + System.Windows.Controls.Ribbon + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + This API is not implemented. + + instance is cast to an interface. + + ]]> + + The that is associated with this is selected. + + + + diff --git a/xml/System.Windows.Automation/AutomationElement.xml b/xml/System.Windows.Automation/AutomationElement.xml index 94688d5bcf5..8061fe4400b 100644 --- a/xml/System.Windows.Automation/AutomationElement.xml +++ b/xml/System.Windows.Automation/AutomationElement.xml @@ -1,3986 +1,3986 @@ - - - - - - - - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Represents a UI Automation element in the UI Automation tree, and contains values used as identifiers by UI Automation client applications. - - corresponds to a piece of user interface (UI), regardless of underlying implementation (such as Windows Presentation Foundation (WPF) or Win32). - - ]]> - - UI Automation Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Accelerator key combinations invoke an action. For example, CTRL+O is often used to invoke the **Open** file common dialog box. An that has the accelerator key property set always implements the class. - - Return values of the property are of type . The default value for the property is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet124"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet124"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet125"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet125"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - An access key is a character in the text of a menu, menu item, or label of a control such as a button that activates the attached menu function. For example, the letter "O" is often used to invoke the **File Open** common dialog box from a **File** menu. - - Access key values are of type and contain the character registered as the access key for the element. The default value for the string is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet127"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet127"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet128"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet128"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - To be added. - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies an event raised during asynchronous content-loading. - - . - - This event is used mainly by providers to indicate that asynchronous content-loading events have occurred. - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies an event that is raised when the focus has changed. - - . - - ]]> - - - TrackFocus Sample - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property, which is used to identify elements. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is an empty string. - - When it is available the of an element is expected to always be the same in any instance of the application regardless of the local language. The value should be unique among sibling elements but not necessarily unique across the entire desktop. For example, multiple instances of an application, or multiple folder views in Microsoft Windows Explorer, may contain elements with the same , such as "SystemMenuBar". - - While support of an is always recommended for better testability, this property is not mandatory. Where it is supported, an is useful for creating test automation scripts that run regardless of UI language. Clients should make no assumptions regarding the s exposed by other applications. An is not necessarily guaranteed to be stable across different releases or builds of an application. - - Instances of user interface (UI) elements are uniquely identified on the desktop by their properties. - -> [!NOTE] -> is supported by all UI Automation elements in the control view except top-level application windows, UI Automation elements derived from Windows Presentation Foundation (WPF) controls that do not have an ID or x:Uid, and UI Automation elements derived from Win32 controls that do not have a control ID. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet129"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet129"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet130"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet130"::: - - ]]> - - - UI Automation Properties Overview - Obtaining UI Automation Elements - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies a property-changed event. - - . - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Bounding rectangles are of type . The returned rectangle is in physical screen coordinates. The default value is . is returned if the item is not currently displaying a user interface (UI). - - The returned rectangle can contain points that are not clickable. Instances where this could happen include when the UI item has an irregular shape or clickable region, or it is obscured by other UI elements. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet131"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet131"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet132"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet132"::: - - ]]> - - UI Automation Properties Overview - UI Automation and Screen Scaling - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement+AutomationElementInformation - - - Gets the cached UI Automation property values for this object. - A structure containing the cached property values for the . - - . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . - - To get the current value of UI Automation properties on this element use the property. - - - -## Examples - The following example shows how the property can be cached and then retrieved by using the property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: - - ]]> - - There are no cached properties. - The UI for the no longer exists. - UI Automation Properties Overview - Caching in UI Automation Clients - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElementCollection - - - Gets the cached child elements of this . - The collection of child elements. This collection can be empty if the element has no children. - - condition of the that was active when this object was obtained. - - Children are cached only if the scope of the included , , or . - - If the specified that children were to be cached at this level, but there are no children, then the value of this property is 0. However, if no request was made to cache children at this level, an attempt to retrieve the property raises an exception. - - - -## Examples - In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: - - ]]> - - The UI for the no longer exists. - No request was made to cache the children of this element. - Caching in UI Automation Clients - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - Gets the cached parent of this . - The parent element. The return value can be if the specified element has no parent - for example, if this element is the root node. - - properties of a list box and its list items are cached. The list box element is available in the property of each list item element. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: - - ]]> - - No parent element is cached. - The UI for the no longer exists. - Caching in UI Automation Clients - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The class name depends on the implementation of the UI Automation provider and therefore cannot be counted upon to be in a standard format. However, if you know the class name you can use it to verify that your application is working with the expected UI Automation element. - - Return values of the property are of type . The default value is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet133"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet133"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet134"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet134"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the clickable point property. - - . - - An is not clickable if it is completely obscured by another window. - - Return values of the property are of type . The default value is `null`. - - The value returned is in physical screen coordinates. - - - -## Examples - The following example retrieves the current value of the property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet135"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet135"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet166"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet166"::: - - ]]> - - - - UI Automation Properties Overview - UI Automation and Screen Scaling - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The default value for the property is - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet136"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet136"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet137"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet137"::: - - ]]> - - UI Automation Properties Overview - UI Automation Control Types - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the culture property. - - . - - Within the Windows Presentation Foundation (WPF) framework, the default value reported will always be `en-US` because the .NET Framework automatically defaults to English. For other user interface (UI) frameworks, this property must be explicitly set or it will not be exposed. - - This property can exist on a per-control basis, but typically is only available on an application level. - - Return values of the property are of type . - - - -## Examples - The following example retrieves the current value of the property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet138"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet138"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement+AutomationElementInformation - - - Gets the current property values of the . - A structure containing the current property values. - - . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . - - To get the cached value of UI Automation properties on this element, use the property. - - - -## Examples - The following example shows how the property is used to retrieve the name of an item that has been selected in a list. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet106"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet106"::: - - ]]> - - The UI for the no longer exists. - UI Automation Properties Overview - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - An to compare. - Determines whether the specified has the same value as this . - - if the specified is equal to this ;otherwise . - - objects refer to the same underlying user interface element; that is, that they have the same run-time identifier. - - This method is equivalent to the equality operator, which also compare run-time identifiers. - - ]]> - - - - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. - To be added. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElementCollection - - - - - - - A bitwise combination of values that specifies the scope of the search. - The object containing the criteria to match. - Returns all objects that satisfy the specified condition. - A collection of objects that satisfies the specified condition. If there are no matches, an empty collection is returned. - - in `scope`, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. - - If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. - - - -## Examples - The following example shows how to use to locate all enabled buttons in a window. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet116"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet116"::: - - ]]> - - - Obtaining UI Automation Elements - UI Automation Threading Issues - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - - - - - A bitwise combination of values that specifies the scope of the search. - The object containing the criteria to match. - Returns the first child or descendant element that matches the specified condition. - The first element that satisfies the condition, or if no match is found. - - in `scope`, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. - - If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. - - - -## Examples - The following example shows how to find a child window from its identifier. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet110"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet110"::: - - ]]> - - - Obtaining UI Automation Elements - UI Automation Threading Issues - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - Gets the that currently has focus. - The focused UI element. - - - - UI Automation Threading Issues - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - Return values of the property are of type . The default value is an empty string. - - This property enables applications to apply special cases to entire UI frameworks. Examples of property values are "Win32", "WinForm", and "DirectUI". - - - -## Examples - The following example retrieves the current value of the property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet139"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet139"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - - - - The handle of the UI element. - Retrieves a new object for the user interface (UI) item referenced by the specified window handle. - An for the UI item identified by . - To be added. - - Obtaining UI Automation Elements - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - - - - The provider object. - Retrieves a new object from a local implementation. - An that represents the element served by the provider object. - - to clients that want to get a UI Automation element directly from a . - - ]]> - - Obtaining UI Automation Elements - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - - - - The physical screen coordinates on the desktop at which to locate the UI element. - Retrieves a new object for the user interface (UI) item at specified point on the desktop. - The UI item at the specified point. - - returns the element in the logical tree that is closest to the root element. - - If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. - - Although the point is within the bounding rectangle of the returned , it is not necessarily on a clickable part of the control. For example, a round button might not be clickable near one of the corners of its bounding rectangle. - - - -## Examples - The following example retrieves the at the system cursor location. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet181"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet181"::: - - ]]> - - - Obtaining UI Automation Elements - UI Automation and Screen Scaling - UI Automation Threading Issues - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - The identifier of the pattern to retrieve. - Retrieves the specified pattern from the cache of this . - An object representing the specified pattern. If there are no matching patterns, is returned. - - retrieves the specified pattern from the cache. To retrieve the current object for the specified pattern, call . - - This method throws an exception if the requested pattern was not previously cached. - - - -## Examples - The following example shows how to cache and retrieve a pattern. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - The requested pattern is not in the cache or is not supported by the element. - The UI for the no longer exists. - Caching in UI Automation Clients - - - - - UIAutomationClient - 4.0.0.0 - - - Retrieves the cached value of the specified property from an . - - retrieves the specified property from the cache of the . To retrieve the current property, call . - - ]]> - - - Caching in UI Automation Clients - UI Automation Properties for Clients - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Object - - - - - - The identifier of the property to retrieve. - Retrieves the value of the specified property from the cache of this . An appropriate default value for the property type is returned for properties not explicitly supported by the target user interface (UI) element. - An object containing the value of the specified property. - - , such as . - - retrieves the specified property from the 's cache. To retrieve the current object for the specified property call . - - This method throws an exception if the requested property was not previously cached. - - - -## Examples - The following shows how this method can be used to retrieve a cached property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - The requested property is not in the cache. - The user interface (UI) for the no longer exists. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - - The identifier of the property to retrieve. - A value that specifies whether a default value should be ignored if the specified property is not supported. - Retrieves the value of the specified property from the cache of this , optionally ignoring any default property. - An object containing the value of the specified property, or if the element does not supply a value and is . - - retrieves the specified property from the cache for the . To retrieve the current property, call . - - Passing `false` in `ignoreDefaultValue` is equivalent to calling . - - If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if `ignoreDefaultValue` is `false`, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . - - This method throws an exception if the requested property was not previously cached. - - - -## Examples - The following example shows how this method can be used to retrieve a cached property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - The requested property is not in the cache. - The UI for the no longer exists. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - Retrieves a point on the that can be clicked. - The physical screen coordinates of a point that can be used by a client to click on this element. - - is not clickable if it is completely obscured by another window. - - An is clickable when it satisfies all the following conditions: - -- It is programmatically visible and available with the UI Automation tree. - -- It is scrolled fully into view within its parent container, if any. If the element is clipped, there is no guarantee that it is clickable. - -- The element is not obscured by any other UI element. If the element is partially obscured by some UI element other than its ancestors, it might not be clickable. - -- The window containing the element must itself be clickable. For example, the window is not clickable if the containing window is completely transparent. Mouse clicks will click through to the window underneath, so any controls within the transparent window will not return clickable points. - -- If the element is a container (such as list or tree view), it must have a point that when clicked will cause the background of the control to be focused. If every part of the container control is occupied by a child element, it is not clickable. - - There is no guarantee that a control will do anything when clicked on a point defined as clickable by the UI Automation provider. Consider using control patterns instead to perform actions on controls. - - - -## Examples - The following code retrieves a clickable point for a control and moves the system cursor to that point. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet179"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet179"::: - - ]]> - - There is no clickable point. - The UI for the no longer exists. - - UI Automation and Screen Scaling - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - The identifier of the pattern to retrieve. - Retrieves the specified pattern object on this . - The pattern object, if the specified pattern is currently supported by the . - - gets the specified pattern based on its availability at the time of the call. - - For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching patterns and then retrieving them by using . - - - -## Examples - The following example shows how to use this method to retrieve a , which is then used to select an item in a list box. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet103"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet103"::: - -> [!NOTE] -> For often-repeated tasks such as the one in the example, it would be more efficient to cache the pattern and use . - - ]]> - - The pattern is not supported by the element. - The UI for the no longer exists. - UI Automation Control Patterns for Clients - - - - - UIAutomationClient - 4.0.0.0 - - - Retrieves the current value of the specified property from an . - - method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). - - For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . - - ]]> - - - UI Automation Properties for Clients - UI Automation Properties Overview - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Object - - - - - - The UI Automation property identifier specifying which property to retrieve. - Retrieves the value of the specified property on this . An appropriate default value for the property type is returned for properties not explicitly supported by the target user interface (UI) element. - An object containing the value of the specified property. - - method is current at the time it is called. The value can subsequently change by other applications interacting with the UI. - - If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . - - For some forms of UI, this method will incur cross-process performance overhead. Concentrate overhead by caching properties and then retrieving them by using . - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet126"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet126"::: - - ]]> - - The UI for the no longer exists. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - - The UI Automation property identifier specifying which property to retrieve. - A value that specifies whether a default value should be ignored if the specified property is supported. - Retrieves the value of the specified property on this , optionally ignoring any default property. - An object containing the value of the specified property, or if the element does not supply a value and is . - - . - - If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if `ignoreDefaultValue` is `false`, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . - - The value returned by the method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). - - For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . - - - -## Examples - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet123"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet123"::: - - ]]> - - The UI for the no longer exists. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Retrieves the hash code for this . - The 32-bit signed integer hash code. - To be added. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32[] - - - - Retrieves the unique identifier assigned to the user interface (UI) item. - An array of integers representing the run-time identifier. - - is in the cache. - - - -## Examples - The following example shows how to retrieve the run-time identifier of an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet111"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet111"::: - - ]]> - - The UI for the no longer exists. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationPattern[] - - - - Retrieves the control patterns that this supports. - An array of objects that represent the supported control patterns. - - for every possible pattern. Normally you would use to retrieve a specific control pattern from an . To ascertain whether a particular pattern is supported, check the appropriate property; for example, . - - - -## Examples - The following example shows how to retrieve the control patterns supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet114"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet114"::: - - ]]> - - UI Automation Control Patterns for Clients - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty[] - - - - Retrieves the identifiers of properties supported by the element. - An array of supported property identifiers. - - to determine whether a property is currently supported and to get its current value. - - - -## Examples - The following example shows how to retrieve the properties supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet115"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet115"::: - - ]]> - - UI Automation Properties for Clients - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - - - - The patterns and properties to include in the updated cache. - Retrieves a new with an updated cache. - A new that has an updated cache. - - is unchanged. returns a new , that refers to the same user interface (UI) and has the same . - - - -## Examples - The following example demonstrates how a cache might be updated whenever the selection in a combo box changes. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet109"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet109"::: - - ]]> - - Caching in UI Automation Clients - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet140"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet140"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - To be added. - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - This information is typically obtained from tooltips specified by providers. - - Return values of the property are of type . The default value for the property is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet126"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet126"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet123"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet123"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The content view of the UI Automation tree provides a view of the UI that only contains elements that represent data within the UI. - - An element must be a control to be able to hold content. - - Return values of the property are of type . The default value for the property is `true`. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet141"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet141"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet142"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet142"::: - - ]]> - - - UI Automation Properties Overview - UI Automation Tree Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Controls are elements that a user perceives as interactive or containing information in the UI. - - Return values of the property are of type . The default value for the property is `true`. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet143"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet143"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet144"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet144"::: - - ]]> - - - UI Automation Properties Overview - UI Automation Tree Overview - - - - - - - - - - Field - - UIAutomationClient - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - To be added. - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property, which specifies whether the user interface (UI) item referenced by the is enabled. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is `false`. - - When the enabled state of a control is `false`, it is assumed that child controls are also not enabled. You should not expect property-changed events from child elements when the state of the parent control changes. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet146"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet146"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example retrieves a value that specifies whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The property provides information necessary to the proper functioning of the method. - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet147"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet147"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property, which indicates whether the user interface (UI) item is visible on the screen. - - . - - This property can also be retrieved from the or properties. - - The return value is of type , and the default value is `false`. - - For more information about when this property is `true`, see . - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet148"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet148"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet149"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet149"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The return value for this property is a . It returns `true` to indicate that the content is protected; otherwise `false`. - - - -## Examples - The following example retrieves the current value of the property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet150"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet150"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The return value for this property is of type , and the default value is `false`. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet151"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet151"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available for this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that indicates whether the control pattern is available on this . - - . - - Return values of the property are of type . The default value for the property is `false`. - - - -## Examples - The following example ascertains whether a specified control pattern is supported by an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property, which specifies the status of the visual representation of a complex item. - - . - - The return value is a control-defined . The default value is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet152"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet152"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet153"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet153"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The return value is a control-defined . The default value is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet154"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet154"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, an application-defined string is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet155"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet155"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property, which identifies the label associated with a control. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is `null`. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet156"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet156"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet157"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet157"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies the event that is raised when the layout is invalidated. - - . - - This event is raised by a container of elements whenever the visibility information of many elements has changed. This event is used by the client as an indicator that it needs to refresh the and information that it may have cached for elements within the tree. The recommended number of changes that triggers this event is 25. - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property in the local language. - - . - - This property can also be retrieved from the or properties. - - A provider is required to expose this property when it represents a custom control that does not have a well-defined control type. - - Return values of the property are of type . The default value for the property is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet158"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet158"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet159"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet159"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies the event that is raised when a menu is closed. - - . - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies the event that is raised when a menu is opened. - - . - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is an empty string. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet160"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet160"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet161"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet161"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is 0. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet162"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet162"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet163"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet163"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - To be added. - To be added. - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - Indicates that a property is not supported. - - . - - - -## Examples - The following example retrieves the help text property for an , specifying that should be returned if the control does not support that property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet123"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet123"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The first to compare. - The second to compare. - Returns a value indicating whether the specified objects refer to the same user interface (UI) element. - - if the two objects refer to the same UI element; otherwise . - - objects that compare as equal might contain different cached information from different points in time. only tests that the objects refer to the same underlying UI element. - - ]]> - - - - - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The first to compare. - The second to compare. - Returns a value indicating whether the specified objects refer to different user interface (UI) elements. - - if the two objects refer to different UI elements; otherwise . - To be added. - - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - The value of the property is of type . The default value is . - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet164"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet164"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet165"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet165"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - UIAutomationClient - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Describes the ordinal location of an automation element within a set of elements that are considered to be siblings. - - to describe the ordinal location of an automation element in the set. - - ]]> - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property. - - . - - This property can also be retrieved from the or properties. - - Return values of the property are of type . The default value for the property is 0. - - - -## Examples - The following example retrieves the current value of the property. The default value is returned if the element does not provide one. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet167"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet167"::: - - The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet168"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet168"::: - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationElement - - - Gets the root for the current desktop. - The root element. - - and methods. - - When searching from the root element, be sure to specify in the scope of the search, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. - - - -## Examples - The following example code retrieves a collection of all the immediate children of the desktop. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet201"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet201"::: - - ]]> - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Identifies the property that contains the runtime identifier of the element. - - . - - The runtime ID property specifies an ID for an that is unique on the desktop. - - The return value of the property is an array of type . There is no default value. - - - -## Examples - The following example retrieves the current value of the property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet169"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet169"::: - - ]]> - - - - - - UI Automation Properties Overview - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Sets focus on the . - - - - The UI for the no longer exists. - - - - - - - - - - Field - - UIAutomationClient - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationProperty - - - Describes the count of automation elements in a group or set that are considered to be siblings. - - to describe the count of items in the set. - - ]]> - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies the event that is raised when the UI Automation tree structure is changed. - - . - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies the event that is raised when a tooltip is closed. - - . - - ]]> - - - - - - - - - - - - Field - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationEvent - - - Identifies the event that is raised when a tooltip is opened. - - . - - Tooltips are transitory on the desktop, and the tooltip might have closed by the time the client receives the event. - - ]]> - - - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The identifier of the control pattern to retrieve. - On return, contains the pattern if it is in the cache; otherwise . - Retrieves a control pattern from the cache. - - if the pattern is in the cache; if it is not in the cache or not supported. - - - - - - Caching in UI Automation Clients - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - When this method returns, contains the physical screen coordinates of a clickable point. - Retrieves a point within the element that can be clicked. - - if there is a point that is clickable; otherwise . - - is not clickable if it is completely obscured by another window. - - - -## Examples - The following example attempts to retrieve a clickable point on an . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet112"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet112"::: - - ]]> - - - UI Automation and Screen Scaling - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The identifier of the control pattern to retrieve. - On return, the control pattern if it is supported; otherwise . - Retrieves an object that implements a control pattern. - - if the pattern is supported; otherwise . - - . - - - -## Examples - The following example shows how to use this method to retrieve a control pattern. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet113"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet113"::: - - ]]> - - - - UI Automation Control Patterns for Clients - - - - + + + + + + + + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Represents a UI Automation element in the UI Automation tree, and contains values used as identifiers by UI Automation client applications. + + corresponds to a piece of user interface (UI), regardless of underlying implementation (such as Windows Presentation Foundation (WPF) or Win32). + + ]]> + + UI Automation Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Accelerator key combinations invoke an action. For example, CTRL+O is often used to invoke the **Open** file common dialog box. An that has the accelerator key property set always implements the class. + + Return values of the property are of type . The default value for the property is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet124"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet124"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet125"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet125"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + An access key is a character in the text of a menu, menu item, or label of a control such as a button that activates the attached menu function. For example, the letter "O" is often used to invoke the **File Open** common dialog box from a **File** menu. + + Access key values are of type and contain the character registered as the access key for the element. The default value for the string is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet127"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet127"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet128"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet128"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Event ID: ActiveTextPositionChanged - Indicates that the active position within a text element has changed. + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies an event raised during asynchronous content-loading. + + . + + This event is used mainly by providers to indicate that asynchronous content-loading events have occurred. + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies an event that is raised when the focus has changed. + + . + + ]]> + + + TrackFocus Sample + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property, which is used to identify elements. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is an empty string. + + When it is available the of an element is expected to always be the same in any instance of the application regardless of the local language. The value should be unique among sibling elements but not necessarily unique across the entire desktop. For example, multiple instances of an application, or multiple folder views in Microsoft Windows Explorer, may contain elements with the same , such as "SystemMenuBar". + + While support of an is always recommended for better testability, this property is not mandatory. Where it is supported, an is useful for creating test automation scripts that run regardless of UI language. Clients should make no assumptions regarding the s exposed by other applications. An is not necessarily guaranteed to be stable across different releases or builds of an application. + + Instances of user interface (UI) elements are uniquely identified on the desktop by their properties. + +> [!NOTE] +> is supported by all UI Automation elements in the control view except top-level application windows, UI Automation elements derived from Windows Presentation Foundation (WPF) controls that do not have an ID or x:Uid, and UI Automation elements derived from Win32 controls that do not have a control ID. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet129"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet129"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet130"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet130"::: + + ]]> + + + UI Automation Properties Overview + Obtaining UI Automation Elements + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies a property-changed event. + + . + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Bounding rectangles are of type . The returned rectangle is in physical screen coordinates. The default value is . is returned if the item is not currently displaying a user interface (UI). + + The returned rectangle can contain points that are not clickable. Instances where this could happen include when the UI item has an irregular shape or clickable region, or it is obscured by other UI elements. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet131"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet131"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet132"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet132"::: + + ]]> + + UI Automation Properties Overview + UI Automation and Screen Scaling + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement+AutomationElementInformation + + + Gets the cached UI Automation property values for this object. + A structure containing the cached property values for the . + + . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . + + To get the current value of UI Automation properties on this element use the property. + + + +## Examples + The following example shows how the property can be cached and then retrieved by using the property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: + + ]]> + + There are no cached properties. + The UI for the no longer exists. + UI Automation Properties Overview + Caching in UI Automation Clients + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElementCollection + + + Gets the cached child elements of this . + The collection of child elements. This collection can be empty if the element has no children. + + condition of the that was active when this object was obtained. + + Children are cached only if the scope of the included , , or . + + If the specified that children were to be cached at this level, but there are no children, then the value of this property is 0. However, if no request was made to cache children at this level, an attempt to retrieve the property raises an exception. + + + +## Examples + In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: + + ]]> + + The UI for the no longer exists. + No request was made to cache the children of this element. + Caching in UI Automation Clients + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + Gets the cached parent of this . + The parent element. The return value can be if the specified element has no parent - for example, if this element is the root node. + + properties of a list box and its list items are cached. The list box element is available in the property of each list item element. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: + + ]]> + + No parent element is cached. + The UI for the no longer exists. + Caching in UI Automation Clients + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The class name depends on the implementation of the UI Automation provider and therefore cannot be counted upon to be in a standard format. However, if you know the class name you can use it to verify that your application is working with the expected UI Automation element. + + Return values of the property are of type . The default value is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet133"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet133"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet134"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet134"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the clickable point property. + + . + + An is not clickable if it is completely obscured by another window. + + Return values of the property are of type . The default value is `null`. + + The value returned is in physical screen coordinates. + + + +## Examples + The following example retrieves the current value of the property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet135"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet135"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet166"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet166"::: + + ]]> + + + + UI Automation Properties Overview + UI Automation and Screen Scaling + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The default value for the property is + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet136"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet136"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet137"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet137"::: + + ]]> + + UI Automation Properties Overview + UI Automation Control Types + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the culture property. + + . + + Within the Windows Presentation Foundation (WPF) framework, the default value reported will always be `en-US` because the .NET Framework automatically defaults to English. For other user interface (UI) frameworks, this property must be explicitly set or it will not be exposed. + + This property can exist on a per-control basis, but typically is only available on an application level. + + Return values of the property are of type . + + + +## Examples + The following example retrieves the current value of the property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet138"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet138"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement+AutomationElementInformation + + + Gets the current property values of the . + A structure containing the current property values. + + . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . + + To get the cached value of UI Automation properties on this element, use the property. + + + +## Examples + The following example shows how the property is used to retrieve the name of an item that has been selected in a list. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet106"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet106"::: + + ]]> + + The UI for the no longer exists. + UI Automation Properties Overview + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + An to compare. + Determines whether the specified has the same value as this . + + if the specified is equal to this ;otherwise . + + objects refer to the same underlying user interface element; that is, that they have the same run-time identifier. + + This method is equivalent to the equality operator, which also compare run-time identifiers. + + ]]> + + + + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. + To be added. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElementCollection + + + + + + + A bitwise combination of values that specifies the scope of the search. + The object containing the criteria to match. + Returns all objects that satisfy the specified condition. + A collection of objects that satisfies the specified condition. If there are no matches, an empty collection is returned. + + in `scope`, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. + + If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. + + + +## Examples + The following example shows how to use to locate all enabled buttons in a window. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet116"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet116"::: + + ]]> + + + Obtaining UI Automation Elements + UI Automation Threading Issues + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + + + + + A bitwise combination of values that specifies the scope of the search. + The object containing the criteria to match. + Returns the first child or descendant element that matches the specified condition. + The first element that satisfies the condition, or if no match is found. + + in `scope`, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. + + If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. + + + +## Examples + The following example shows how to find a child window from its identifier. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet110"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet110"::: + + ]]> + + + Obtaining UI Automation Elements + UI Automation Threading Issues + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + Gets the that currently has focus. + The focused UI element. + + + + UI Automation Threading Issues + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + Return values of the property are of type . The default value is an empty string. + + This property enables applications to apply special cases to entire UI frameworks. Examples of property values are "Win32", "WinForm", and "DirectUI". + + + +## Examples + The following example retrieves the current value of the property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet139"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet139"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + + + + The handle of the UI element. + Retrieves a new object for the user interface (UI) item referenced by the specified window handle. + An for the UI item identified by . + To be added. + + Obtaining UI Automation Elements + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + + + + The provider object. + Retrieves a new object from a local implementation. + An that represents the element served by the provider object. + + to clients that want to get a UI Automation element directly from a . + + ]]> + + Obtaining UI Automation Elements + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + + + + The physical screen coordinates on the desktop at which to locate the UI element. + Retrieves a new object for the user interface (UI) item at specified point on the desktop. + The UI item at the specified point. + + returns the element in the logical tree that is closest to the root element. + + If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. + + Although the point is within the bounding rectangle of the returned , it is not necessarily on a clickable part of the control. For example, a round button might not be clickable near one of the corners of its bounding rectangle. + + + +## Examples + The following example retrieves the at the system cursor location. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet181"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet181"::: + + ]]> + + + Obtaining UI Automation Elements + UI Automation and Screen Scaling + UI Automation Threading Issues + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + The identifier of the pattern to retrieve. + Retrieves the specified pattern from the cache of this . + An object representing the specified pattern. If there are no matching patterns, is returned. + + retrieves the specified pattern from the cache. To retrieve the current object for the specified pattern, call . + + This method throws an exception if the requested pattern was not previously cached. + + + +## Examples + The following example shows how to cache and retrieve a pattern. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + The requested pattern is not in the cache or is not supported by the element. + The UI for the no longer exists. + Caching in UI Automation Clients + + + + + UIAutomationClient + 4.0.0.0 + + + Retrieves the cached value of the specified property from an . + + retrieves the specified property from the cache of the . To retrieve the current property, call . + + ]]> + + + Caching in UI Automation Clients + UI Automation Properties for Clients + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Object + + + + + + The identifier of the property to retrieve. + Retrieves the value of the specified property from the cache of this . An appropriate default value for the property type is returned for properties not explicitly supported by the target user interface (UI) element. + An object containing the value of the specified property. + + , such as . + + retrieves the specified property from the 's cache. To retrieve the current object for the specified property call . + + This method throws an exception if the requested property was not previously cached. + + + +## Examples + The following shows how this method can be used to retrieve a cached property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + The requested property is not in the cache. + The user interface (UI) for the no longer exists. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + + The identifier of the property to retrieve. + A value that specifies whether a default value should be ignored if the specified property is not supported. + Retrieves the value of the specified property from the cache of this , optionally ignoring any default property. + An object containing the value of the specified property, or if the element does not supply a value and is . + + retrieves the specified property from the cache for the . To retrieve the current property, call . + + Passing `false` in `ignoreDefaultValue` is equivalent to calling . + + If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if `ignoreDefaultValue` is `false`, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . + + This method throws an exception if the requested property was not previously cached. + + + +## Examples + The following example shows how this method can be used to retrieve a cached property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + The requested property is not in the cache. + The UI for the no longer exists. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + Retrieves a point on the that can be clicked. + The physical screen coordinates of a point that can be used by a client to click on this element. + + is not clickable if it is completely obscured by another window. + + An is clickable when it satisfies all the following conditions: + +- It is programmatically visible and available with the UI Automation tree. + +- It is scrolled fully into view within its parent container, if any. If the element is clipped, there is no guarantee that it is clickable. + +- The element is not obscured by any other UI element. If the element is partially obscured by some UI element other than its ancestors, it might not be clickable. + +- The window containing the element must itself be clickable. For example, the window is not clickable if the containing window is completely transparent. Mouse clicks will click through to the window underneath, so any controls within the transparent window will not return clickable points. + +- If the element is a container (such as list or tree view), it must have a point that when clicked will cause the background of the control to be focused. If every part of the container control is occupied by a child element, it is not clickable. + + There is no guarantee that a control will do anything when clicked on a point defined as clickable by the UI Automation provider. Consider using control patterns instead to perform actions on controls. + + + +## Examples + The following code retrieves a clickable point for a control and moves the system cursor to that point. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet179"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet179"::: + + ]]> + + There is no clickable point. + The UI for the no longer exists. + + UI Automation and Screen Scaling + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + The identifier of the pattern to retrieve. + Retrieves the specified pattern object on this . + The pattern object, if the specified pattern is currently supported by the . + + gets the specified pattern based on its availability at the time of the call. + + For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching patterns and then retrieving them by using . + + + +## Examples + The following example shows how to use this method to retrieve a , which is then used to select an item in a list box. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet103"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet103"::: + +> [!NOTE] +> For often-repeated tasks such as the one in the example, it would be more efficient to cache the pattern and use . + + ]]> + + The pattern is not supported by the element. + The UI for the no longer exists. + UI Automation Control Patterns for Clients + + + + + UIAutomationClient + 4.0.0.0 + + + Retrieves the current value of the specified property from an . + + method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). + + For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . + + ]]> + + + UI Automation Properties for Clients + UI Automation Properties Overview + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Object + + + + + + The UI Automation property identifier specifying which property to retrieve. + Retrieves the value of the specified property on this . An appropriate default value for the property type is returned for properties not explicitly supported by the target user interface (UI) element. + An object containing the value of the specified property. + + method is current at the time it is called. The value can subsequently change by other applications interacting with the UI. + + If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . + + For some forms of UI, this method will incur cross-process performance overhead. Concentrate overhead by caching properties and then retrieving them by using . + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet126"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet126"::: + + ]]> + + The UI for the no longer exists. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + + The UI Automation property identifier specifying which property to retrieve. + A value that specifies whether a default value should be ignored if the specified property is supported. + Retrieves the value of the specified property on this , optionally ignoring any default property. + An object containing the value of the specified property, or if the element does not supply a value and is . + + . + + If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if `ignoreDefaultValue` is `false`, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . + + The value returned by the method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). + + For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . + + + +## Examples + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet123"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet123"::: + + ]]> + + The UI for the no longer exists. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Retrieves the hash code for this . + The 32-bit signed integer hash code. + To be added. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32[] + + + + Retrieves the unique identifier assigned to the user interface (UI) item. + An array of integers representing the run-time identifier. + + is in the cache. + + + +## Examples + The following example shows how to retrieve the run-time identifier of an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet111"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet111"::: + + ]]> + + The UI for the no longer exists. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationPattern[] + + + + Retrieves the control patterns that this supports. + An array of objects that represent the supported control patterns. + + for every possible pattern. Normally you would use to retrieve a specific control pattern from an . To ascertain whether a particular pattern is supported, check the appropriate property; for example, . + + + +## Examples + The following example shows how to retrieve the control patterns supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet114"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet114"::: + + ]]> + + UI Automation Control Patterns for Clients + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty[] + + + + Retrieves the identifiers of properties supported by the element. + An array of supported property identifiers. + + to determine whether a property is currently supported and to get its current value. + + + +## Examples + The following example shows how to retrieve the properties supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet115"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet115"::: + + ]]> + + UI Automation Properties for Clients + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + + + + The patterns and properties to include in the updated cache. + Retrieves a new with an updated cache. + A new that has an updated cache. + + is unchanged. returns a new , that refers to the same user interface (UI) and has the same . + + + +## Examples + The following example demonstrates how a cache might be updated whenever the selection in a combo box changes. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet109"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet109"::: + + ]]> + + Caching in UI Automation Clients + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet140"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet140"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Property ID: HeadingLevel - Describes the heading level of an element. + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + This information is typically obtained from tooltips specified by providers. + + Return values of the property are of type . The default value for the property is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet126"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet126"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet123"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet123"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The content view of the UI Automation tree provides a view of the UI that only contains elements that represent data within the UI. + + An element must be a control to be able to hold content. + + Return values of the property are of type . The default value for the property is `true`. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet141"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet141"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet142"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet142"::: + + ]]> + + + UI Automation Properties Overview + UI Automation Tree Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Controls are elements that a user perceives as interactive or containing information in the UI. + + Return values of the property are of type . The default value for the property is `true`. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet143"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet143"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet144"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet144"::: + + ]]> + + + UI Automation Properties Overview + UI Automation Tree Overview + + + + + + + + + + Field + + UIAutomationClient + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Property ID: IsDialog - Identifies if the automation element is a dialog. + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property, which specifies whether the user interface (UI) item referenced by the is enabled. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is `false`. + + When the enabled state of a control is `false`, it is assumed that child controls are also not enabled. You should not expect property-changed events from child elements when the state of the parent control changes. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet146"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet146"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example retrieves a value that specifies whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The property provides information necessary to the proper functioning of the method. + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet147"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet147"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property, which indicates whether the user interface (UI) item is visible on the screen. + + . + + This property can also be retrieved from the or properties. + + The return value is of type , and the default value is `false`. + + For more information about when this property is `true`, see . + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet148"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet148"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet149"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet149"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The return value for this property is a . It returns `true` to indicate that the content is protected; otherwise `false`. + + + +## Examples + The following example retrieves the current value of the property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet150"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet150"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The return value for this property is of type , and the default value is `false`. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet151"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet151"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available for this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that indicates whether the control pattern is available on this . + + . + + Return values of the property are of type . The default value for the property is `false`. + + + +## Examples + The following example ascertains whether a specified control pattern is supported by an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet145"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet145"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property, which specifies the status of the visual representation of a complex item. + + . + + The return value is a control-defined . The default value is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet152"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet152"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet153"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet153"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The return value is a control-defined . The default value is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet154"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet154"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, an application-defined string is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet155"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet155"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property, which identifies the label associated with a control. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is `null`. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet156"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet156"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet157"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet157"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies the event that is raised when the layout is invalidated. + + . + + This event is raised by a container of elements whenever the visibility information of many elements has changed. This event is used by the client as an indicator that it needs to refresh the and information that it may have cached for elements within the tree. The recommended number of changes that triggers this event is 25. + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property in the local language. + + . + + This property can also be retrieved from the or properties. + + A provider is required to expose this property when it represents a custom control that does not have a well-defined control type. + + Return values of the property are of type . The default value for the property is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet158"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet158"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet159"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet159"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies the event that is raised when a menu is closed. + + . + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies the event that is raised when a menu is opened. + + . + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is an empty string. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet160"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet160"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet161"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet161"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is 0. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet162"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet162"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet163"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet163"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Event ID: Notification - used mainly by servers to raise a generic notification. + To be added. + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + Indicates that a property is not supported. + + . + + + +## Examples + The following example retrieves the help text property for an , specifying that should be returned if the control does not support that property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet123"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet123"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The first to compare. + The second to compare. + Returns a value indicating whether the specified objects refer to the same user interface (UI) element. + + if the two objects refer to the same UI element; otherwise . + + objects that compare as equal might contain different cached information from different points in time. only tests that the objects refer to the same underlying UI element. + + ]]> + + + + + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The first to compare. + The second to compare. + Returns a value indicating whether the specified objects refer to different user interface (UI) elements. + + if the two objects refer to different UI elements; otherwise . + To be added. + + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + The value of the property is of type . The default value is . + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet164"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet164"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet165"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet165"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + UIAutomationClient + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Describes the ordinal location of an automation element within a set of elements that are considered to be siblings. + + to describe the ordinal location of an automation element in the set. + + ]]> + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property. + + . + + This property can also be retrieved from the or properties. + + Return values of the property are of type . The default value for the property is 0. + + + +## Examples + The following example retrieves the current value of the property. The default value is returned if the element does not provide one. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet167"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet167"::: + + The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, is to be returned instead of a default value. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet168"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet168"::: + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationElement + + + Gets the root for the current desktop. + The root element. + + and methods. + + When searching from the root element, be sure to specify in the scope of the search, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. + + + +## Examples + The following example code retrieves a collection of all the immediate children of the desktop. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet201"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet201"::: + + ]]> + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Identifies the property that contains the runtime identifier of the element. + + . + + The runtime ID property specifies an ID for an that is unique on the desktop. + + The return value of the property is an array of type . There is no default value. + + + +## Examples + The following example retrieves the current value of the property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/PropertySnips.cs" id="Snippet169"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet169"::: + + ]]> + + + + + + UI Automation Properties Overview + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Sets focus on the . + + + + The UI for the no longer exists. + + + + + + + + + + Field + + UIAutomationClient + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationProperty + + + Describes the count of automation elements in a group or set that are considered to be siblings. + + to describe the count of items in the set. + + ]]> + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies the event that is raised when the UI Automation tree structure is changed. + + . + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies the event that is raised when a tooltip is closed. + + . + + ]]> + + + + + + + + + + + + Field + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationEvent + + + Identifies the event that is raised when a tooltip is opened. + + . + + Tooltips are transitory on the desktop, and the tooltip might have closed by the time the client receives the event. + + ]]> + + + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The identifier of the control pattern to retrieve. + On return, contains the pattern if it is in the cache; otherwise . + Retrieves a control pattern from the cache. + + if the pattern is in the cache; if it is not in the cache or not supported. + + + + + + Caching in UI Automation Clients + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + When this method returns, contains the physical screen coordinates of a clickable point. + Retrieves a point within the element that can be clicked. + + if there is a point that is clickable; otherwise . + + is not clickable if it is completely obscured by another window. + + + +## Examples + The following example attempts to retrieve a clickable point on an . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet112"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet112"::: + + ]]> + + + UI Automation and Screen Scaling + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The identifier of the control pattern to retrieve. + On return, the control pattern if it is supported; otherwise . + Retrieves an object that implements a control pattern. + + if the pattern is supported; otherwise . + + . + + + +## Examples + The following example shows how to use this method to retrieve a control pattern. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet113"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet113"::: + + ]]> + + + + UI Automation Control Patterns for Clients + + + + diff --git a/xml/System.Windows.Automation/CacheRequest.xml b/xml/System.Windows.Automation/CacheRequest.xml index 7fe93d4f454..8f30da63bfd 100644 --- a/xml/System.Windows.Automation/CacheRequest.xml +++ b/xml/System.Windows.Automation/CacheRequest.xml @@ -1,528 +1,537 @@ - - - - - - - - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Specifies properties and patterns that the UI Automation framework caches when an is obtained. - - method. - - Only a single can be active. There are two ways to activate a request: - -- Call on the request. This pushes the request onto the stack, and the request is popped when the object is disposed. To ensure disposal even if an exception is raised, use the return value from within a `using` block (`Using` in Visual Basic). - -- Put the request onto the internal stack by calling . Only the topmost request on the stack is active, and it must be the next one removed from the stack by . Popping the request deactivates it. - - UI Automation elements obtained while the request is active will have cached values for the properties and patterns specified. - - - -## Examples - The following example shows how to use to cache patterns and properties. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet107"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet107"::: - - The following example shows how to use and to cache patterns and properties. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - Caching in UI Automation Clients - Use Caching in UI Automation - FetchTimer Sample - - - - - - - - - Constructor - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - Initializes a new instance of the class. - - is created, the identifier is added as a default property to cache. - - ]]> - - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.IDisposable - - - - Sets this as the active specification for the items that are returned when an is requested on the same thread. - The object that can be used to dispose the . - - and as a means of activating the . The object is pushed onto the stack when is called, and then popped off when it is disposed. To ensure disposal, place the return value within a `using` block (`Using` in Visual Basic). - - - -## Examples - The following example shows how to use to cache patterns and properties. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet107"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet107"::: - - ]]> - - - - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - UIAutomationClient - 4.0.0.0 - - - Adds a property or pattern identifier to a . - - object is created, the identifier is added as a default property to cache. - - Adding an object that is already in the cache request has no effect. - - ]]> - - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An identifier specifying a pattern to cache. - Adds the specified identifier to this . - - and add a pattern to be cached. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet202"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet202"::: - - ]]> - - The is active. - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An identifier specifying a property value to cache. - Adds the specified identifier to this . - - is created, the identifier is added as a default property to cache. - - Adding a property that is already in the cache request has no effect. - - - -## Examples - The following example shows how to construct a and add a property to be cached. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet202"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet202"::: - - ]]> - - The is active. - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Automation.AutomationElementMode - - - Gets or sets a value that specifies whether returned elements should contain full references to the underlying user interface (UI), or only cached information. - - if the returned elements have a full reference to the underlying user interface (UI); otherwise . - - is the default value, and specifies that returned elements contain a full reference to the underlying UI. specifies that the returned elements have no reference to the underlying UI, and contain only cached information. - - Certain operations on elements, including , , and , require a full reference; attempting to perform these on an element that has none results in an . - - Using can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references. - - - -## Examples - In the following example, is set to , with the result that only cached properties and patterns are available for the retrieved object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.CacheRequest - - - - Creates a copy of this . - A modifiable copy of the current object. - To be added. - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.CacheRequest - - - Gets the that is active on the current thread. - The active . - To be added. - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Removes the active from the internal stack for the current thread. - - method. Attempting to remove a request that is not the current one results in an exception. - - Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. - - - -## Examples - The following example shows how to deactivate a by using . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - An attempt was made to remove a cache request that was not the last one pushed onto the stack. - - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Method - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Places the on the internal state stack, making it the active request on the current thread. - - objects can be placed onto the state stack. Cache requests must be removed from the stack in the order they were pushed on; otherwise, an exception is raised. - - Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. - - - -## Examples - The following example shows how to activate a by using . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Automation.Condition - - - Gets or sets a value specifying the view of the UI Automation element tree to use when caching. - The view of the UI Automation element tree. The default view is . - - is set to so that caching is done for all elements, regardless of whether they are part of the content view or the control view. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: - - ]]> - - - Caching in UI Automation Clients - Use Caching in UI Automation - - - - - - - - - - Property - - UIAutomationClient - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Automation.TreeScope - - - Gets or sets a value that specifies whether caching is done only for the root of the subtree, or also for its children or descendants. - One or more of , , , or . The default value is . - - or is called. See the example. - - - -## Examples - In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: - - ]]> - - An attempt was made to set the property to or . - Caching in UI Automation Clients - Use Caching in UI Automation - - - - + + + + + + + + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Specifies properties and patterns that the UI Automation framework caches when an is obtained. + + method. + + Only a single can be active. There are two ways to activate a request: + +- Call on the request. This pushes the request onto the stack, and the request is popped when the object is disposed. To ensure disposal even if an exception is raised, use the return value from within a `using` block (`Using` in Visual Basic). + +- Put the request onto the internal stack by calling . Only the topmost request on the stack is active, and it must be the next one removed from the stack by . Popping the request deactivates it. + + UI Automation elements obtained while the request is active will have cached values for the properties and patterns specified. + + + +## Examples + The following example shows how to use to cache patterns and properties. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet107"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet107"::: + + The following example shows how to use and to cache patterns and properties. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + Caching in UI Automation Clients + Use Caching in UI Automation + FetchTimer Sample + + + + + + + + + Constructor + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + Initializes a new instance of the class. + + is created, the identifier is added as a default property to cache. + + ]]> + + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.IDisposable + + + + Sets this as the active specification for the items that are returned when an is requested on the same thread. + The object that can be used to dispose the . + + and as a means of activating the . The object is pushed onto the stack when is called, and then popped off when it is disposed. To ensure disposal, place the return value within a `using` block (`Using` in Visual Basic). + + + +## Examples + The following example shows how to use to cache patterns and properties. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet107"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet107"::: + + ]]> + + + + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + UIAutomationClient + 4.0.0.0 + + + Adds a property or pattern identifier to a . + + object is created, the identifier is added as a default property to cache. + + Adding an object that is already in the cache request has no effect. + + ]]> + + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An identifier specifying a pattern to cache. + Adds the specified identifier to this . + + and add a pattern to be cached. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet202"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet202"::: + + ]]> + + The is active. + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An identifier specifying a property value to cache. + Adds the specified identifier to this . + + is created, the identifier is added as a default property to cache. + + Adding a property that is already in the cache request has no effect. + + + +## Examples + The following example shows how to construct a and add a property to be cached. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet202"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet202"::: + + ]]> + + The is active. + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Automation.AutomationElementMode + + + Gets or sets a value that specifies whether returned elements should contain full references to the underlying user interface (UI), or only cached information. + + if the returned elements have a full reference to the underlying user interface (UI); otherwise . + + is the default value, and specifies that returned elements contain a full reference to the underlying UI. specifies that the returned elements have no reference to the underlying UI, and contain only cached information. + + Certain operations on elements, including , , and , require a full reference; attempting to perform these on an element that has none results in an . + + Using can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references. + + + +## Examples + In the following example, is set to , with the result that only cached properties and patterns are available for the retrieved object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.CacheRequest + + + + Creates a copy of this . + A modifiable copy of the current object. + + contains the same request information, but is not pushed on the state of any thread. + + + ]]> + + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.CacheRequest + + + Gets the that is active on the current thread. + The active . + To be added. + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Removes the active from the internal stack for the current thread. + + method. Attempting to remove a request that is not the current one results in an exception. + + Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. + + + +## Examples + The following example shows how to deactivate a by using . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + An attempt was made to remove a cache request that was not the last one pushed onto the stack. + + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Method + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Places the on the internal state stack, making it the active request on the current thread. + + objects can be placed onto the state stack. Cache requests must be removed from the stack in the order they were pushed on; otherwise, an exception is raised. + + Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. + + + +## Examples + The following example shows how to activate a by using . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Automation.Condition + + + Gets or sets a value specifying the view of the UI Automation element tree to use when caching. + The view of the UI Automation element tree. The default view is . + + is set to so that caching is done for all elements, regardless of whether they are part of the content view or the control view. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet108"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: + + ]]> + + + Caching in UI Automation Clients + Use Caching in UI Automation + + + + + + + + + + Property + + UIAutomationClient + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Automation.TreeScope + + + Gets or sets a value that specifies whether caching is done only for the root of the subtree, or also for its children or descendants. + One or more of , , , or . The default value is . + + or is called. See the example. + + + +## Examples + In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/UIAClient_snip/CSharp/ClientForm.cs" id="Snippet119"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: + + ]]> + + An attempt was made to set the property to or . + Caching in UI Automation Clients + Use Caching in UI Automation + + + + diff --git a/xml/System.Windows.Forms.Analyzers/AppManifestAnalyzer.xml b/xml/System.Windows.Forms.Analyzers/AppManifestAnalyzer.xml new file mode 100644 index 00000000000..e19362475cf --- /dev/null +++ b/xml/System.Windows.Forms.Analyzers/AppManifestAnalyzer.xml @@ -0,0 +1,90 @@ + + + + + + + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer + + + + + [Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer("C#", new System.String[] { "Visual Basic" })] + [<Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer("C#", new System.String[] { "Visual Basic" })>] + + + + To be added. + To be added. + + + + + + + + + Constructor + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + + To be added. + To be added. + + + + + + + + + + Method + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.DiagnosticDescriptor> + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml b/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml new file mode 100644 index 00000000000..de5da9c3ea8 --- /dev/null +++ b/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml @@ -0,0 +1,166 @@ + + + + + + + + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Enum + + + Specifies the different high DPI modes that can be applied to an application. + + + + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 0 + + The window does not scale for DPI changes and always assumes a scale factor of 100%. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 4 + + Similar to , but improves the quality of GDI/GDI+ based content. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 2 + + The window checks for DPI when it's created and adjusts scale factor when the DPI changes. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 3 + + Similar to , but enables child window DPI change notification, improved scaling of comctl32 controls and dialog scaling. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 1 + + The window queries for the DPI of the primary monitor once and uses this for the application on all monitors. + + + + diff --git a/xml/System.Windows.Forms.Design/EventsTab.xml b/xml/System.Windows.Forms.Design/EventsTab.xml index 17fac803da9..e7f62b40ce9 100644 --- a/xml/System.Windows.Forms.Design/EventsTab.xml +++ b/xml/System.Windows.Forms.Design/EventsTab.xml @@ -33,12 +33,13 @@ - + + Constructor System.Windows.Forms @@ -94,12 +95,13 @@ - + + Method System.Windows.Forms @@ -132,12 +134,13 @@ - + + Method System.Windows.Forms @@ -170,12 +173,13 @@ - + + Method System.Windows.Forms diff --git a/xml/System.Windows.Forms.Design/PropertyTab.xml b/xml/System.Windows.Forms.Design/PropertyTab.xml index cb8790a0a55..24918b44a98 100644 --- a/xml/System.Windows.Forms.Design/PropertyTab.xml +++ b/xml/System.Windows.Forms.Design/PropertyTab.xml @@ -74,12 +74,13 @@ - + + Property System.Windows.Forms @@ -132,12 +133,13 @@ - + + Property System.Windows.Forms @@ -280,12 +282,13 @@ - + + Method System.Windows.Forms @@ -353,12 +356,13 @@ - + + Method System.Windows.Forms @@ -384,12 +388,13 @@ - + + Method System.Windows.Forms @@ -423,12 +428,13 @@ - + + Property System.Windows.Forms @@ -461,12 +467,13 @@ - + + Property System.Windows.Forms diff --git a/xml/System.Windows.Forms/Application.xml b/xml/System.Windows.Forms/Application.xml index 3eda4788891..bd3c1d38a79 100644 --- a/xml/System.Windows.Forms/Application.xml +++ b/xml/System.Windows.Forms/Application.xml @@ -20,39 +20,39 @@ Provides methods and properties to manage an application, such as methods to start and stop an application, to process Windows messages, and properties to get information about an application. This class cannot be inherited. - class has methods to start and stop applications and threads, and to process Windows messages, as follows: - -- starts an application message loop on the current thread and, optionally, makes a form visible. - -- or stops a message loop. - -- processes messages while your program is in a loop. - -- adds a message filter to the application message pump to monitor Windows messages. - -- lets you stop an event from being raised or perform special operations before invoking an event handler. - - This class has and properties to get or set culture information for the current thread. - - You cannot create an instance of this class. - - - -## Examples - The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. - - The `Main` method calls to start the application, which creates the form, `listBox1` and `button1`. When the user clicks `button1`, the `button1_Click` method displays a . If the user clicks `No` on the , the `button1_Click` method adds a number to the list. If the user clicks `Yes`, the application calls to process all remaining messages in the queue and then to quit. - -> [!NOTE] -> The call to will fail in partial trust. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application Example/VB/source.vb" id="Snippet1"::: - + class has methods to start and stop applications and threads, and to process Windows messages, as follows: + +- starts an application message loop on the current thread and, optionally, makes a form visible. + +- or stops a message loop. + +- processes messages while your program is in a loop. + +- adds a message filter to the application message pump to monitor Windows messages. + +- lets you stop an event from being raised or perform special operations before invoking an event handler. + + This class has and properties to get or set culture information for the current thread. + + You cannot create an instance of this class. + + + +## Examples + The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. + + The `Main` method calls to start the application, which creates the form, `listBox1` and `button1`. When the user clicks `button1`, the `button1_Click` method displays a . If the user clicks `No` on the , the `button1_Click` method adds a number to the list. If the user clicks `Yes`, the application calls to process all remaining messages in the queue and then to quit. + +> [!NOTE] +> The call to will fail in partial trust. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -83,25 +83,25 @@ The implementation of the interface you want to install. Adds a message filter to monitor Windows messages as they are routed to their destinations. - method with the code to handle the message. The method must return `false`. - -> [!CAUTION] -> Adding message filters to the message pump for an application can degrade performance. - - - -## Examples - The following code example creates a message filter called `TestMessageFilter`. This filter blocks all messages relating to the left mouse button. Before you can use a message filter, you must provide an implementation for the interface. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/VB/source.vb" id="Snippet1"::: - + method with the code to handle the message. The method must return `false`. + +> [!CAUTION] +> Adding message filters to the message pump for an application can degrade performance. + + + +## Examples + The following code example creates a message filter called `TestMessageFilter`. This filter blocks all messages relating to the left mouse button. Before you can use a message filter, you must provide an implementation for the interface. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -130,11 +130,11 @@ if the caller can quit this application; otherwise, . - being hosted within a Web browser. Thus, the cannot quit the . - + being hosted within a Web browser. Thus, the cannot quit the . + ]]> @@ -161,26 +161,26 @@ Occurs when the application is about to shut down. - and keeps track of when each form is closed, and exits the current thread when they both are. The class remembers the position of each form when it is closed. When the `ApplicationExit` event occurs, the class writes the positions of each for the user to the file. The form position data is stored in a file titled `appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . - - This code is an excerpt from the example shown in the class overview. See for the whole code listing. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet5"::: - + and keeps track of when each form is closed, and exits the current thread when they both are. The class remembers the position of each form when it is closed. When the `ApplicationExit` event occurs, the class writes the positions of each for the user to the file. The form position data is stored in a file titled `appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . + + This code is an excerpt from the example shown in the class overview. See for the whole code listing. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet5"::: + ]]> @@ -209,17 +209,17 @@ Gets the path for the application data that is shared among all users. The path for the application data that is shared among all users. - \\\\ - - first looks to see if the assembly containing the main executable has the `AssemblyInformationalVersion` attribute on it. If this attribute exists, it is used for both and . If this attribute does not exist, both properties use the version of the executable file instead. - - The path will be different depending on whether the Windows Forms application is deployed using ClickOnce. ClickOnce applications are stored in a per-user application cache in the C:\Documents and Settings\\*username* directory. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). - + \\\\ + + first looks to see if the assembly containing the main executable has the `AssemblyInformationalVersion` attribute on it. If this attribute exists, it is used for both and . If this attribute does not exist, both properties use the version of the executable file instead. + + The path will be different depending on whether the Windows Forms application is deployed using ClickOnce. ClickOnce applications are stored in a per-user application cache in the C:\Documents and Settings\\*username* directory. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). + ]]> @@ -248,13 +248,13 @@ Gets the registry key for the application data that is shared among all users. A representing the registry key of the application data that is shared among all users. - \\\\ - + \\\\ + ]]> @@ -282,15 +282,15 @@ Gets the company name associated with the application. The company name. - @@ -321,15 +321,15 @@ Gets or sets the culture information for the current thread. A representing the culture information for the current thread. - @@ -358,15 +358,15 @@ Gets or sets the current input language for the current thread. An representing the current input language for the current thread. - @@ -396,34 +396,34 @@ Processes all Windows messages currently in the message queue. - in your code, your application can handle the other events. For example, if you have a form that adds data to a and add to your code, your form repaints when another window is dragged over it. If you remove from your code, your form will not repaint until the click event handler of the button is finished executing. For more information on messaging, see [User Input in Windows Forms](/dotnet/framework/winforms/user-input-in-windows-forms). - - Unlike Visual Basic 6.0, the method does not call the method. - - Typically, you use this method in a loop to process messages. - -> [!CAUTION] -> Calling this method causes the current thread to be suspended while all waiting window messages are processed. If a message causes an event to be triggered, then other areas of your application code may execute. This can cause your application to exhibit unexpected behaviors that are difficult to debug. If you perform operations or computations that take a long time, it is often preferable to perform those operations on a new thread. For more information about asynchronous programming, see [Asynchronous Programming Model (APM)](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - - - -## Examples - The following code example demonstrates using the method. When the example runs, a user can select graphics files from an . The selected files are displayed in the form. The method forces a repaint of the form for each graphics file opened. To run this example, paste the following code in a form containing a named `PictureBox1`, an named `OpenFileDialog1`, and a button named `fileButton`. Call the `InitializePictureBox` and `InitializeOpenFileDialog` methods from the form's constructor or `Load` method. - -> [!NOTE] -> In Visual Studio, if you add an to your form by using a drag operation, you will have to modify the following `InitializeOpenFileDialog` method by removing the line that creates a new instance of . - - The example also requires that the event of the control and the event of the are connected to the event handlers defined in the example. When the example is running, display the dialog box by clicking the button. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CPP/filedialogform.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CS/filedialogform.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/VB/filedialogform.vb" id="Snippet1"::: - + in your code, your application can handle the other events. For example, if you have a form that adds data to a and add to your code, your form repaints when another window is dragged over it. If you remove from your code, your form will not repaint until the click event handler of the button is finished executing. For more information on messaging, see [User Input in Windows Forms](/dotnet/framework/winforms/user-input-in-windows-forms). + + Unlike Visual Basic 6.0, the method does not call the method. + + Typically, you use this method in a loop to process messages. + +> [!CAUTION] +> Calling this method causes the current thread to be suspended while all waiting window messages are processed. If a message causes an event to be triggered, then other areas of your application code may execute. This can cause your application to exhibit unexpected behaviors that are difficult to debug. If you perform operations or computations that take a long time, it is often preferable to perform those operations on a new thread. For more information about asynchronous programming, see [Asynchronous Programming Model (APM)](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + + + +## Examples + The following code example demonstrates using the method. When the example runs, a user can select graphics files from an . The selected files are displayed in the form. The method forces a repaint of the form for each graphics file opened. To run this example, paste the following code in a form containing a named `PictureBox1`, an named `OpenFileDialog1`, and a button named `fileButton`. Call the `InitializePictureBox` and `InitializeOpenFileDialog` methods from the form's constructor or `Load` method. + +> [!NOTE] +> In Visual Studio, if you add an to your form by using a drag operation, you will have to modify the following `InitializeOpenFileDialog` method by removing the line that creates a new instance of . + + The example also requires that the event of the control and the event of the are connected to the event handlers defined in the example. When the example is running, display the dialog box by clicking the button. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CPP/filedialogform.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CS/filedialogform.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/VB/filedialogform.vb" id="Snippet1"::: + ]]> @@ -447,6 +447,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("SingleFile", "IL3002", Justification="Single-file case is handled")] + [<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("SingleFile", "IL3002", Justification="Single-file case is handled")>] + + System.Void @@ -454,26 +460,26 @@ Enables visual styles for the application. - must be called before creating any controls in the application; typically, is the first line in the `Main` function. A separate manifest is not required to enable visual styles when calling . - -> [!NOTE] -> Prior to the .NET Framework 2.0, the `FlatStyle` property of some controls, such as controls that derive from , had to be set to in order for the controls to be drawn with visual styles. In applications written with the .NET Framework 2.0, this is no longer necessary. - -> [!NOTE] -> This method will have no effect for controls hosted in Internet Explorer. - - - -## Examples - The following code example demonstrates calling in the `Main` function to enable visual styles for the application. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Application.EnableVisualStyles/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Application.EnableVisualStyles/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Application.EnableVisualStyles/VB/form1.vb" id="Snippet1"::: - + must be called before creating any controls in the application; typically, is the first line in the `Main` function. A separate manifest is not required to enable visual styles when calling . + +> [!NOTE] +> Prior to the .NET Framework 2.0, the `FlatStyle` property of some controls, such as controls that derive from , had to be set to in order for the controls to be drawn with visual styles. In applications written with the .NET Framework 2.0, this is no longer necessary. + +> [!NOTE] +> This method will have no effect for controls hosted in Internet Explorer. + + + +## Examples + The following code example demonstrates calling in the `Main` function to enable visual styles for the application. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Application.EnableVisualStyles/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Application.EnableVisualStyles/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Application.EnableVisualStyles/VB/form1.vb" id="Snippet1"::: + ]]> @@ -508,23 +514,23 @@ Occurs when the application is about to enter a modal state. - [!CAUTION] -> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a Windows Forms and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet3"::: - + [!CAUTION] +> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a Windows Forms and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet3"::: + ]]> @@ -550,8 +556,8 @@ Gets the path for the executable file that started the application, including the executable name. - The path and executable name for the executable file that started the application. - + The path and executable name for the executable file that started the application. + This path will be different depending on whether the Windows Forms application is deployed using ClickOnce. ClickOnce applications are stored in a per-user application cache in the C:\Documents and Settings\\*username* directory. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). To be added. @@ -594,33 +600,33 @@ Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed. - method stops all running message loops on all threads and closes all windows of the application. This method does not necessarily force the application to exit. The method is typically called from within a message loop, and forces to return. To exit a message loop for the current thread only, call . - - raises the following events and performs the associated conditional actions: - -- A event is raised for every form represented by the property. This event can be canceled by setting the property of their parameter to `true`. - -- If one of more of the handlers cancels the event, then returns without further action. Otherwise, a event is raised for every open form, then all running message loops and forms are closed. - -> [!NOTE] -> The method does not raise the and events, which are obsolete as of .NET Framework 2.0. - - - -## Examples - The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. - - The `Main` method calls to start the application, which creates the form, `listBox1`, and `button1`. When the user clicks `button1`, the `button1_Click` method adds numbers one to three to the list box, and displays a . If the user clicks **No** on the , the `button1_Click` method adds another number to the list. If the user clicks **Yes**, the application calls , to process all remaining messages in the queue and then to quit. - - The example requires that `listBox1` and `button1` have been instantiated and placed on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.Exit Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.Exit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.Exit Example/VB/source.vb" id="Snippet1"::: - + method stops all running message loops on all threads and closes all windows of the application. This method does not necessarily force the application to exit. The method is typically called from within a message loop, and forces to return. To exit a message loop for the current thread only, call . + + raises the following events and performs the associated conditional actions: + +- A event is raised for every form represented by the property. This event can be canceled by setting the property of their parameter to `true`. + +- If one of more of the handlers cancels the event, then returns without further action. Otherwise, a event is raised for every open form, then all running message loops and forms are closed. + +> [!NOTE] +> The method does not raise the and events, which are obsolete as of .NET Framework 2.0. + + + +## Examples + The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. + + The `Main` method calls to start the application, which creates the form, `listBox1`, and `button1`. When the user clicks `button1`, the `button1_Click` method adds numbers one to three to the list box, and displays a . If the user clicks **No** on the , the `button1_Click` method adds another number to the list. If the user clicks **Yes**, the application calls , to process all remaining messages in the queue and then to quit. + + The example requires that `listBox1` and `button1` have been instantiated and placed on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.Exit Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.Exit Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.Exit Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -687,11 +693,11 @@ Exits the message loop on the current thread and closes all windows on the thread. - for the current thread to return. To exit the entire application, call . - + for the current thread to return. To exit the entire application, call . + ]]> @@ -777,24 +783,24 @@ Occurs when the application finishes processing and is about to enter the idle state. - [!CAUTION] -> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a Windows Form and make sure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet2"::: - + [!CAUTION] +> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a Windows Form and make sure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet2"::: + ]]> @@ -826,23 +832,23 @@ Occurs when the application is about to leave a modal state. - [!CAUTION] -> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a Windows Forms and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet4"::: - + [!CAUTION] +> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a Windows Forms and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet4"::: + ]]> @@ -870,28 +876,28 @@ Gets the path for the application data of a local, non-roaming user. The path for the application data of a local, non-roaming user. - \\\\ - - A typical base path is C:\Documents and Settings\\*username*\Local Settings\Application Data. This path will be different, however, if the Windows Forms application is deployed by using ClickOnce. ClickOnce creates its own application data directory that is isolated from all other applications. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). - - - -## Examples - The following code example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. Although this example demonstrates using the property to store application data for the user, the can be used instead. - - The `MyApplicationContext` class inherits from and keeps track when each form is closed, and exits the current thread when they both are. The class stores the positions of each form for the user. The form position data is stored in a file titled `Appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . - - This code is an excerpt from the example shown in the class overview. Some code is not shown for the purpose of brevity. See for the whole code listing. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet5"::: - + \\\\ + + A typical base path is C:\Documents and Settings\\*username*\Local Settings\Application Data. This path will be different, however, if the Windows Forms application is deployed by using ClickOnce. ClickOnce creates its own application data directory that is isolated from all other applications. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). + + + +## Examples + The following code example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. Although this example demonstrates using the property to store application data for the user, the can be used instead. + + The `MyApplicationContext` class inherits from and keeps track when each form is closed, and exits the current thread when they both are. The class stores the positions of each form for the user. The form position data is stored in a file titled `Appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . + + This code is an excerpt from the example shown in the class overview. Some code is not shown for the purpose of brevity. See for the whole code listing. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet5"::: + ]]> @@ -920,11 +926,11 @@ if a message loop exists; otherwise, . - to instruct Windows Forms if the hosting environment still has an active message loop. - + to instruct Windows Forms if the hosting environment still has an active message loop. + ]]> @@ -953,14 +959,14 @@ Initializes OLE on the current thread. One of the values. - first checks to see if OLE has been initialized on the current thread. If not, it initializes the thread for OLE. - -> [!NOTE] -> Unless a thread calls OLE methods directly, you do not need to call this method. - + first checks to see if OLE has been initialized on the current thread. If not, it initializes the thread for OLE. + +> [!NOTE] +> Unless a thread calls OLE methods directly, you do not need to call this method. + ]]> @@ -991,15 +997,15 @@ An that represents the exception that was thrown. Raises the event. - to raise an exception that will halt processing of the application. - - The class has a event. You can attach an event handler to this event to do whatever custom processing you need for unhandled exceptions. If you do not attach an event handler, will execute the default behavior, which involves displaying a dialog box to inform the user that there has been an error. - - only implements default exception behavior for unhandled exceptions that occur on threads owned by Windows Forms. Unhandled exceptions on other threads are handled by the event. - + to raise an exception that will halt processing of the application. + + The class has a event. You can attach an event handler to this event to do whatever custom processing you need for unhandled exceptions. If you do not attach an event handler, will execute the default behavior, which involves displaying a dialog box to inform the user that there has been an error. + + only implements default exception behavior for unhandled exceptions that occur on threads owned by Windows Forms. Unhandled exceptions on other threads are handled by the event. + ]]> @@ -1032,11 +1038,11 @@ Gets a collection of open forms owned by the application. A containing all the currently open forms owned by this application. - property represents a read-only collection of forms owned by the application. This collection can be searched by index position or by the of the . - + property represents a read-only collection of forms owned by the application. This collection can be searched by index position or by the of the . + ]]> @@ -1066,20 +1072,20 @@ Gets the product name associated with this application. The product name. - inside of your assembly manifest. For more information, see [Assembly Manifest](/dotnet/standard/assembly/manifest). - - - -## Examples - The following code example gets this property and displays its value in a text box. The example requires that `textBox1` has been placed on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ProductName Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ProductName Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ProductName Example/VB/source.vb" id="Snippet1"::: - + inside of your assembly manifest. For more information, see [Assembly Manifest](/dotnet/standard/assembly/manifest). + + + +## Examples + The following code example gets this property and displays its value in a text box. The example requires that `textBox1` has been placed on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ProductName Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ProductName Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ProductName Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1110,22 +1116,22 @@ Gets the product version associated with this application. The product version. - first looks to see if the assembly containing the main executable has the `AssemblyInformationalVersion` attribute on it. If this attribute exists, it is used for both and . If this attribute does not exist, both properties use the version of the executable file instead. - - - -## Examples - The following code example gets this property and displays its value in a text box. The example requires that `textBox1` has been placed on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ProductVersion Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ProductVersion Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ProductVersion Example/VB/source.vb" id="Snippet1"::: - + first looks to see if the assembly containing the main executable has the `AssemblyInformationalVersion` attribute on it. If this attribute exists, it is used for both and . If this attribute does not exist, both properties use the version of the executable file instead. + + + +## Examples + The following code example gets this property and displays its value in a text box. The example requires that `textBox1` has been placed on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ProductVersion Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ProductVersion Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ProductVersion Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1164,11 +1170,11 @@ The objects to pass to the event. Raises the event in hosted scenarios. - when the hosting application enters an idle state. This enables some Windows Forms controls and components to do important background work while the user is not interacting with the application. - + when the hosting application enters an idle state. This enables some Windows Forms controls and components to do important background work while the user is not interacting with the application. + ]]> @@ -1205,11 +1211,11 @@ The method to call when Windows Forms needs to check if the hosting environment is still sending messages. Registers a callback for checking whether the message loop is running in hosted environments. - property will always return false if Windows Forms is not processing messages. Use this callback to tell Windows Forms if the hosting environment is still processing messages. - + property will always return false if Windows Forms is not processing messages. Use this callback to tell Windows Forms if the hosting environment is still processing messages. + ]]> @@ -1241,20 +1247,20 @@ The implementation of the to remove from the application. Removes a message filter from the message pump of the application. - interface. The following class creates a message filter called `TestMessageFilter`. This filter blocks all messages relating to the left mouse button. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/VB/source.vb" id="Snippet1"::: - + interface. The following class creates a message filter called `TestMessageFilter`. This filter blocks all messages relating to the left mouse button. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.RemoveMessageFilter Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1283,20 +1289,20 @@ if visual styles are enabled for controls in the client area of application windows; otherwise, . - to return `true`. - -|Condition|Description| -|---------------|-----------------| -|The operating system supports visual styles|To verify this condition separately, use the property of the class.| -|The user has enabled visual styles in the operating system|To verify this condition separately, use the property of the class.| -|Visual styles are enabled in the application|Visual styles can be enabled in an application by calling the method or by using an application manifest that specifies that ComCtl32.dll version 6 or later will be used to draw controls.| -|Visual styles are being used to draw the client area of application windows|To verify this condition separately, use the property of the class and verify that it has the value or .| - + to return `true`. + +|Condition|Description| +|---------------|-----------------| +|The operating system supports visual styles|To verify this condition separately, use the property of the class.| +|The user has enabled visual styles in the operating system|To verify this condition separately, use the property of the class.| +|Visual styles are enabled in the application|Visual styles can be enabled in an application by calling the method or by using an application manifest that specifies that ComCtl32.dll version 6 or later will be used to draw controls.| +|Visual styles are being used to draw the client area of application windows|To verify this condition separately, use the property of the class and verify that it has the value or .| + ]]> @@ -1323,15 +1329,15 @@ Shuts down the application and starts a new instance immediately. - will launch the application again with the same options. - + will launch the application again with the same options. + ]]> Your code is not a Windows Forms application. You cannot call this method in this context. @@ -1369,13 +1375,13 @@ Begins running a standard application message loop on the current thread, without a form. - method is called, or when the method is called on the thread that is running the main message loop. - - Most Windows Forms developers will not need to use this version of the method. You should use the overload to start an application with a main form, so that the application terminates when the main form is closed. For all other situations, use the overload, which supports supplying an object for better control over the lifetime of the application. - + method is called, or when the method is called on the thread that is running the main message loop. + + Most Windows Forms developers will not need to use this version of the method. You should use the overload to start an application with a main form, so that the application terminates when the main form is closed. For all other situations, use the overload, which supports supplying an object for better control over the lifetime of the application. + ]]> A main message loop is already running on this thread. @@ -1410,24 +1416,24 @@ An in which the application is run. Begins running a standard application message loop on the current thread, with an . - or is called or the event is raised on the context object. - - - -## Examples - The example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. This example demonstrates how to use an , along with the `Application.Run(context)` method, to display multiple forms when the application starts. - - The class `MyApplicationContext` inherits from and keeps track when each form is closed, and exits the current thread when they both are. The class stores the positions of each form for the user. The form position data is stored in a file titled `Appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . - - The code for the `AppForm1` and `AppForm2` forms is not shown for the purpose of brevity. See the class overview for the whole code listing. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet2"::: - + or is called or the event is raised on the context object. + + + +## Examples + The example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. This example demonstrates how to use an , along with the `Application.Run(context)` method, to display multiple forms when the application starts. + + The class `MyApplicationContext` inherits from and keeps track when each form is closed, and exits the current thread when they both are. The class stores the positions of each form for the user. The form position data is stored in a file titled `Appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . + + The code for the `AppForm1` and `AppForm2` forms is not shown for the purpose of brevity. See the class overview for the whole code listing. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet2"::: + ]]> A main message loop is already running on this thread. @@ -1462,29 +1468,29 @@ A that represents the form to make visible. Begins running a standard application message loop on the current thread, and makes the specified form visible. - event. The event handler calls to clean up the application. - -> [!NOTE] -> The method of the class will be called prior to the return of this method. - - - -## Examples - The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. - - The `Main` method calls to start the application, which creates the form, `listBox1`, and `button1`. When the user clicks `button1`, the `button1_Click` method adds numbers one to three to the list box, and displays a . If the user clicks **No** on the , the `button1_Click` method adds another number to the list. If the user clicks **Yes**, the application calls to process all remaining messages in the queue and then to quit. - - The example requires that `listBox1` and `button1` have been created and placed on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.Exit Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.Exit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.Exit Example/VB/source.vb" id="Snippet1"::: - + event. The event handler calls to clean up the application. + +> [!NOTE] +> The method of the class will be called prior to the return of this method. + + + +## Examples + The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. + + The `Main` method calls to start the application, which creates the form, `listBox1`, and `button1`. When the user clicks `button1`, the `button1_Click` method adds numbers one to three to the list box, and displays a . If the user clicks **No** on the , the `button1_Click` method adds another number to the list. If the user clicks **Yes**, the application calls to process all remaining messages in the queue and then to quit. + + The example requires that `listBox1` and `button1` have been created and placed on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.Exit Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.Exit Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.Exit Example/VB/source.vb" id="Snippet1"::: + ]]> A main message loop is already running on the current thread. @@ -1543,42 +1549,42 @@ The default value to use for new controls. If , new controls that support UseCompatibleTextRendering use the GDI+ based class for text rendering; if , new controls use the GDI based class. Sets the application-wide default for the UseCompatibleTextRendering property defined on certain controls. - class, which is based on the GDI graphics library, or the class, which is based on the GDI+ graphics library. This change was made in the .NET Framework 2.0 because of performance and localization issues with GDI+. Use to set the default value of the `UseCompatibleTextRendering` property for controls that support it. - - The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true`. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. - - You should never call this method if your Windows Forms code is hosted in another application, such as Internet Explorer. Only call this method in stand-alone Windows Forms applications. - - - -## Examples - -> [!IMPORTANT] -> To set the default value for `UseCompatibleTextRendering` in Visual Basic 2005 or later, see . - - In Visual C# 2005 or later, a call to is automatically generated in the Program.cs file. To change the text rendering default, modify the generated code. - -```csharp -static class Program -{ - /// - /// The main entry point for the application. - /// - [STAThread] - static void Main() - { - Application.EnableVisualStyles(); - Application.SetCompatibleTextRenderingDefault(false); - Application.Run(new Form1()); - } -} -``` - + class, which is based on the GDI graphics library, or the class, which is based on the GDI+ graphics library. This change was made in the .NET Framework 2.0 because of performance and localization issues with GDI+. Use to set the default value of the `UseCompatibleTextRendering` property for controls that support it. + + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + + The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true`. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. + + You should never call this method if your Windows Forms code is hosted in another application, such as Internet Explorer. Only call this method in stand-alone Windows Forms applications. + + + +## Examples + +> [!IMPORTANT] +> To set the default value for `UseCompatibleTextRendering` in Visual Basic 2005 or later, see . + + In Visual C# 2005 or later, a call to is automatically generated in the Program.cs file. To change the text rendering default, modify the generated code. + +```csharp +static class Program +{ + /// + /// The main entry point for the application. + /// + [STAThread] + static void Main() + { + Application.EnableVisualStyles(); + Application.SetCompatibleTextRenderingDefault(false); + Application.Run(new Form1()); + } +} +``` + ]]> You can only call this method before the first window is created by your Windows Forms application. @@ -1611,9 +1617,29 @@ static class Program - To be added. - To be added. - To be added. + The font to be used as a default across the application. + Sets the default for the process. + + + + + is . + You can only call this method before the first window is created by your Windows Forms application. @@ -1642,14 +1668,14 @@ static class Program if the high DPI mode was set; otherwise, . - @@ -1687,11 +1713,11 @@ The high DPI mode is set once per process. For more information about setting th if the system is being suspended, otherwise, . - @@ -1705,17 +1731,17 @@ The high DPI mode is set once per process. For more information about setting th Instructs the application how to respond to unhandled exceptions. - so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. - - This example assumes that you have defined two controls, `button1` and `button2`, on your class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: - + so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. + + This example assumes that you have defined two controls, `button1` and `button2`, on your class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1751,26 +1777,26 @@ The high DPI mode is set once per process. For more information about setting th An value describing how the application should behave if an exception is thrown without being caught. Instructs the application how to respond to unhandled exceptions. - before you instantiate the main form of your application using the method. - - To catch exceptions that occur in threads not created and owned by Windows Forms, use the event handler. - - - -## Examples - The following code example sets event handlers for exceptions that occur on Windows Forms threads and exceptions that occur on other threads. It sets so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. - - This example assumes that you have defined two controls, `button1` and `button2`, on your class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: - + before you instantiate the main form of your application using the method. + + To catch exceptions that occur in threads not created and owned by Windows Forms, use the event handler. + + + +## Examples + The following code example sets event handlers for exceptions that occur on Windows Forms threads and exceptions that occur on other threads. It sets so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. + + This example assumes that you have defined two controls, `button1` and `button2`, on your class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: + ]]> You cannot set the exception mode after the application has created its first window. @@ -1805,30 +1831,30 @@ The high DPI mode is set once per process. For more information about setting th to set the thread exception mode; otherwise, . Instructs the application how to respond to unhandled exceptions, optionally applying thread-specific behavior. - before you instantiate the main form of your application using the method. - - When `threadScope` is `true`, the thread exception mode is set. The thread exception mode overrides the application exception mode if `mode` is not set to . - - When `threadScope` is `false`, the application exception mode is set. The application exception mode is used for all threads that have the mode. Setting the application exception mode does not affect the setting of the current thread. - - To catch exceptions that occur in threads not created and owned by Windows Forms, use the event handler. - - - -## Examples - The following code example sets event handlers for exceptions that occur on Windows Forms threads and exceptions that occur on other threads. It sets so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. - - This example assumes that you have defined two controls, `button1` and `button2`, on your class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: - + before you instantiate the main form of your application using the method. + + When `threadScope` is `true`, the thread exception mode is set. The thread exception mode overrides the application exception mode if `mode` is not set to . + + When `threadScope` is `false`, the application exception mode is set. The application exception mode is used for all threads that have the mode. Setting the application exception mode does not affect the setting of the current thread. + + To catch exceptions that occur in threads not created and owned by Windows Forms, use the event handler. + + + +## Examples + The following code example sets event handlers for exceptions that occur on Windows Forms threads and exceptions that occur on other threads. It sets so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. + + This example assumes that you have defined two controls, `button1` and `button2`, on your class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: + ]]> You cannot set the exception mode after the application has created its first window. @@ -1855,19 +1881,19 @@ The high DPI mode is set once per process. For more information about setting th Gets the path for the executable file that started the application, not including the executable name. - The path for the executable file that started the application. - + The path for the executable file that started the application. + This path will be different depending on whether the Windows Forms application is deployed using ClickOnce. ClickOnce applications are stored in a per-user application cache in the C:\Documents and Settings\\*username* directory. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). - @@ -1894,33 +1920,33 @@ The high DPI mode is set once per process. For more information about setting th Occurs when an untrapped thread exception is thrown. - event to deal with these exceptions, which will leave your application in an unknown state. Where possible, exceptions should be handled by a structured exception handling block. - - You can change whether this callback is used for unhandled Windows Forms thread exceptions by setting . To catch exceptions that occur in threads not created and owned by Windows Forms, use the event handler. - -> [!NOTE] -> To guarantee that no activations of this event are missed, you must attach a handler before you call . - -> [!NOTE] -> Only one handler can be attached to this event. If multiple handlers are added, only the most recently added handler will be called on an unhandled exception. - -> [!CAUTION] -> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. - - - -## Examples - The following code example sets event handlers for exceptions that occur on Windows Forms threads and exceptions that occur on other threads. It sets so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. - - This example assumes that you have defined two controls, `button1` and `button2`, on your class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: - + event to deal with these exceptions, which will leave your application in an unknown state. Where possible, exceptions should be handled by a structured exception handling block. + + You can change whether this callback is used for unhandled Windows Forms thread exceptions by setting . To catch exceptions that occur in threads not created and owned by Windows Forms, use the event handler. + +> [!NOTE] +> To guarantee that no activations of this event are missed, you must attach a handler before you call . + +> [!NOTE] +> Only one handler can be attached to this event. If multiple handlers are added, only the most recently added handler will be called on an unhandled exception. + +> [!CAUTION] +> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. + + + +## Examples + The following code example sets event handlers for exceptions that occur on Windows Forms threads and exceptions that occur on other threads. It sets so that all exceptions are handled by the application, regardless of the settings in the application's user configuration file. It uses the event to handle UI thread exceptions, and the event to handle non-UI thread exceptions. Since cannot prevent an application from terminating, the example simply logs the error in the application event log before termination. + + This example assumes that you have defined two controls, `button1` and `button2`, on your class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Application.ThreadException Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Application.ThreadException Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1947,24 +1973,24 @@ The high DPI mode is set once per process. For more information about setting th Occurs when a thread is about to shut down. When the main thread for an application is about to be shut down, this event is raised first, followed by an event. - event to perform any unhandled, required tasks before the thread stops running. Close files opened by this thread, or dispose of objects that the garbage collector did not reclaim. - -> [!CAUTION] -> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a Windows Forms and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet6"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet6"::: - + event to perform any unhandled, required tasks before the thread stops running. Close files opened by this thread, or dispose of objects that the garbage collector did not reclaim. + +> [!CAUTION] +> Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result. + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a Windows Forms and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet6"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet6"::: + ]]> @@ -2023,30 +2049,30 @@ The high DPI mode is set once per process. For more information about setting th Gets the path for the application data of a user. The path for the application data of a user. - \\\\ - - Data stored in this path is part of user profile that is enabled for roaming. A roaming user works on more than one computer in a network. The user profile for a roaming user is kept on a server on the network and is loaded onto a system when the user logs on. For a user profile to be considered for roaming, the operating system must support roaming profiles and it must be enabled. - - A typical base path is C:\Documents and Settings\\*username*\Application Data. This path will be different, however, if the Windows Forms application is deployed by using ClickOnce. ClickOnce creates its own application data directory that is isolated from all other applications. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). - - - -## Examples - The following code example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. This example demonstrates using the property to store application data for the user. - - The class `MyApplicationContext` inherits from and keeps track when each form is closed, and exits the current thread when they both are. The class stores the positions of each form for the user. The form position data is stored in a file titled `Appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . - - This code is an excerpt from the example shown in the class overview. Some code is not shown for the purpose of brevity. See for the whole code listing. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet5"::: - + \\\\ + + Data stored in this path is part of user profile that is enabled for roaming. A roaming user works on more than one computer in a network. The user profile for a roaming user is kept on a server on the network and is loaded onto a system when the user logs on. For a user profile to be considered for roaming, the operating system must support roaming profiles and it must be enabled. + + A typical base path is C:\Documents and Settings\\*username*\Application Data. This path will be different, however, if the Windows Forms application is deployed by using ClickOnce. ClickOnce creates its own application data directory that is isolated from all other applications. For more information, see [Accessing Local and Remote Data in ClickOnce Applications](/visualstudio/deployment/accessing-local-and-remote-data-in-clickonce-applications). + + + +## Examples + The following code example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. This example demonstrates using the property to store application data for the user. + + The class `MyApplicationContext` inherits from and keeps track when each form is closed, and exits the current thread when they both are. The class stores the positions of each form for the user. The form position data is stored in a file titled `Appdata.txt` that is created in the location determined by . The `Main` method calls `Application.Run(context)` to start the application given the . + + This code is an excerpt from the example shown in the class overview. Some code is not shown for the purpose of brevity. See for the whole code listing. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Application/CPP/source.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Application/CS/source.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Application/VB/source.vb" id="Snippet5"::: + ]]> @@ -2075,15 +2101,15 @@ The high DPI mode is set once per process. For more information about setting th Gets the registry key for the application data of a user. A representing the registry key for the application data specific to the user. - \\\\ - - Data stored in this key is part of user profile that is enabled for roaming. A roaming user works on more than one computer in a network. The user profile for a roaming user is kept on a server on the network and is loaded onto a system when the user logs on. For a user profile to be considered for roaming, the operating system must support roaming profiles and it must be enabled. - + \\\\ + + Data stored in this key is part of user profile that is enabled for roaming. A roaming user works on more than one computer in a network. The user profile for a roaming user is kept on a server on the network and is loaded onto a system when the user logs on. For a user profile to be considered for roaming, the operating system must support roaming profiles and it must be enabled. + ]]> @@ -2111,14 +2137,14 @@ The high DPI mode is set once per process. For more information about setting th if visual styles are enabled; otherwise, . - . - -The visual styles will not be enabled if the OS does not support them, or theming is disabled at the OS level. - + . + +The visual styles will not be enabled if the OS does not support them, or theming is disabled at the OS level. + ]]> @@ -2152,11 +2178,11 @@ The visual styles will not be enabled if the OS does not support them, or themin is the wait cursor is used for all open forms; otherwise, . - property of all open forms in the application will be set to `true`. This call will not return until this property has been set on all forms. Use this property when you have a long-running operation, and want to indicate in all application forms that the operation is still processing. - + property of all open forms in the application will be set to `true`. This call will not return until this property has been set on all forms. Use this property when you have a long-running operation, and want to indicate in all application forms that the operation is still processing. + ]]> @@ -2183,20 +2209,20 @@ The visual styles will not be enabled if the OS does not support them, or themin Gets a value that specifies how visual styles are applied to application windows. A bitwise combination of the values. - property determines whether visual styles are enabled in client areas or nonclient areas of application windows. Generally, this property should be set within the main form's constructor or event handler. - - - -## Examples - The following code example sets the property to one of the values within the event handler for a control. This code example is part of a larger example provided for the enumeration. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.VisualStyles.VisualStyleState/cpp/visualstylestate.cpp" id="Snippet10"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.VisualStyles.VisualStyleState/CS/visualstylestate.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.VisualStyles.VisualStyleState/VB/visualstylestate.vb" id="Snippet10"::: - + property determines whether visual styles are enabled in client areas or nonclient areas of application windows. Generally, this property should be set within the main form's constructor or event handler. + + + +## Examples + The following code example sets the property to one of the values within the event handler for a control. This code example is part of a larger example provided for the enumeration. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.VisualStyles.VisualStyleState/cpp/visualstylestate.cpp" id="Snippet10"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.VisualStyles.VisualStyleState/CS/visualstylestate.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.VisualStyles.VisualStyleState/VB/visualstylestate.vb" id="Snippet10"::: + ]]> diff --git a/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml b/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml index 95b61b94bee..b7e476460b7 100644 --- a/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml +++ b/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml @@ -44,15 +44,15 @@ Represents the collection of items in a . - class encapsulates the items in the . The object collection of a combo box can be used to manage many types of objects, including strings, images, and custom business objects. - - You can add items to the collection in several ways. The method adds one object to the collection. To add a number of objects to the collection, it is best to create an array of items and assign with the method. To insert an object at a specific location within the collection, you can use the method. To remove items at a known index in the collection you can use either the method or the method. The method removes all the items from the collection. - - In addition to methods and properties for adding and removing items, the also provides methods to find items within the collection. The method enables you to determine if an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. - + class encapsulates the items in the . The object collection of a combo box can be used to manage many types of objects, including strings, images, and custom business objects. + + You can add items to the collection in several ways. The method adds one object to the collection. To add a number of objects to the collection, it is best to create an array of items and assign with the method. To insert an object at a specific location within the collection, you can use the method. To remove items at a known index in the collection you can use either the method or the method. The method removes all the items from the collection. + + In addition to methods and properties for adding and removing items, the also provides methods to find items within the collection. The method enables you to determine if an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. + ]]> @@ -86,11 +86,11 @@ The that owns this object collection. Initializes a new instance of . - control. - + control. + ]]> @@ -122,13 +122,13 @@ Adds an item to the list of items for a . The zero-based index of the item in the collection. - property of the is set to `true`, the item is inserted into the list alphabetically. Otherwise, the item is inserted at the end of the list. - - A visual representation of the item is displayed in the combo box. This content representation is specified by the property. If the property is `null`, the item's `ToString` method is called to obtain the string that is displayed in the combo box; otherwise, the property of the stored object as specified by the property is displayed. A occurs if there is insufficient space available to store the new item. To add a set of items to the combo box it is best to use the method. If you choose to use the method to add a number of items to the combo box, use the method to suspend repainting during your add and the method to resume repainting. You can use the method to specify the location in the list where an item is added. When an object is added to the collection, the calls the object's method to obtain the string to display in the list. - + property of the is set to `true`, the item is inserted into the list alphabetically. Otherwise, the item is inserted at the end of the list. + + A visual representation of the item is displayed in the combo box. This content representation is specified by the property. If the property is `null`, the item's `ToString` method is called to obtain the string that is displayed in the combo box; otherwise, the property of the stored object as specified by the property is displayed. A occurs if there is insufficient space available to store the new item. To add a set of items to the combo box it is best to use the method. If you choose to use the method to add a number of items to the combo box, use the method to suspend repainting during your add and the method to resume repainting. You can use the method to specify the location in the list where an item is added. When an object is added to the collection, the calls the object's method to obtain the string to display in the list. + ]]> The parameter was . @@ -161,20 +161,20 @@ An array of objects to add to the list. Adds an array of items to the list of items for a . - property of the is set to true, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order they occur within the array. This method is typically passed an array of objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the method calls the object's method to obtain the string to display in the list. When using this method to add items to the collection, you do not need to call the and methods to optimize performance. - - - -## Examples - The following code example demonstrates how to initialize a control by setting the text property and using the method to populate the . It also demonstrates handling the event. To run the example, paste the following code in a form and call the `InitializeComboBox` method from the form's constructor or `Load` method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxDropDown/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxDropDown/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxDropDown/VB/form1.vb" id="Snippet2"::: - + property of the is set to true, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order they occur within the array. This method is typically passed an array of objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the method calls the object's method to obtain the string to display in the list. When using this method to add items to the collection, you do not need to call the and methods to optimize performance. + + + +## Examples + The following code example demonstrates how to initialize a control by setting the text property and using the method to populate the . It also demonstrates handling the event. To run the example, paste the following code in a form and call the `InitializeComboBox` method from the form's constructor or `Load` method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxDropDown/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxDropDown/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxDropDown/VB/form1.vb" id="Snippet2"::: + ]]> An item in the parameter was . @@ -206,11 +206,11 @@ Removes all items from the . - , use the or method. - + , use the or method. + ]]> @@ -247,11 +247,11 @@ if the item is located within the collection; otherwise, . - method enables you to determine if an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. - + method enables you to determine if an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. + ]]> @@ -292,11 +292,11 @@ The location in the destination array to copy the collection to. Copies the entire collection into an existing array of objects at a specified location within the array. - control using the method of the class. - + control using the method of the class. + ]]> @@ -328,11 +328,11 @@ Gets the number of items in the collection. The number of items in the collection. - . You can use this value when looping through the values of the collection. - + . You can use this value when looping through the values of the collection. + ]]> @@ -397,11 +397,11 @@ Retrieves the index within the collection of the specified item. The zero-based index where the item is located within the collection; otherwise, -1. - method enables you to determine where an item is located within the collection. To determine if an item is located within the collection before calling this method, use the method. - + method enables you to determine where an item is located within the collection. To determine if an item is located within the collection before calling this method, use the method. + ]]> The parameter was . @@ -439,18 +439,18 @@ An object representing the item to insert. Inserts an item into the collection at the specified index. - property of the is true, the `index` parameter is ignored. When an object is added to the collection, the calls the object's method is to obtain the string to display in the list. - + property of the is true, the `index` parameter is ignored. When an object is added to the collection, the calls the object's method is to obtain the string to display in the list. + ]]> The was . - The was less than zero. - - -or- - + The was less than zero. + + -or- + The was greater than the count of items in the collection. @@ -524,17 +524,17 @@ Retrieves the item at the specified index within the collection. An object representing the item located at the specified index within the collection. - to find the location of an item, or you can use the index return from the method. - + to find the location of an item, or you can use the index return from the method. + ]]> - The index was less than zero. - - -or- - + The index was less than zero. + + -or- + The was greater of equal to the count of items in the collection. @@ -568,11 +568,11 @@ The to remove from the list. Removes the specified item from the . - @@ -607,21 +607,21 @@ The index of the item to remove. Removes an item from the at the specified index. - control by setting the and properties, using the methods to search the and the method to remove an item from the . It also shows handling the event. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxFindString/CPP/form1.cpp" id="Snippet0"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxFindString/CS/form1.cs" id="Snippet0"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxFindString/VB/form1.vb" id="Snippet0"::: - + control by setting the and properties, using the methods to search the and the method to remove an item from the . It also shows handling the event. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxFindString/CPP/form1.cpp" id="Snippet0"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxFindString/CS/form1.cs" id="Snippet0"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ComboBoxFindString/VB/form1.vb" id="Snippet0"::: + ]]> - The parameter was less than zero. - - -or- - + The parameter was less than zero. + + -or- + The parameter was greater than or equal to the count of items in the collection. @@ -649,10 +649,19 @@ - To be added. - To be added. - To be added. - To be added. + The entry to be compared + The entry to compare with. + Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. + A signed integer that indicates the relative values of and , as shown in the following table. + Value + Meaning + Less than zero + is less than . + Zero + equals . + Greater than zero + is greater than . + To be added. @@ -694,11 +703,11 @@ The zero-based index in the array at which copying begins. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -730,11 +739,11 @@ in all cases. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -765,11 +774,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -811,15 +820,15 @@ For a description of this member, see . The zero-based index of the item in the collection. - instance is cast to an interface. - - This method adds an item to the combo box. If the property of the is set to `true`, the item is inserted into the list alphabetically. Otherwise, the item is inserted at the end of the list. - - A visual representation of the item is displayed in the combo box. This content representation is specified by the property. If the property is `null`, the item's method is called to obtain the string that is displayed in the combo box; otherwise, the property of the stored object as specified by the property is displayed. To add a set of items to the combo box, it is best to use the method. If you choose to use the method to add a set of items to the combo box, use the method to suspend repainting during your add and the method to resume repainting. You can use the method to specify the location in the list where an item is added. When an object is added to the collection, the calls the object's method to obtain the string to display in the list. - + instance is cast to an interface. + + This method adds an item to the combo box. If the property of the is set to `true`, the item is inserted into the list alphabetically. Otherwise, the item is inserted at the end of the list. + + A visual representation of the item is displayed in the combo box. This content representation is specified by the property. If the property is `null`, the item's method is called to obtain the string that is displayed in the combo box; otherwise, the property of the stored object as specified by the property is displayed. To add a set of items to the combo box, it is best to use the method. If you choose to use the method to add a set of items to the combo box, use the method to suspend repainting during your add and the method to resume repainting. You can use the method to specify the location in the list where an item is added. When an object is added to the collection, the calls the object's method to obtain the string to display in the list. + ]]> The parameter is . @@ -853,11 +862,11 @@ in all cases. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Forms/Control.xml b/xml/System.Windows.Forms/Control.xml index 51e341c286a..6135aacbdb3 100644 --- a/xml/System.Windows.Forms/Control.xml +++ b/xml/System.Windows.Forms/Control.xml @@ -95,32 +95,32 @@ Defines the base class for controls, which are components with visual representation. - , classes, or from the other Windows Forms provided controls. For more information about authoring custom controls, see [Developing Custom Windows Forms Controls with the .NET Framework](/dotnet/framework/winforms/controls/developing-custom-windows-forms-controls). - - The class implements very basic functionality required by classes that display information to the user. It handles user input through the keyboard and pointing devices. It handles message routing and security. It defines the bounds of a control (its position and size), although it does not implement painting. It provides a window handle (`hWnd`). - - Windows Forms controls use ambient properties so child controls can appear like their surrounding environment. An *ambient property* is a control property that, if not set, is retrieved from the parent control. If the control does not have a , and the property is not set, the control attempts to determine the value of the ambient property through the property. If the control is not sited, if the site does not support ambient properties, or if the property is not set on the , the control uses its own default values. Typically, an ambient property represents a characteristic of a control, such as , that is communicated to a child control. For example, a will have the same as its parent by default. Ambient properties provided by the class include: , , , , and . - -> [!NOTE] -> To make your Windows Forms application support visual styles, be sure to set the property to `System` and include a manifest with your executable. A manifest is an XML file that is included either as a resource within your application executable or as a separate file that resides in the same directory as the executable file. For an example of a manifest, see the Example section of the enumeration. For more information about using visual styles, see [Visual Styles](/windows/win32/controls/themes-overview). - - Windows Forms has accessibility support built in, and provides information about your application that enables it to work with accessibility client applications such as screen enlarger and reviewer utilities, voice input utilities, on-screen keyboards, alternative input devices, and keyboard enhancement utilities. Sometimes you will want to provide additional information to accessibility client applications. There are two ways of providing this additional information. You can set the , , , and property values, which will be reported to accessibility client applications. This method is typically used to provide limited accessibility information for existing controls. Alternatively, you can write your own class deriving from the or classes, providing as much accessibility information as needed. - -> [!NOTE] -> To maintain better performance, do not set the size of a control in its constructor. The preferred method is to override the property. - -> [!NOTE] -> Do not add data bindings for a in its constructor. Doing so will cause errors in code generation and can cause unwanted behavior. - - The majority of the controls in the namespace use the underlying Windows common control as a base to build on. For more information about the Windows common controls, see [General Control Reference](/windows/win32/controls/common-control-reference). - - To identify Windows Forms controls from a separate process, use a standard `SendMessage` call to pass the WM_GETCONTROLNAME message. WM_GETCONTROLNAME is independent of the language and Windows hierarchy. For more information, see the "Recommended Solution for Windows Forms" topic in [Automating Windows Forms](https://docs.microsoft.com/previous-versions/dotnet/articles/ms996405(v=msdn.10)). - - Use the property to synchronize access to the control from multiple threads. For more information about multithreaded Windows Forms controls, see [How to: Make Thread-Safe Calls to Windows Forms Controls](/dotnet/framework/winforms/controls/how-to-make-thread-safe-calls-to-windows-forms-controls) - + , classes, or from the other Windows Forms provided controls. For more information about authoring custom controls, see [Developing Custom Windows Forms Controls with the .NET Framework](/dotnet/framework/winforms/controls/developing-custom-windows-forms-controls). + + The class implements very basic functionality required by classes that display information to the user. It handles user input through the keyboard and pointing devices. It handles message routing and security. It defines the bounds of a control (its position and size), although it does not implement painting. It provides a window handle (`hWnd`). + + Windows Forms controls use ambient properties so child controls can appear like their surrounding environment. An *ambient property* is a control property that, if not set, is retrieved from the parent control. If the control does not have a , and the property is not set, the control attempts to determine the value of the ambient property through the property. If the control is not sited, if the site does not support ambient properties, or if the property is not set on the , the control uses its own default values. Typically, an ambient property represents a characteristic of a control, such as , that is communicated to a child control. For example, a will have the same as its parent by default. Ambient properties provided by the class include: , , , , and . + +> [!NOTE] +> To make your Windows Forms application support visual styles, be sure to set the property to `System` and include a manifest with your executable. A manifest is an XML file that is included either as a resource within your application executable or as a separate file that resides in the same directory as the executable file. For an example of a manifest, see the Example section of the enumeration. For more information about using visual styles, see [Visual Styles](/windows/win32/controls/themes-overview). + + Windows Forms has accessibility support built in, and provides information about your application that enables it to work with accessibility client applications such as screen enlarger and reviewer utilities, voice input utilities, on-screen keyboards, alternative input devices, and keyboard enhancement utilities. Sometimes you will want to provide additional information to accessibility client applications. There are two ways of providing this additional information. You can set the , , , and property values, which will be reported to accessibility client applications. This method is typically used to provide limited accessibility information for existing controls. Alternatively, you can write your own class deriving from the or classes, providing as much accessibility information as needed. + +> [!NOTE] +> To maintain better performance, do not set the size of a control in its constructor. The preferred method is to override the property. + +> [!NOTE] +> Do not add data bindings for a in its constructor. Doing so will cause errors in code generation and can cause unwanted behavior. + + The majority of the controls in the namespace use the underlying Windows common control as a base to build on. For more information about the Windows common controls, see [General Control Reference](/windows/win32/controls/common-control-reference). + + To identify Windows Forms controls from a separate process, use a standard `SendMessage` call to pass the WM_GETCONTROLNAME message. WM_GETCONTROLNAME is independent of the language and Windows hierarchy. For more information, see the "Recommended Solution for Windows Forms" topic in [Automating Windows Forms](https://docs.microsoft.com/previous-versions/dotnet/articles/ms996405(v=msdn.10)). + + Use the property to synchronize access to the control from multiple threads. For more information about multithreaded Windows Forms controls, see [How to: Make Thread-Safe Calls to Windows Forms Controls](/dotnet/framework/winforms/controls/how-to-make-thread-safe-calls-to-windows-forms-controls) + ]]> Only the following members are thread safe: , , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. @@ -164,11 +164,11 @@ Initializes a new instance of the class with default settings. - class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. - + class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. + ]]> @@ -202,13 +202,13 @@ The text displayed by the control. Initializes a new instance of the class with specific text. - class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. - - This version of the constructor sets the initial property value to the `text` parameter value. - + class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. + + This version of the constructor sets the initial property value to the `text` parameter value. + ]]> @@ -238,13 +238,13 @@ The text displayed by the control. Initializes a new instance of the class as a child control, with specific text. - class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. - - This version of the constructor sets the initial property value to the `text` parameter value. The constructor also adds the control to the parent control's . - + class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. + + This version of the constructor sets the initial property value to the `text` parameter value. The constructor also adds the control to the parent control's . + ]]> @@ -286,16 +286,16 @@ The height of the control, in pixels. The value is assigned to the property. Initializes a new instance of the class with specific text, size, and location. - class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. - - This version of the constructor sets the initial property value to the `text` parameter value. The initial and of the control are determined by the `left`, `top`, `width` and `height` parameter values. - -> [!NOTE] -> To maintain better performance, do not set the size of a control in its constructor. The preferred method is to override the property. - + class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. + + This version of the constructor sets the initial property value to the `text` parameter value. The initial and of the control are determined by the `left`, `top`, `width` and `height` parameter values. + +> [!NOTE] +> To maintain better performance, do not set the size of a control in its constructor. The preferred method is to override the property. + ]]> @@ -333,16 +333,16 @@ The height of the control, in pixels. The value is assigned to the property. Initializes a new instance of the class as a child control, with specific text, size, and location. - class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. - - This version of the constructor sets the initial property value to the `text` parameter value. The constructor also adds the control to the parent control's . The initial and of the control are determined by the `left`, `top`, `width` and `height` parameter values. - -> [!NOTE] -> To maintain better performance, do not set the size of a control in its constructor. The preferred method is to override the property. - + class is the base class for all controls used in a Windows Forms application. Because this class is not typically used to create an instance of the class, this constructor is typically not called directly but is instead called by a derived class. + + This version of the constructor sets the initial property value to the `text` parameter value. The constructor also adds the control to the parent control's . The initial and of the control are determined by the `left`, `top`, `width` and `height` parameter values. + +> [!NOTE] +> To maintain better performance, do not set the size of a control in its constructor. The preferred method is to override the property. + ]]> @@ -398,22 +398,22 @@ The child to notify of the accessible event. Notifies the accessibility client applications of the specified for the specified child control. - method for each the accessibility client applications are to be notified of. The method is typically called when a property is set or from within an event handler. For example, you might call the method and pass in an value of `Hide` from within the event handler for the event. - - - -## Examples - The following code example demonstrates the creation of an accessibility-aware chart control, using the and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Since the chart legend is not an actual -based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. - - This code excerpt demonstrates calling the method. See the class overview for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CS/chartcontrol.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet5"::: - + method for each the accessibility client applications are to be notified of. The method is typically called when a property is set or from within an event handler. For example, you might call the method and pass in an value of `Hide` from within the event handler for the event. + + + +## Examples + The following code example demonstrates the creation of an accessibility-aware chart control, using the and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Since the chart legend is not an actual -based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. + + This code excerpt demonstrates calling the method. See the class overview for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CS/chartcontrol.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet5"::: + ]]> @@ -494,18 +494,18 @@ Gets the assigned to the control. The assigned to the control. - method. - - If no is currently assigned to the control, a new instance of one is created. - -> [!NOTE] -> To get or set the property, you must add a reference to the `Accessibility` assembly installed with the.NET Framework. - - For more information about accessible objects, see [Active Accessibility](/windows/win32/winauto/microsoft-active-accessibility). - + method. + + If no is currently assigned to the control, a new instance of one is created. + +> [!NOTE] +> To get or set the property, you must add a reference to the `Accessibility` assembly installed with the.NET Framework. + + For more information about accessible objects, see [Active Accessibility](/windows/win32/winauto/microsoft-active-accessibility). + ]]> @@ -550,24 +550,24 @@ Gets or sets the default action description of the control for use by accessibility client applications. The default action description of the control for use by accessibility client applications. - property describes the object's primary method of manipulation from the user's viewpoint. This property should be a verb or a short verb phrase. - -> [!NOTE] -> Not all objects have default actions, and some objects might have a default action that is related to its property, such as in the following examples: - -- A selected check box has a default action of "Uncheck" and a value of "Checked." - -- A cleared check box has a default action of "Check" and a value of "Unchecked." - -- A button labeled "Print" has a default action of "Press," with no value. - -- A label or a text box control that shows "Printer" has no default action, but would have a value of "Printer." - - For more information about properties of accessible objects, see [Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). - + property describes the object's primary method of manipulation from the user's viewpoint. This property should be a verb or a short verb phrase. + +> [!NOTE] +> Not all objects have default actions, and some objects might have a default action that is related to its property, such as in the following examples: + +- A selected check box has a default action of "Uncheck" and a value of "Checked." + +- A cleared check box has a default action of "Check" and a value of "Unchecked." + +- A button labeled "Print" has a default action of "Press," with no value. + +- A label or a text box control that shows "Printer" has no default action, but would have a value of "Printer." + + For more information about properties of accessible objects, see [Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). + ]]> @@ -609,24 +609,24 @@ Gets or sets the description of the control used by accessibility client applications. The description of the control used by accessibility client applications. The default is . - property provides a textual description about an object's visual appearance. The description is primarily used to provide greater context for low-vision or blind users, but can also be used for context searching or other applications. - - The property is needed if the description is not obvious, or if it is redundant based on the object's , , , and properties. For example, a button with "OK" would not need additional information, but a button that shows a picture of a cactus would. The , and (and perhaps ) properties for the cactus button would describe its purpose, but the property would convey information that is less tangible, such as "A button that shows a picture of a cactus." - - For more information about properties of accessible objects, see [Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). - - - -## Examples - The following code example creates an instance of a derived class, `MyCheckBox`, assigns it an to its property and sets the and properties, because the property is `null`. This example requires that you have a named `MyForm`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CPP/controlaccessibility.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CS/controlaccessibility.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/VB/controlaccessibility.vb" id="Snippet2"::: - + property provides a textual description about an object's visual appearance. The description is primarily used to provide greater context for low-vision or blind users, but can also be used for context searching or other applications. + + The property is needed if the description is not obvious, or if it is redundant based on the object's , , , and properties. For example, a button with "OK" would not need additional information, but a button that shows a picture of a cactus would. The , and (and perhaps ) properties for the cactus button would describe its purpose, but the property would convey information that is less tangible, such as "A button that shows a picture of a cactus." + + For more information about properties of accessible objects, see [Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). + + + +## Examples + The following code example creates an instance of a derived class, `MyCheckBox`, assigns it an to its property and sets the and properties, because the property is `null`. This example requires that you have a named `MyForm`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CPP/controlaccessibility.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CS/controlaccessibility.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/VB/controlaccessibility.vb" id="Snippet2"::: + ]]> @@ -668,22 +668,22 @@ Gets or sets the name of the control used by accessibility client applications. The name of the control used by accessibility client applications. The default is . - property is a label that briefly describes and identifies the object within its container, such as the text in a , the name of a , or a label displayed next to a control. - - For more information about properties of accessible objects, see the "[Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). - - - -## Examples - The following code example creates an instance of a derived class, `MyCheckBox`, assigns it an to its property and sets the and properties since the property is `null`. This example requires that you have a named `MyForm`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CPP/controlaccessibility.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CS/controlaccessibility.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/VB/controlaccessibility.vb" id="Snippet2"::: - + property is a label that briefly describes and identifies the object within its container, such as the text in a , the name of a , or a label displayed next to a control. + + For more information about properties of accessible objects, see the "[Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). + + + +## Examples + The following code example creates an instance of a derived class, `MyCheckBox`, assigns it an to its property and sets the and properties since the property is `null`. This example requires that you have a named `MyForm`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CPP/controlaccessibility.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/CS/controlaccessibility.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.ControlAccessibleObject/VB/controlaccessibility.vb" id="Snippet2"::: + ]]> @@ -721,13 +721,13 @@ Gets or sets the accessible role of the control. One of the values of . The default is . - property describes what kind of user interface element an object is. If the control's role cannot be determined, the property is set to `Default`. - - For more information about properties of accessible objects, see [Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). - + property describes what kind of user interface element an object is. If the control's role cannot be determined, the property is set to `Default`. + + For more information about properties of accessible objects, see [Content of Descriptive Properties](/windows/win32/winauto/content-of-descriptive-properties). + ]]> The value assigned is not one of the values. @@ -772,15 +772,15 @@ if drag-and-drop operations are allowed in the control; otherwise, . The default is . - method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: - + method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: + ]]> @@ -831,25 +831,25 @@ Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. A bitwise combination of the values. The default is and . - property to define how a control is automatically resized as its parent control is resized. Anchoring a control to its parent control ensures that the anchored edges remain in the same position relative to the edges of the parent control when the parent control is resized. - - You can anchor a control to one or more edges of its container. For example, if you have a with a whose property value is set to `Top` and `Bottom`, the is stretched to maintain the anchored distance to the top and bottom edges of the as the of the is increased. - -> [!NOTE] -> The and properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence. - - - -## Examples - The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: - + property to define how a control is automatically resized as its parent control is resized. Anchoring a control to its parent control ensures that the anchored edges remain in the same position relative to the edges of the parent control when the parent control is resized. + + You can anchor a control to one or more edges of its container. For example, if you have a with a whose property value is set to `Top` and `Bottom`, the is stretched to maintain the anchored distance to the top and bottom edges of the as the of the is increased. + +> [!NOTE] +> The and properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence. + + + +## Examples + The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: + ]]> @@ -947,11 +947,11 @@ if enabled; otherwise, . - @@ -987,11 +987,11 @@ This event is not relevant for this class. - @@ -1025,22 +1025,22 @@ Gets or sets the background color for the control. A that represents the background color of the control. The default is the value of the property. - property does not support transparent colors unless the `SupportsTransparentBackColor` value of is set to `true`. - - The property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. - - - -## Examples - The following code example sets the and of the controls to the default system colors. The code recursively calls itself if the control has any child controls. This code example requires that you have a with at least one child control; however, a child container control, like a or , with its own child control(s) would better demonstrate the recursion. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet1"::: - + property does not support transparent colors unless the `SupportsTransparentBackColor` value of is set to `true`. + + The property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. + + + +## Examples + The following code example sets the and of the controls to the default system colors. The code recursively calls itself if the control has any child controls. This code example requires that you have a with at least one child control; however, a child container control, like a or , with its own child control(s) would better demonstrate the recursion. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet1"::: + ]]> @@ -1072,24 +1072,24 @@ Occurs when the value of the property changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -1130,26 +1130,26 @@ Gets or sets the background image displayed in the control. An that represents the image to display in the background of the control. - property to place a graphic image onto a control. - -> [!NOTE] -> Images with translucent or transparent colors are not supported by Windows Forms controls as background images. -> -> This property is not supported on child controls whose property is `true`. - - - -## Examples - The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: - + property to place a graphic image onto a control. + +> [!NOTE] +> Images with translucent or transparent colors are not supported by Windows Forms controls as background images. +> +> This property is not supported on child controls whose property is `true`. + + + +## Examples + The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: + ]]> @@ -1185,24 +1185,24 @@ Occurs when the value of the property changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -1245,13 +1245,13 @@ Gets or sets the background image layout as defined in the enumeration. One of the values of ( , , , , or ). is the default value. - property to specify the position and behavior of an image you have placed onto a control. takes effect only if the property is set. - - You can increase performance for large images if you set to something other than . - + property to specify the position and behavior of an image you have placed onto a control. takes effect only if the property is set. + + You can increase performance for large images if you set to something other than . + ]]> The specified enumeration value does not exist. @@ -1283,23 +1283,23 @@ Occurs when the property changes. - property changes either programmatically or by user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet9"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet9"::: - + property changes either programmatically or by user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet9"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet9"::: + ]]> @@ -1343,9 +1343,9 @@ - To be added. - To be added. - To be added. + A delegate to a method that takes no parameters. + Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. + An that represents the result of the operation. To be added. @@ -1386,28 +1386,28 @@ Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. An that represents the result of the operation. - will throw an exception. Exceptions within the delegate method are considered untrapped and will be sent to the application's untrapped exception handler. - - You can call to retrieve the return value from the delegate, if neccesary, but this is not required. will block until the return value can be retrieved. - -> [!NOTE] -> Most methods on a control can only be called from the thread where the control was created. In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. The invoke methods always invoke their callbacks on the control's thread. - -> [!NOTE] -> An exception might be thrown if the thread that should process the message is no longer active. - - - -## Examples - The following code example demonstrates a use of the method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_BeginInvoke/CPP/control_begininvoke.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_BeginInvoke/CS/control_begininvoke.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_BeginInvoke/VB/control_begininvoke.vb" id="Snippet2"::: - + will throw an exception. Exceptions within the delegate method are considered untrapped and will be sent to the application's untrapped exception handler. + + You can call to retrieve the return value from the delegate, if neccesary, but this is not required. will block until the return value can be retrieved. + +> [!NOTE] +> Most methods on a control can only be called from the thread where the control was created. In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. The invoke methods always invoke their callbacks on the control's thread. + +> [!NOTE] +> An exception might be thrown if the thread that should process the message is no longer active. + + + +## Examples + The following code example demonstrates a use of the method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_BeginInvoke/CPP/control_begininvoke.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_BeginInvoke/CS/control_begininvoke.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_BeginInvoke/VB/control_begininvoke.vb" id="Snippet2"::: + ]]> No appropriate window handle can be found. @@ -1466,28 +1466,28 @@ Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on. An that represents the result of the operation. - will throw an exception. Exceptions within the delegate method are considered untrapped and will be sent to the application's untrapped exception handler. - - You can call to retrieve the return value from the delegate, if neccesary, but this is not required. will block until the return value can be retrieved. - -> [!NOTE] -> Most methods on a control can only be called from the thread where the control was created. In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. The invoke methods always invoke their callbacks on the control's thread. - -> [!NOTE] -> An exception might be thrown if the thread that should process the message is no longer active. - - - -## Examples - The following code example demonstrates a use of the method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_BeginInvoke/CPP/control_begininvoke.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_BeginInvoke/CS/control_begininvoke.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_BeginInvoke/VB/control_begininvoke.vb" id="Snippet1"::: - + will throw an exception. Exceptions within the delegate method are considered untrapped and will be sent to the application's untrapped exception handler. + + You can call to retrieve the return value from the delegate, if neccesary, but this is not required. will block until the return value can be retrieved. + +> [!NOTE] +> Most methods on a control can only be called from the thread where the control was created. In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. The invoke methods always invoke their callbacks on the control's thread. + +> [!NOTE] +> An exception might be thrown if the thread that should process the message is no longer active. + + + +## Examples + The following code example demonstrates a use of the method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_BeginInvoke/CPP/control_begininvoke.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_BeginInvoke/CS/control_begininvoke.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_BeginInvoke/VB/control_begininvoke.vb" id="Snippet1"::: + ]]> No appropriate window handle can be found. @@ -1546,22 +1546,22 @@ Gets or sets the for the control. A for the control. - of a is used to return a single for all data-bound controls contained by the . The keeps all controls that are bound to the same data source synchronized. For example, setting the property of the specifies the item in the underlying list that all data-bound controls point to. - - For more information about creating a new and assigning it to the property, see the . - - - -## Examples - The following code example creates four objects to bind five controls, a and four controls, to several data sources. The is then used to get the for each data source. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic BindingContext Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic BindingContext Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic BindingContext Example/VB/source.vb" id="Snippet1"::: - + of a is used to return a single for all data-bound controls contained by the . The keeps all controls that are bound to the same data source synchronized. For example, setting the property of the specifies the item in the underlying list that all data-bound controls point to. + + For more information about creating a new and assigning it to the property, see the . + + + +## Examples + The following code example creates four objects to bind five controls, a and four controls, to several data sources. The is then used to get the for each data source. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic BindingContext Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic BindingContext Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic BindingContext Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1594,24 +1594,24 @@ Occurs when the value of the property changes. - to the through the property, see the constructor. - - This event is raised if the property is changed is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example adds an delegate to the event of a control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Control.BindingContextChanged Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Control.BindingContextChanged Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Control.BindingContextChanged Example/VB/source.vb" id="Snippet1"::: - + to the through the property, see the constructor. + + This event is raised if the property is changed is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example adds an delegate to the event of a control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Control.BindingContextChanged Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Control.BindingContextChanged Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Control.BindingContextChanged Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1657,22 +1657,22 @@ Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. An representing the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. - property value, and the property value. - - The property is a read-only property. You can manipulate this property value by changing the value of the or properties or calling the , , , or methods. - - - -## Examples - The following code example uses the property to define the lower limit of a control relative to the client area of the container. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: - + property value, and the property value. + + The property is a read-only property. You can manipulate this property value by changing the value of the or properties or calling the , , , or methods. + + + +## Examples + The following code example uses the property to define the lower limit of a control relative to the client area of the container. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1716,20 +1716,20 @@ Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. A in pixels relative to the parent control that represents the size and location of the control including its nonclient elements. - method is called to set the property. The property is not always changed through its `set` method so you should override the method to ensure that your code is executed when the property is set. - - - -## Examples - The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: - + method is called to set the property. The property is not always changed through its `set` method so you should override the method to ensure that your code is executed when the property is set. + + + +## Examples + The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: + ]]> @@ -1761,20 +1761,20 @@ Brings the control to the front of the z-order. - does not make a control a top-level control, and it does not raise the event. - - - -## Examples - The following code example ensures that a is visible by calling its method. This example requires that you have a with a named `panel1`, and a named `label1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet1"::: - + does not make a control a top-level control, and it does not raise the event. + + + +## Examples + The following code example ensures that a is visible by calling its method. This example requires that you have a with a named `panel1`, and a named `label1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet1"::: + ]]> @@ -1810,11 +1810,11 @@ in all cases. - @@ -1857,20 +1857,20 @@ if the control can receive focus; otherwise, . - and properties must both be set to `true` for both the control and all its parent controls, and the control must be a form or the control's outermost parent must be a form. - - - -## Examples - The following code example sets focus to the specified , if it can receive focus. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet1"::: - + and properties must both be set to `true` for both the control and all its parent controls, and the control must be a form or the control's outermost parent must be a form. + + + +## Examples + The following code example sets focus to the specified , if it can receive focus. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet1"::: + ]]> @@ -1910,11 +1910,11 @@ if the control is hosted as an ActiveX control whose events are not frozen; otherwise, . - @@ -1961,36 +1961,36 @@ if the control can be selected; otherwise, . - is set to `true`, is contained in another control, the control itself is visible and enabled, and all its parent controls are visible and enabled. - - The Windows Forms controls in the following list are not selectable and will return a value of `false` for the property. Controls derived from these controls are also not selectable. - -- - -- - -- - -- - -- - -- - -- (when there is no link present in the control) - - - -## Examples - The following code example selects the specified , if it is selectable. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet2"::: - + is set to `true`, is contained in another control, the control itself is visible and enabled, and all its parent controls are visible and enabled. + + The Windows Forms controls in the following list are not selectable and will return a value of `false` for the property. Controls derived from these controls are also not selectable. + +- + +- + +- + +- + +- + +- + +- (when there is no link present in the control) + + + +## Examples + The following code example selects the specified , if it is selectable. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet2"::: + ]]> @@ -2042,24 +2042,24 @@ if the control has captured the mouse; otherwise, . - property. To run this example paste the following code in a form containing a named label1 and two controls named listbox1 and listbox2. Ensure the form and controls' event is associated with the method in this example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlCapture/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlCapture/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlCapture/VB/form1.vb" id="Snippet1"::: - + property. To run this example paste the following code in a form containing a named label1 and two controls named listbox1 and listbox2. Ensure the form and controls' event is associated with the method in this example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlCapture/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlCapture/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlCapture/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2099,22 +2099,22 @@ if the control causes validation to be performed on any controls requiring validation when it receives focus; otherwise, . The default is . - property is set to `false`, the and events are suppressed. - - The property value is typically set to `false` for controls such as a Help button. - - - -## Examples - The following code example uses the derived class and validates an email address that the user enters. If the email address is not in the standard format (containing "@" and "."), the validation fails, an icon is displayed, and the event is canceled. One of the buttons on the form has its property set to `false`. Clicking or setting focus to this button does not trigger validation. This example requires that a , an control, and a have been created on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Validating/CPP/validating.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Validating/CS/validating.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Validating/VB/validating.vb" id="Snippet2"::: - + property is set to `false`, the and events are suppressed. + + The property value is typically set to `false` for controls such as a Help button. + + + +## Examples + The following code example uses the derived class and validates an email address that the user enters. If the email address is not in the standard format (containing "@" and "."), the validation fails, an icon is displayed, and the event is canceled. One of the buttons on the form has its property set to `false`. Clicking or setting focus to this button does not trigger validation. This example requires that a , an control, and a have been created on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Validating/CPP/validating.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Validating/CS/validating.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Validating/VB/validating.vb" id="Snippet2"::: + ]]> @@ -2143,13 +2143,13 @@ Occurs when the value of the property changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + ]]> @@ -2178,21 +2178,21 @@ Occurs when the focus or keyboard user interface (UI) cues change. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet67"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet67"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet67"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet67"::: + ]]> @@ -2244,11 +2244,11 @@ if calls on the wrong thread are caught; otherwise, . - property. Set to `true` to find and diagnose this thread activity more easily while debugging. - + property. Set to `true` to find and diagnose this thread activity more easily while debugging. + ]]> @@ -2275,47 +2275,47 @@ Occurs when the control is clicked. - event passes an to its event handler, so it only indicates that a click has occurred. If you need more specific mouse information (button, number of clicks, wheel rotation, or location), use the event. However, the event will not be raised if the click is caused by action other than that of the mouse, such as pressing the ENTER key. - - A double-click is determined by the mouse settings of the user's operating system. The user can set the time between clicks of a mouse button that should be considered a double-click rather than two clicks. The event is raised every time a control is double-clicked. For example, if you have event handlers for the and events of a , the and events are raised when the form is double-clicked and both methods are called. If a control is double-clicked and that control does not support the event, the event might be raised twice. - - You must set the `StandardClick` value of to `true` for this event to be raised. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - -## Notes to inheritors - -Inheriting from a standard Windows Forms control and changing the `StandardClick` or `StandardDoubleClick` values of to `true` can cause unexpected behavior or have no effect at all if the control does not support the or events. - -The following table lists Windows Forms controls and which event ( or ) is raised in response to the mouse action specified. - -| Control | Left Mouse Click | Left Mouse Double Click | Right Mouse Click | Right Mouse Double Click | Middle Mouse Click | Middle Mouse Double Click | XButton1 Mouse Click | XButton1 Mouse Double-Click | XButton2 Mouse Click | XButton2 Mouse Double-Click | -| ------- | ---------------- | ----------------------- | ----------------- | ------------------------ | ------------------ | ------------------------- | -------------------- | --------------------------- | -------------------- | --------------------------- | -| , , , | none | none | none | none | none | none | none | none | none | none | -| , , , | Click | Click, Click | none | none | none | none | none | none | none | none | -| , , | Click | Click, DoubleClick | none | none | none | none | none | none | none | none | -| , , | Click | Click, DoubleClick | none | none | none | none | none | none | none | none | -| \* , \* | Click | Click, DoubleClick | Click | Click, DoubleClick | none | none | none | none | none | none | -| , | Click | Click, Click | Click | Click, Click | Click | Click, Click | Click | Click, Click | Click | Click, Click | -| , , , , , , , , , , , \*\* | Click | Click, DoubleClick | Click | Click, DoubleClick | Click | Click, DoubleClick | Click | Click, DoubleClick | Click | Click, DoubleClick | - -\* The mouse pointer must be over a child object ( or ). - - ** The must have at least one in its collection. - -## Examples - The following code example shows the event in an event handler. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: - + event passes an to its event handler, so it only indicates that a click has occurred. If you need more specific mouse information (button, number of clicks, wheel rotation, or location), use the event. However, the event will not be raised if the click is caused by action other than that of the mouse, such as pressing the ENTER key. + + A double-click is determined by the mouse settings of the user's operating system. The user can set the time between clicks of a mouse button that should be considered a double-click rather than two clicks. The event is raised every time a control is double-clicked. For example, if you have event handlers for the and events of a , the and events are raised when the form is double-clicked and both methods are called. If a control is double-clicked and that control does not support the event, the event might be raised twice. + + You must set the `StandardClick` value of to `true` for this event to be raised. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + +## Notes to inheritors + +Inheriting from a standard Windows Forms control and changing the `StandardClick` or `StandardDoubleClick` values of to `true` can cause unexpected behavior or have no effect at all if the control does not support the or events. + +The following table lists Windows Forms controls and which event ( or ) is raised in response to the mouse action specified. + +| Control | Left Mouse Click | Left Mouse Double Click | Right Mouse Click | Right Mouse Double Click | Middle Mouse Click | Middle Mouse Double Click | XButton1 Mouse Click | XButton1 Mouse Double-Click | XButton2 Mouse Click | XButton2 Mouse Double-Click | +| ------- | ---------------- | ----------------------- | ----------------- | ------------------------ | ------------------ | ------------------------- | -------------------- | --------------------------- | -------------------- | --------------------------- | +| , , , | none | none | none | none | none | none | none | none | none | none | +| , , , | Click | Click, Click | none | none | none | none | none | none | none | none | +| , , | Click | Click, DoubleClick | none | none | none | none | none | none | none | none | +| , , | Click | Click, DoubleClick | none | none | none | none | none | none | none | none | +| \* , \* | Click | Click, DoubleClick | Click | Click, DoubleClick | none | none | none | none | none | none | +| , | Click | Click, Click | Click | Click, Click | Click | Click, Click | Click | Click, Click | Click | Click, Click | +| , , , , , , , , , , , \*\* | Click | Click, DoubleClick | Click | Click, DoubleClick | Click | Click, DoubleClick | Click | Click, DoubleClick | Click | Click, DoubleClick | + +\* The mouse pointer must be over a child object ( or ). + + ** The must have at least one in its collection. + +## Examples + The following code example shows the event in an event handler. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2362,24 +2362,24 @@ The following table lists Windows Forms controls and which event (Gets the rectangle that represents the client area of the control. A that represents the client area of the control. - with a named `button2` on it. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CPP/controlmembers5.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CS/controlmembers5.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Member5/VB/controlmembers5.vb" id="Snippet2"::: - + with a named `button2` on it. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CPP/controlmembers5.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CS/controlmembers5.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Member5/VB/controlmembers5.vb" id="Snippet2"::: + ]]> @@ -2423,27 +2423,27 @@ The following table lists Windows Forms controls and which event (Gets or sets the height and width of the client area of the control. A that represents the dimensions of the client area of the control. - method is called to set the property. The property is not always changed through its `set` method so you should override the method to ensure that your code is executed when the property is set. - - The and properties represent the width and height of the client area of the control. You can use this property to obtain the size of the client area of the control for tasks such as drawing on the surface of the control. - - For more information about drawing on controls, see [Rendering a Windows Forms Control](/dotnet/framework/winforms/controls/rendering-a-windows-forms-control). - -> [!NOTE] -> You cannot bind application settings to this property. For more information on application settings, see [Application Settings Overview](/dotnet/framework/winforms/advanced/application-settings-overview). - - - -## Examples - The following code example resizes the specified control so the control will accommodate its formatted text. The formatted text is the property with the control's assigned applied to the text. The `AutoSizeControl` method in this example also has a `textPadding` parameter that represents the padding to apply to all edges of the control. To make the padding appear equal, align the text with the value, if your control supports it. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CPP/controlmembers5.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CS/controlmembers5.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Member5/VB/controlmembers5.vb" id="Snippet1"::: - + method is called to set the property. The property is not always changed through its `set` method so you should override the method to ensure that your code is executed when the property is set. + + The and properties represent the width and height of the client area of the control. You can use this property to obtain the size of the client area of the control for tasks such as drawing on the surface of the control. + + For more information about drawing on controls, see [Rendering a Windows Forms Control](/dotnet/framework/winforms/controls/rendering-a-windows-forms-control). + +> [!NOTE] +> You cannot bind application settings to this property. For more information on application settings, see [Application Settings Overview](/dotnet/framework/winforms/advanced/application-settings-overview). + + + +## Examples + The following code example resizes the specified control so the control will accommodate its formatted text. The formatted text is the property with the control's assigned applied to the text. The `AutoSizeControl` method in this example also has a `textPadding` parameter that represents the padding to apply to all edges of the control. To make the padding appear equal, align the text with the value, if your control supports it. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CPP/controlmembers5.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CS/controlmembers5.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Member5/VB/controlmembers5.vb" id="Snippet1"::: + ]]> @@ -2471,21 +2471,21 @@ The following table lists Windows Forms controls and which event ( Occurs when the value of the property changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet12"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet12"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet12"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet12"::: + ]]> @@ -2531,27 +2531,27 @@ The following table lists Windows Forms controls and which event (Gets the name of the company or creator of the application containing the control. The company name or creator of the application containing the control. - property is a read-only property. To change the value of this property, set the property value of the . The following line of C# code sets the property. - -```csharp -[assembly: AssemblyCompany("Microsoft")] -``` - -> [!NOTE] -> It is strongly recommended that you provide the company name, product name, and product version for your app. - - - -## Examples - The following code example displays information about the application in a contained by a . This example requires that the , and have been set. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CPP/aboutdialog.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CS/aboutdialog.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties3/VB/aboutdialog.vb" id="Snippet1"::: - + property is a read-only property. To change the value of this property, set the property value of the . The following line of C# code sets the property. + +```csharp +[assembly: AssemblyCompany("Microsoft")] +``` + +> [!NOTE] +> It is strongly recommended that you provide the company name, product name, and product version for your app. + + + +## Examples + The following code example displays information about the application in a contained by a . This example requires that the , and have been set. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CPP/aboutdialog.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CS/aboutdialog.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties3/VB/aboutdialog.vb" id="Snippet1"::: + ]]> @@ -2586,15 +2586,15 @@ The following table lists Windows Forms controls and which event ( if the specified control is a child of the control; otherwise, . - is visible by calling its method. This example requires that you have a with a named `panel1`, and a named `label1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet1"::: - + is visible by calling its method. This example requires that you have a with a named `panel1`, and a named `label1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet1"::: + ]]> @@ -2640,11 +2640,11 @@ The following table lists Windows Forms controls and which event ( if the control or one of its child controls currently has the input focus; otherwise, . - property. To give a control the input focus, use the or methods. - + property. To give a control the input focus, use the or methods. + ]]> @@ -2684,20 +2684,20 @@ The following table lists Windows Forms controls and which event (Gets or sets the shortcut menu associated with the control. A that represents the shortcut menu associated with the control. - assigned to a when the right mouse button is clicked and released. This code requires that you have a with a on it. It is also required that the has a assigned to its property. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet5"::: - + assigned to a when the right mouse button is clicked and released. This code requires that you have a with a on it. It is also required that the has a assigned to its property. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet5"::: + ]]> @@ -2732,22 +2732,22 @@ The following table lists Windows Forms controls and which event ( Occurs when the value of the property changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example displays a message when a change occurs to the shortcut menu. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_ContextMenu_CreateGraphics/CPP/control_contextmenu_creategraphics.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_ContextMenu_CreateGraphics/CS/control_contextmenu_creategraphics.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_ContextMenu_CreateGraphics/VB/control_contextmenu_creategraphics.vb" id="Snippet2"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example displays a message when a change occurs to the shortcut menu. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_ContextMenu_CreateGraphics/CPP/control_contextmenu_creategraphics.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_ContextMenu_CreateGraphics/CS/control_contextmenu_creategraphics.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_ContextMenu_CreateGraphics/VB/control_contextmenu_creategraphics.vb" id="Snippet2"::: + ]]> @@ -2783,19 +2783,19 @@ The following table lists Windows Forms controls and which event (Gets or sets the associated with this control. The for this control, or if there is no . The default is . - has also been assigned to the control, the takes precedence over the . - - - -## Examples - The following code example demonstrates how to add three objects to a . In addition it demonstrates setting the property of the form. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.ContextMenuStrip/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.ContextMenuStrip/VB/form1.vb" id="Snippet1"::: - + has also been assigned to the control, the takes precedence over the . + + + +## Examples + The following code example demonstrates how to add three objects to a . In addition it demonstrates setting the property of the form. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.ContextMenuStrip/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.ContextMenuStrip/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2821,21 +2821,21 @@ The following table lists Windows Forms controls and which event ( Occurs when the value of the property changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet14"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet14"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet14"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet14"::: + ]]> @@ -2876,20 +2876,20 @@ The following table lists Windows Forms controls and which event ( Occurs when a new control is added to the . - to add a control to a form and displays the name of the added control in a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: - + to add a control to a form and displays the name of the added control in a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2933,20 +2933,20 @@ The following table lists Windows Forms controls and which event ( Occurs when a control is removed from the . - to remove a control from a form and displays the name of the removed control in a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: - + to remove a control from a form and displays the name of the removed control in a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2987,26 +2987,26 @@ The following table lists Windows Forms controls and which event (Gets the collection of controls contained within the control. A representing the collection of controls contained within the control. - can act as a parent to a collection of controls. For example, when several controls are added to a , each of the controls is a member of the assigned to the property of the form, which is derived from the class. - - You can manipulate the controls in the assigned to the property by using the methods available in the class. - - When adding several controls to a parent control, it is recommended that you call the method before initializing the controls to be added. After adding the controls to the parent control, call the method. Doing so will increase the performance of applications with many controls. - - Use the property to iterate through all controls of a form, including nested controls. Use the method to retrieve the previous or next child control in the tab order. Use the property to get or set the active control of a container control. - - - -## Examples - The following code example removes a from the of the derived class if it is a member of the collection. The example requires that you have created a , a , and at least one control on a . The control(s) are added to the control, and the control added to the . When the button is clicked, the radio button named `removeButton` is removed from the . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/ControlCollection/CPP/controlcollection.cpp" id="Snippet4"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/ControlCollection/CS/controlcollection.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/ControlCollection/VB/controlcollection.vb" id="Snippet4"::: - + can act as a parent to a collection of controls. For example, when several controls are added to a , each of the controls is a member of the assigned to the property of the form, which is derived from the class. + + You can manipulate the controls in the assigned to the property by using the methods available in the class. + + When adding several controls to a parent control, it is recommended that you call the method before initializing the controls to be added. After adding the controls to the parent control, call the method. Doing so will increase the performance of applications with many controls. + + Use the property to iterate through all controls of a form, including nested controls. Use the method to retrieve the previous or next child control in the tab order. Use the property to get or set the active control of a container control. + + + +## Examples + The following code example removes a from the of the derived class if it is a member of the collection. The example requires that you have created a , a , and at least one control on a . The control(s) are added to the control, and the control added to the . When the button is clicked, the radio button named `removeButton` is removed from the . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/ControlCollection/CPP/controlcollection.cpp" id="Snippet4"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/ControlCollection/CS/controlcollection.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/ControlCollection/VB/controlcollection.vb" id="Snippet4"::: + ]]> @@ -3045,25 +3045,25 @@ The following table lists Windows Forms controls and which event (Creates a new accessibility object for the control. A new for the control. - method, it will be called when the property is referenced. - -> [!NOTE] -> To get or set the property, you must add a reference to the `Accessibility` assembly installed with the .NET Framework. - - - -## Examples - The following code example demonstrates the creation of an accessibility-aware chart control, using the and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Since the chart legend is not an actual -based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. - - This code excerpt demonstrates overriding the method. See the class overview for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CS/chartcontrol.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet2"::: - + method, it will be called when the property is referenced. + +> [!NOTE] +> To get or set the property, you must add a reference to the `Accessibility` assembly installed with the .NET Framework. + + + +## Examples + The following code example demonstrates the creation of an accessibility-aware chart control, using the and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Since the chart legend is not an actual -based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. + + This code excerpt demonstrates overriding the method. See the class overview for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CS/chartcontrol.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet2"::: + ]]> @@ -3096,13 +3096,13 @@ The following table lists Windows Forms controls and which event ( Forces the creation of the visible control, including the creation of the handle and any visible child controls. - method forces a handle to be created for the control and its child controls. This method is used when you need a handle immediately for manipulation of the control or its children; simply calling a control's constructor does not create the . - - does not create a control handle if the control's property is `false`. You can either call the method or access the property to create the control's handle regardless of the control's visibility, but in this case, no window handles are created for the control's children. - + method forces a handle to be created for the control and its child controls. This method is used when you need a handle immediately for manipulation of the control or its children; simply calling a control's constructor does not create the . + + does not create a control handle if the control's property is `false`. You can either call the method or access the property to create the control's handle regardless of the control's visibility, but in this case, no window handles are created for the control's children. + ]]> @@ -3191,11 +3191,11 @@ The following table lists Windows Forms controls and which event ( if the control has been created; otherwise, . - property returns `true` if the was successfully created even though the control's handle might not have been created or recreated yet. - + property returns `true` if the was successfully created even though the control's handle might not have been created or recreated yet. + ]]> @@ -3227,25 +3227,25 @@ The following table lists Windows Forms controls and which event (Creates the for the control. The for the control. - object that you retrieve through the method should not normally be retained after the current Windows message has been processed, because anything painted with that object will be erased with the next WM_PAINT message. Therefore you cannot cache the object for reuse, except to use non-visual methods like . Instead, you must call every time that you want to use the object, and then call when you are finished using it. For more information about Windows messages, see . - - By design, sets ownership to the calling thread, and fails if it is called on other threads. - -> [!NOTE] -> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. - - - -## Examples - The following code example resizes the specified control so the control will accommodate its formatted text. The formatted text is the property with the control's assigned applied to the text. The `AutoSizeControl` method in this example also has a `textPadding` parameter that represents the padding to apply to all edges of the control. To make the padding appear equal, align the text with the `MiddleCenter` value of if your control supports it. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CPP/controlmembers5.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CS/controlmembers5.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Member5/VB/controlmembers5.vb" id="Snippet1"::: - + object that you retrieve through the method should not normally be retained after the current Windows message has been processed, because anything painted with that object will be erased with the next WM_PAINT message. Therefore you cannot cache the object for reuse, except to use non-visual methods like . Instead, you must call every time that you want to use the object, and then call when you are finished using it. For more information about Windows messages, see . + + By design, sets ownership to the calling thread, and fails if it is called on other threads. + +> [!NOTE] +> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. + + + +## Examples + The following code example resizes the specified control so the control will accommodate its formatted text. The formatted text is the property with the control's assigned applied to the text. The `AutoSizeControl` method in this example also has a `textPadding` parameter that represents the padding to apply to all edges of the control. To make the padding appear equal, align the text with the `MiddleCenter` value of if your control supports it. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CPP/controlmembers5.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Member5/CS/controlmembers5.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Member5/VB/controlmembers5.vb" id="Snippet1"::: + ]]> @@ -3280,11 +3280,11 @@ The following table lists Windows Forms controls and which event ( Creates a handle for the control. - method directly. The preferred method is to call the method, which forces a handle to be created for the control and its child controls when the control is created. - + method directly. The preferred method is to call the method, which forces a handle to be created for the control and its child controls when the control is created. + ]]> The object is in a disposed state. @@ -3325,20 +3325,20 @@ The following table lists Windows Forms controls and which event (Gets the required creation parameters when the control handle is created. A that contains the required creation parameters when the handle to the control is created. - property should not be overridden and used to adjust the properties of your derived control. Properties such as the , , and should be set by the corresponding properties in your control such as , and . The should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the Windows Forms namespace. For more information about creating control parameters, see the `CreateWindow` and `CreateWindowEx` functions and the [CREATESTRUCT](/windows/win32/api/winuser/ns-winuser-createstructa) structure documentation. - - - -## Examples - The following code example extends the property of a derived class. The property is changed, which causes the button to display an rather than an . This example requires that you have a class that inherits from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/CreateParams/CPP/createparams.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/CreateParams/CS/createparams.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/CreateParams/VB/createparams.vb" id="Snippet3"::: - + property should not be overridden and used to adjust the properties of your derived control. Properties such as the , , and should be set by the corresponding properties in your control such as , and . The should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the Windows Forms namespace. For more information about creating control parameters, see the `CreateWindow` and `CreateWindowEx` functions and the [CREATESTRUCT](/windows/win32/api/winuser/ns-winuser-createstructa) structure documentation. + + + +## Examples + The following code example extends the property of a derived class. The property is changed, which causes the button to display an rather than an . This example requires that you have a class that inherits from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/CreateParams/CPP/createparams.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/CreateParams/CS/createparams.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/CreateParams/VB/createparams.vb" id="Snippet3"::: + ]]> @@ -3385,22 +3385,22 @@ The following table lists Windows Forms controls and which event (Gets or sets the cursor that is displayed when the mouse pointer is over the control. A that represents the cursor to display when the mouse pointer is over the control. - to the property of the control to change the cursor displayed when the mouse pointer is over the control. To temporarily change the mouse cursor for all controls on your application set the property. Typically you would set the property to a wait cursor when populating a or saving or loading a file. - - The property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. - - - -## Examples - The following code example fills a with the user's available logical drives. The example also sets the combo box's property so the cursor is displayed when the mouse pointer is over the drop-down button. This code requires that you have a with a on it. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet1"::: - + to the property of the control to change the cursor displayed when the mouse pointer is over the control. To temporarily change the mouse cursor for all controls on your application set the property. Typically you would set the property to a wait cursor when populating a or saving or loading a file. + + The property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. + + + +## Examples + The following code example fills a with the user's available logical drives. The example also sets the combo box's property so the cursor is displayed when the mouse pointer is over the drop-down button. This code requires that you have a with a on it. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet1"::: + ]]> @@ -3432,22 +3432,22 @@ The following table lists Windows Forms controls and which event ( Occurs when the value of the property changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates changing the mouse cursor using the property, the class, and the class. The example creates a form that contains a control, a control, and a control. The contains all cursors provided by the class. When the user selects a mouse cursor in the , the property is set to the selected cursor, which updates the cursor for the . The is updated every time the event occurs. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Cursors/CPP/cursorexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Cursors/CS/cursorexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Cursors/VB/cursorexample.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates changing the mouse cursor using the property, the class, and the class. The example creates a form that contains a control, a control, and a control. The contains all cursors provided by the class. When the user selects a mouse cursor in the , the property is set to the selected cursor, which updates the cursor for the . The is updated every time the event occurs. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Cursors/CPP/cursorexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Cursors/CS/cursorexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Cursors/VB/cursorexample.vb" id="Snippet1"::: + ]]> @@ -3495,20 +3495,20 @@ The following table lists Windows Forms controls and which event (Gets the data bindings for the control. A that contains the objects for the control. - property to access the . By adding objects to the collection, you can bind any property of a control to the property of an object. - - - -## Examples - The following code example adds objects to the of five controls: four controls and a control. The is accessed through the property of the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Control.DataBindings Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Control.DataBindings Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Control.DataBindings Example/VB/source.vb" id="Snippet1"::: - + property to access the . By adding objects to the collection, you can bind any property of a control to the property of an object. + + + +## Examples + The following code example adds objects to the of five controls: four controls and a control. The is accessed through the property of the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Control.DataBindings Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Control.DataBindings Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Control.DataBindings Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -3539,20 +3539,20 @@ The following table lists Windows Forms controls and which event (Gets the default background color of the control. The default background of the control. The default is . - property value of a generic top-level control. Derived classes can have different defaults. - - - -## Examples - The following code example demonstrates how to use the , , and members. To run the example, paste the following code in a form containing a called ListBox1. Call the `Populate_ListBox` method in the form's constructor or event-handling method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet1"::: - + property value of a generic top-level control. Derived classes can have different defaults. + + + +## Examples + The following code example demonstrates how to use the , , and members. To run the example, paste the following code in a form containing a called ListBox1. Call the `Populate_ListBox` method in the form's constructor or event-handling method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet1"::: + ]]> @@ -3582,11 +3582,11 @@ The following table lists Windows Forms controls and which event (Gets or sets the default cursor for the control. An object of type representing the current default cursor. - to configure a default cursor for your control. This is more efficient than setting the cursor in the control's constructor, and gives automatic support for certain cursor-related designer functions. - + to configure a default cursor for your control. This is more efficient than setting the cursor in the control's constructor, and gives automatic support for certain cursor-related designer functions. + ]]> @@ -3614,30 +3614,30 @@ The following table lists Windows Forms controls and which event (Gets the default font of the control. The default of the control. The value returned will vary depending on the user's operating system the local culture setting of their system. - depending on the operating system and local culture. - -|System/and or Culture|Font| -|----------------------------|----------| -|Windows NT 4x, Japanese version|MS UI Gothic, 9 point.| -|Arabic Windows|Tahoma, 8 point.| -|Other operating system/culture|MS Shell Dlg logical font, typically Microsoft San Serif 8 point.| - - MS Shell Dlg maps to a font set in the system registry. - - If the previous fonts are not installed, the default font is Tahoma, 8 point. If Tahoma, 8 point, is not installed, returns the value of the property - - - -## Examples - The following code example demonstrates how to use the , , and members. To run the example, paste the following code in a form containing a called ListBox1. Call the `Populate_ListBox` method in the form's constructor or event-handling method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet1"::: - + depending on the operating system and local culture. + +|System/and or Culture|Font| +|----------------------------|----------| +|Windows NT 4x, Japanese version|MS UI Gothic, 9 point.| +|Arabic Windows|Tahoma, 8 point.| +|Other operating system/culture|MS Shell Dlg logical font, typically Microsoft San Serif 8 point.| + + MS Shell Dlg maps to a font set in the system registry. + + If the previous fonts are not installed, the default font is Tahoma, 8 point. If Tahoma, 8 point, is not installed, returns the value of the property + + + +## Examples + The following code example demonstrates how to use the , , and members. To run the example, paste the following code in a form containing a called ListBox1. Call the `Populate_ListBox` method in the form's constructor or event-handling method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet1"::: + ]]> The default font or the regional alternative fonts are not installed on the client computer. @@ -3668,20 +3668,20 @@ The following table lists Windows Forms controls and which event (Gets the default foreground color of the control. The default foreground of the control. The default is . - property value of a nonparented control. Derived classes can have different defaults. - - - -## Examples - The following code example demonstrates how to use the , , and members. To run the example, paste the following code in a form containing a called ListBox1. Call the `Populate_ListBox` method in the form's constructor or event-handling method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet1"::: - + property value of a nonparented control. Derived classes can have different defaults. + + + +## Examples + The following code example demonstrates how to use the , , and members. To run the example, paste the following code in a form containing a called ListBox1. Call the `Populate_ListBox` method in the form's constructor or event-handling method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet1"::: + ]]> @@ -3712,22 +3712,22 @@ The following table lists Windows Forms controls and which event (Gets the default Input Method Editor (IME) mode supported by the control. One of the values. - class, this property always returns the value. The value specifies that the IME mode is inherited from the parent control. - - - -## Examples - The following code example overrides the property to turn off the Input Method Editor. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet4"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet4"::: - + class, this property always returns the value. The value specifies that the IME mode is inherited from the parent control. + + + +## Examples + The following code example overrides the property to turn off the Input Method Editor. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet4"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet4"::: + ]]> @@ -3886,26 +3886,26 @@ The following table lists Windows Forms controls and which event (Gets the default size of the control. The default of the control. - property represents the of the control when it is initially created. You can adjust the size of the control by setting its property value. - -> [!NOTE] -> To maintain better performance, do not set the of a control in its constructor. The preferred method is to override the property. - -> [!NOTE] -> On Windows Server 2003 systems, the size of a is restricted by the maximum pixel width and height of the monitor. - - - -## Examples - The following code example overrides the property, and makes the default size of the form 500 pixels square. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet3"::: - + property represents the of the control when it is initially created. You can adjust the size of the control by setting its property value. + +> [!NOTE] +> To maintain better performance, do not set the of a control in its constructor. The preferred method is to override the property. + +> [!NOTE] +> On Windows Server 2003 systems, the size of a is restricted by the maximum pixel width and height of the monitor. + + + +## Examples + The following code example overrides the property, and makes the default size of the form 500 pixels square. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CPP/misccontrolproperties.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties2/CS/misccontrolproperties.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties2/VB/misccontrolproperties.vb" id="Snippet3"::: + ]]> @@ -3947,11 +3947,11 @@ The following table lists Windows Forms controls and which event (The Windows to process. Sends the specified message to the default window procedure. - @@ -4074,11 +4074,11 @@ The following table lists Windows Forms controls and which event (Gets the rectangle that represents the display area of the control. A that represents the display area of the control. - property returns the client rectangle of the display area of the control. For the base control class, this is equal to the client rectangle. However, inheriting controls might want to change this if their client area differs from their display area. The display rectangle is the smallest that encloses a control and is used to lay out controls. - + property returns the client rectangle of the display area of the control. For the base control class, this is equal to the client rectangle. However, inheriting controls might want to change this if their client area differs from their display area. The display rectangle is the smallest that encloses a control and is used to lay out controls. + ]]> @@ -4115,19 +4115,19 @@ The following table lists Windows Forms controls and which event ( to release both managed and unmanaged resources; to release only unmanaged resources. Releases the unmanaged resources used by the and its child controls and optionally releases the managed resources. - method.`Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. invokes `Dispose` with `disposing` set to `false`. - - When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. - + method.`Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. invokes `Dispose` with `disposing` set to `false`. + + When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. + ]]> - can be called multiple times by other objects. When overriding be careful not to reference objects that have been previously disposed of in an earlier call to . For more information about how to implement , see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - + can be called multiple times by other objects. When overriding be careful not to reference objects that have been previously disposed of in an earlier call to . For more information about how to implement , see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + For more information about and , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Overriding the Finalize Method](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)). @@ -4174,11 +4174,11 @@ The following table lists Windows Forms controls and which event ( if the base class is in the process of disposing; otherwise, . - class is in the process of disposing. After the control is disposed of, it can no longer be referenced as a valid Windows control. Even though the instance of a control is disposed of, it is still maintained in memory until it is removed from memory through garbage collection. When a control is disposed of, you cannot call its method. - + class is in the process of disposing. After the control is disposed of, it can no longer be referenced as a valid Windows control. Even though the instance of a control is disposed of, it is still maintained in memory until it is removed from memory through garbage collection. When a control is disposed of, you cannot call its method. + ]]> @@ -4227,27 +4227,27 @@ The following table lists Windows Forms controls and which event (Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. One of the values. The default is . - property to define how a control is automatically resized as its parent control is resized. For example, setting to causes the control to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their Z-order, which is the visual layering of controls on a form along the form's Z-axis (depth). - - A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container. - - Setting the property on a docked control has no effect on the distance of the control from the edges of its container. - -> [!NOTE] -> The and properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence. - - - -## Examples - The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: - + property to define how a control is automatically resized as its parent control is resized. For example, setting to causes the control to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their Z-order, which is the visual layering of controls on a form along the form's Z-axis (depth). + + A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container. + + Setting the property on a docked control has no effect on the distance of the control from the edges of its container. + +> [!NOTE] +> The and properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence. + + + +## Examples + The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: + ]]> The value assigned is not one of the values. @@ -4282,24 +4282,24 @@ The following table lists Windows Forms controls and which event ( Occurs when the value of the property changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes(*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes(*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -4336,76 +4336,76 @@ The following table lists Windows Forms controls and which event (Begins a drag-and-drop operation. A value from the enumeration that represents the final effect that was performed during the drag-and-drop operation. - , , or ), or an object that implements or . - - The following describes how and when events related to drag-and-drop operations are raised. - - The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. - - If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - - Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. - -- If the user moves out of a window, the event is raised. - -- If the mouse enters another control, the for that control is raised. - -- If the mouse moves but stays within the same control, the event is raised. - - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . - -- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. - - > [!NOTE] - > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. - -- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - -- If the value of is `Cancel`, the event is raised. - -> [!NOTE] -> The method catches all exceptions and rethrows only the following security or critical exceptions: - -- SecurityException - -- NullReferenceException - -- StackOverflowException - -- OutOfMemoryException - -- ThreadAbortException - -- ExecutionEngineException - -- IndexOutOfRangeException - -- AccessViolationException - - - -## Examples - The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. - - The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. - - The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel` . - - The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet1"::: - - The following code example shows how to use the enumeration to specify how data should be transferred between the controls involved in a drag-and-drop operation. This example requires that your form includes a control and a control and that the control is populated with a list of valid file names. When the user drags a file name onto the control, the control's event is raised. Within the event handler, the property of the is initialized to to indicate that the data referenced by the file path should be copied to the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/RichTextDragDrop/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/RichTextDragDrop/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/RichTextDragDrop/VB/form1.vb" id="Snippet1"::: - + , , or ), or an object that implements or . + + The following describes how and when events related to drag-and-drop operations are raised. + + The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. + + If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + + Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. + +- If the user moves out of a window, the event is raised. + +- If the mouse enters another control, the for that control is raised. + +- If the mouse moves but stays within the same control, the event is raised. + + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . + +- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + + > [!NOTE] + > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. + +- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. + +- If the value of is `Cancel`, the event is raised. + +> [!NOTE] +> The method catches all exceptions and rethrows only the following security or critical exceptions: + +- SecurityException + +- NullReferenceException + +- StackOverflowException + +- OutOfMemoryException + +- ThreadAbortException + +- ExecutionEngineException + +- IndexOutOfRangeException + +- AccessViolationException + + + +## Examples + The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. + + The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. + + The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel` . + + The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet1"::: + + The following code example shows how to use the enumeration to specify how data should be transferred between the controls involved in a drag-and-drop operation. This example requires that your form includes a control and a control and that the control is populated with a list of valid file names. When the user drags a file name onto the control, the control's event is raised. Within the event handler, the property of the is initialized to to indicate that the data referenced by the file path should be copied to the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/RichTextDragDrop/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/RichTextDragDrop/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/RichTextDragDrop/VB/form1.vb" id="Snippet1"::: + ]]> @@ -4441,14 +4441,14 @@ The following table lists Windows Forms controls and which event ( if the surface of the control should be drawn using double buffering; otherwise, . - [!NOTE] -> is not a bindable property. - + [!NOTE] +> is not a bindable property. + ]]> @@ -4479,246 +4479,246 @@ The following table lists Windows Forms controls and which event ( Occurs when the control is double-clicked. - event is raised every time a control is double-clicked. For example, if you have event handlers for the and events of a , the and events are raised when the form is double-clicked and both methods are called. If a control is double-clicked and that control does not support the event, the event might be raised twice. - - You must set the `StandardDoubleClick` and `StandardClick` values of to `true` for this event to be raised. These values might already be set to `true` if you are inheriting from existing Windows Forms controls. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the event of a to load text files listed in the into a control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.DoubleClick/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.DoubleClick/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.DoubleClick/VB/form1.vb" id="Snippet1"::: - + event is raised every time a control is double-clicked. For example, if you have event handlers for the and events of a , the and events are raised when the form is double-clicked and both methods are called. If a control is double-clicked and that control does not support the event, the event might be raised twice. + + You must set the `StandardDoubleClick` and `StandardClick` values of to `true` for this event to be raised. These values might already be set to `true` if you are inheriting from existing Windows Forms controls. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the event of a to load text files listed in the into a control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.DoubleClick/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.DoubleClick/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.DoubleClick/VB/form1.vb" id="Snippet1"::: + ]]> - Inheriting from a standard Windows Forms control and changing the or values of to can cause unexpected behavior or have no effect at all if the control does not support the or events. - - The following table lists Windows Forms controls and which event ( or ) is raised in response to the mouse action specified. - - Control - - Left Mouse Click - - Left Mouse Double Click - - Right Mouse Click - - Right Mouse Double Click - - Middle Mouse Click - - Middle Mouse Double Click - - XButton1 Mouse Click - - XButton1 Mouse Double-Click - - XButton2 Mouse Click - - XButton2 Mouse Double-Click - - , - - , - - , - - , - - none - - none - - none - - none - - none - - none - - none - - none - - none - - none - - , - - , - - Click - - Click, Click - - none - - none - - none - - none - - none - - none - - none - - none - - , - - , - - Click - - Click, DoubleClick - - none - - none - - none - - none - - none - - none - - none - - none - - , - - , - - Click - - Click, DoubleClick - - none - - none - - none - - none - - none - - none - - none - - none - - * , - - \* Click - - Click, DoubleClick - - Click - - Click, DoubleClick - - none - - none - - none - - none - - none - - none - - , - - Click - - Click, Click - - Click - - Click, Click - - Click - - Click, Click - - Click - - Click, Click - - Click - - Click, Click - - , - - , - - , - - , - - , - - , - - , - - , - - , - - , - - , - - ** Click - - Click, DoubleClick - - Click - - Click, DoubleClick - - Click - - Click, DoubleClick - - Click - - Click, DoubleClick - - Click - - Click, DoubleClick - - - - \* The mouse pointer must be over a child object ( or ). - + Inheriting from a standard Windows Forms control and changing the or values of to can cause unexpected behavior or have no effect at all if the control does not support the or events. + + The following table lists Windows Forms controls and which event ( or ) is raised in response to the mouse action specified. + + Control + + Left Mouse Click + + Left Mouse Double Click + + Right Mouse Click + + Right Mouse Double Click + + Middle Mouse Click + + Middle Mouse Double Click + + XButton1 Mouse Click + + XButton1 Mouse Double-Click + + XButton2 Mouse Click + + XButton2 Mouse Double-Click + + , + + , + + , + + , + + none + + none + + none + + none + + none + + none + + none + + none + + none + + none + + , + + , + + Click + + Click, Click + + none + + none + + none + + none + + none + + none + + none + + none + + , + + , + + Click + + Click, DoubleClick + + none + + none + + none + + none + + none + + none + + none + + none + + , + + , + + Click + + Click, DoubleClick + + none + + none + + none + + none + + none + + none + + none + + none + + * , + + \* Click + + Click, DoubleClick + + Click + + Click, DoubleClick + + none + + none + + none + + none + + none + + none + + , + + Click + + Click, Click + + Click + + Click, Click + + Click + + Click, Click + + Click + + Click, Click + + Click + + Click, Click + + , + + , + + , + + , + + , + + , + + , + + , + + , + + , + + , + + ** Click + + Click, DoubleClick + + Click + + Click, DoubleClick + + Click + + Click, DoubleClick + + Click + + Click, DoubleClick + + Click + + Click, DoubleClick + + + + \* The mouse pointer must be over a child object ( or ). + ** The must have at least one in its collection. @@ -4795,29 +4795,29 @@ The following table lists Windows Forms controls and which event ( Occurs when a drag-and-drop operation is completed. - and properties of the are in screen coordinates, not client coordinates. The following line of Visual C# code converts the properties to a client . - -``` -Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); -``` - -> [!NOTE] -> In versions earlier than .NET Framework 2.0, if you put a with and events on a Windows Form and drag and drop something onto the at design time, the `DropDrop` and `DropEnter` events are raised. However, when you close and reopen the solution, the and events are not raised again. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - This code excerpt demonstrates using the event. See the method for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet5"::: - + and properties of the are in screen coordinates, not client coordinates. The following line of Visual C# code converts the properties to a client . + +``` +Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); +``` + +> [!NOTE] +> In versions earlier than .NET Framework 2.0, if you put a with and events on a Windows Form and drag and drop something onto the at design time, the `DropDrop` and `DropEnter` events are raised. However, when you close and reopen the solution, the and events are not raised again. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + This code excerpt demonstrates using the event. See the method for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet5"::: + ]]> @@ -4849,65 +4849,65 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Occurs when an object is dragged into the control's bounds. - event is raised when the user first drags the mouse cursor over the control during a drag-and-drop operation. - -> [!NOTE] -> In versions earlier than .NET Framework 2.0, if you put a with and events on a Windows Form and drag and drop something onto the at design time, the `DropDrop` and `DropEnter` events are raised. However, when you close and reopen the solution, the and events are not raised again. - - The following describes how and when events related to drag-and-drop operations are raised. - - The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. - - If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - - Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. - -- If the user moves out of a window, the event is raised. - -- If the mouse enters another control, the for that control is raised. - -- If the mouse moves but stays within the same control, the event is raised. - - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . - -- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. - - > [!NOTE] - > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. - -- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - -- If the value of is `Cancel`, the event is raised. - - > [!NOTE] - > The and properties of the are in screen coordinates, not client coordinates. The following line of Visual C# code converts the properties to a client . - - ``` - Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); - ``` - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. - - The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. - - The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. - - The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. - - This code excerpt demonstrates using the event. See the method for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet7"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet7"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet7"::: - + event is raised when the user first drags the mouse cursor over the control during a drag-and-drop operation. + +> [!NOTE] +> In versions earlier than .NET Framework 2.0, if you put a with and events on a Windows Form and drag and drop something onto the at design time, the `DropDrop` and `DropEnter` events are raised. However, when you close and reopen the solution, the and events are not raised again. + + The following describes how and when events related to drag-and-drop operations are raised. + + The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. + + If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + + Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. + +- If the user moves out of a window, the event is raised. + +- If the mouse enters another control, the for that control is raised. + +- If the mouse moves but stays within the same control, the event is raised. + + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . + +- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + + > [!NOTE] + > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. + +- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. + +- If the value of is `Cancel`, the event is raised. + + > [!NOTE] + > The and properties of the are in screen coordinates, not client coordinates. The following line of Visual C# code converts the properties to a client . + + ``` + Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); + ``` + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. + + The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. + + The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. + + The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. + + This code excerpt demonstrates using the event. See the method for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet7"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet7"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet7"::: + ]]> @@ -4935,55 +4935,55 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Occurs when an object is dragged out of the control's bounds. - event is raised when the user drags the cursor out of the control or the user cancels the current drag-and-drop operation. - - The following describes how and when events related to drag-and-drop operations are raised. - - The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. - - If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - - Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. - -- If the user moves out of a window, the event is raised. - -- If the mouse enters another control, the for that control is raised. - -- If the mouse moves but stays within the same control, the event is raised. - - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . - -- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. - - > [!NOTE] - > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. - -- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - -- If the value of is `Cancel`, the event is raised. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. - - The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. - - The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. - - The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. - - This code excerpt demonstrates using the event. See the method for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet8"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet8"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet8"::: - + event is raised when the user drags the cursor out of the control or the user cancels the current drag-and-drop operation. + + The following describes how and when events related to drag-and-drop operations are raised. + + The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. + + If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + + Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. + +- If the user moves out of a window, the event is raised. + +- If the mouse enters another control, the for that control is raised. + +- If the mouse moves but stays within the same control, the event is raised. + + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . + +- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + + > [!NOTE] + > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. + +- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. + +- If the value of is `Cancel`, the event is raised. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. + + The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. + + The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. + + The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. + + This code excerpt demonstrates using the event. See the method for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet8"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet8"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet8"::: + ]]> @@ -5011,60 +5011,60 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Occurs when an object is dragged over the control's bounds. - event is raised when the mouse cursor moves within the bounds of the control during a drag-and-drop operation. - - The following describes how and when events related to drag-and-drop operations are raised. - - The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. - - If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - - Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. - -- If the user moves out of a window, the event is raised. - -- If the mouse enters another control, the for that control is raised. - -- If the mouse moves but stays within the same control, the event is raised. - - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . - -- If the value of value is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. - - > [!NOTE] - > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. - -- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - -- If the value of is `Cancel`, the event is raised. - - > [!NOTE] - > The and properties of the are in screen coordinates, not client coordinates. The following line of C# code converts the properties to a client : - > - > Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. - - The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. - - The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. - - The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. - - This code excerpt demonstrates using the event. See the method for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet4"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet4"::: - + event is raised when the mouse cursor moves within the bounds of the control during a drag-and-drop operation. + + The following describes how and when events related to drag-and-drop operations are raised. + + The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. + + If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + + Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. + +- If the user moves out of a window, the event is raised. + +- If the mouse enters another control, the for that control is raised. + +- If the mouse moves but stays within the same control, the event is raised. + + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . + +- If the value of value is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + + > [!NOTE] + > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. + +- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. + +- If the value of is `Cancel`, the event is raised. + + > [!NOTE] + > The and properties of the are in screen coordinates, not client coordinates. The following line of C# code converts the properties to a client : + > + > Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. + + The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. + + The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. + + The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. + + This code excerpt demonstrates using the event. See the method for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet4"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet4"::: + ]]> @@ -5097,23 +5097,23 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); The bounds within which the control is rendered. Supports rendering to the specified bitmap. - method is not supported for ActiveX controls. You can override the event and provide custom printing logic if required. - - The method has the following limitations: - -- An might be thrown for large bitmaps. The maximum allowable size varies by machine. - -- does not support the `Ink` controls for the Windows XP Tablet PC Edition 2005 operating system. - -- does not draw a child if the property of the is set to `false`. - -- Controls inside containers are rendered in reverse order. - -- is not fully functional for the ; only the border of a bitmap is drawn. - + method is not supported for ActiveX controls. You can override the event and provide custom printing logic if required. + + The method has the following limitations: + +- An might be thrown for large bitmaps. The maximum allowable size varies by machine. + +- does not support the `Ink` controls for the Windows XP Tablet PC Edition 2005 operating system. + +- does not draw a child if the property of the is set to `false`. + +- Controls inside containers are rendered in reverse order. + +- is not fully functional for the ; only the border of a bitmap is drawn. + ]]> @@ -5153,28 +5153,28 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); if the control can respond to user interaction; otherwise, . The default is . - property, you can enable or disable controls at run time. For example, you can disable controls that do not apply to the current state of the application. You can also disable a control to restrict its use. For example, a button can be disabled to prevent the user from clicking it. If a control is disabled, it cannot be selected. - -> [!IMPORTANT] -> Setting the property to `false` does not disable the application's control box or prevent the application window from receiving the focus. - - When a container control has its enabled property set to `false`, all its contained controls are disabled, as well. For example, if the user clicks on any of the controls contained in a disabled control, no events are raised. - -> [!NOTE] -> When a scrollable control is disabled, the scroll bars are also disabled. For example, a disabled multiline textbox is unable to scroll to display all the lines of text. - - - -## Examples - The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: - + property, you can enable or disable controls at run time. For example, you can disable controls that do not apply to the current state of the application. You can also disable a control to restrict its use. For example, a button can be disabled to prevent the user from clicking it. If a control is disabled, it cannot be selected. + +> [!IMPORTANT] +> Setting the property to `false` does not disable the application's control box or prevent the application window from receiving the focus. + + When a container control has its enabled property set to `false`, all its contained controls are disabled, as well. For example, if the user clicks on any of the controls contained in a disabled control, no events are raised. + +> [!NOTE] +> When a scrollable control is disabled, the scroll bars are also disabled. For example, a disabled multiline textbox is unable to scroll to display all the lines of text. + + + +## Examples + The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: + ]]> @@ -5202,21 +5202,21 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Occurs when the property value has changed. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses two controls to demonstrate the event. Clicking one button changes the value of the property of the other button to `false` and displays a . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.EnabledChanged/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.EnabledChanged/VB/form1.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses two controls to demonstrate the event. Clicking one button changes the value of the property of the other button to `false` and displays a . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.EnabledChanged/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.EnabledChanged/VB/form1.vb" id="Snippet1"::: + ]]> @@ -5259,14 +5259,14 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Retrieves the return value of the asynchronous operation represented by the passed. The generated by the asynchronous operation. - [!NOTE] -> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. - + [!NOTE] +> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. + ]]> The parameter value is . @@ -5298,56 +5298,56 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Occurs when the control is entered. - or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - -> [!NOTE] -> The and events are suppressed by the class. The equivalent events in the class are the and events. The and events are hierarchical and will cascade up and down the parent chain until the appropriate control is reached. For example, assume you have a with two controls, and each control has one control. When the caret is moved from one to the other, the event is raised for the and , and the event is raised for the other and . - -> [!CAUTION] -> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the `WM_KILLFOCUS` topic in the "Keyboard Input Reference" section and the "Message Deadlocks" section of the [About Messages and Message Queues](/windows/win32/winmsg/about-messages-and-message-queues) topic. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the event to change the foreground and background colors of a under particular conditions. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: - + or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + +> [!NOTE] +> The and events are suppressed by the class. The equivalent events in the class are the and events. The and events are hierarchical and will cascade up and down the parent chain until the appropriate control is reached. For example, assume you have a with two controls, and each control has one control. When the caret is moved from one to the other, the event is raised for the and , and the event is raised for the other and . + +> [!CAUTION] +> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the `WM_KILLFOCUS` topic in the "Keyboard Input Reference" section and the "Message Deadlocks" section of the [About Messages and Message Queues](/windows/win32/winmsg/about-messages-and-message-queues) topic. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the event to change the foreground and background colors of a under particular conditions. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: + ]]> @@ -5383,20 +5383,20 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Retrieves the form that the control is on. The that the control is on. - property value might not be the same as the returned by method. For example, if a control is contained within a control, and the is on a , the control's is the and the control's is the . - - - -## Examples - The following code example finds the form that contains the specified button. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: - + property value might not be the same as the returned by method. For example, if a control is contained within a control, and the is on a , the control's is the and the control's is the . + + + +## Examples + The following code example finds the form that contains the specified button. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: + ]]> @@ -5434,41 +5434,41 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); if the input focus request was successful; otherwise, . - method returns `true` if the control successfully received input focus. The control can have the input focus while not displaying any visual cues of having the focus. This behavior is primarily observed by the nonselectable controls listed below, or any controls derived from them. - - A control can be selected and receive input focus if all the following are true: the `Selectable` value of is set to `true`, it is contained in another control, and all its parent controls are both visible and enabled. - - The Windows Forms controls in the following list are not selectable. Controls derived from these controls are also not selectable. - -- - -- - -- - -- - -- - -- - -- (when there is no link present in the control) - -> [!NOTE] -> is a low-level method intended primarily for custom control authors. Instead, application programmers should use the method or the property for child controls, or the method for forms. - - - -## Examples - The following code example sets focus to the specified , if it can receive focus. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet1"::: - + method returns `true` if the control successfully received input focus. The control can have the input focus while not displaying any visual cues of having the focus. This behavior is primarily observed by the nonselectable controls listed below, or any controls derived from them. + + A control can be selected and receive input focus if all the following are true: the `Selectable` value of is set to `true`, it is contained in another control, and all its parent controls are both visible and enabled. + + The Windows Forms controls in the following list are not selectable. Controls derived from these controls are also not selectable. + +- + +- + +- + +- + +- + +- + +- (when there is no link present in the control) + +> [!NOTE] +> is a low-level method intended primarily for custom control authors. Instead, application programmers should use the method or the property for child controls, or the method for forms. + + + +## Examples + The following code example sets focus to the specified , if it can receive focus. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet1"::: + ]]> @@ -5518,15 +5518,15 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); if the control has focus; otherwise, . - if a does not have focus. This example requires that you have a with a named `textBox1` and two objects named `menuItemEdit` and `menuItemEditInsertCustomerInfo`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet4"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet4"::: - + if a does not have focus. This example requires that you have a with a named `textBox1` and two objects named `menuItemEdit` and `menuItemEditInsertCustomerInfo`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet4"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet4"::: + ]]> @@ -5575,34 +5575,34 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); Gets or sets the font of the text displayed by the control. The to apply to the text displayed by the control. The default is the value of the property. - property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. - - Because the is immutable (meaning that you cannot adjust any of its properties), you can only assign the property a new . However, you can base the new font on the existing font. - - The following is an example of how to adjust the existing font to make it bold: - -```csharp -myControl.Font = new Font(myControl.Font, - myControl.Font.Style | FontStyle.Bold); -``` - -```vb -MyControl.Font = New Font(MyControl.Font, _ - MyControl.Font.Style Or FontStyle.Bold) -``` - - - -## Examples - The following code example displays a to the user and changes the of a control. This example requires that you have a with and a on it. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Font/CPP/control_font.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Font/CS/control_font.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Font/VB/control_font.vb" id="Snippet1"::: - + property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. + + Because the is immutable (meaning that you cannot adjust any of its properties), you can only assign the property a new . However, you can base the new font on the existing font. + + The following is an example of how to adjust the existing font to make it bold: + +```csharp +myControl.Font = new Font(myControl.Font, + myControl.Font.Style | FontStyle.Bold); +``` + +```vb +MyControl.Font = New Font(MyControl.Font, _ + MyControl.Font.Style Or FontStyle.Bold) +``` + + + +## Examples + The following code example displays a to the user and changes the of a control. This example requires that you have a with and a on it. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Font/CPP/control_font.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Font/CS/control_font.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Font/VB/control_font.vb" id="Snippet1"::: + ]]> @@ -5635,21 +5635,21 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the property value changes. - property is changed by either a programmatic modification or through interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.FontChanged/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.FontChanged/VB/form1.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or through interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.FontChanged/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.FontChanged/VB/form1.vb" id="Snippet1"::: + ]]> @@ -5680,13 +5680,13 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the height of the font of the control. The height of the of the control in pixels. - [!NOTE] -> The property should not be set to any value other than the control's value, or -1. Setting to -1 has the effect of clearing the cached height value, and the value is recalculated the next time the property is referenced. - + [!NOTE] +> The property should not be set to any value other than the control's value, or -1. Setting to -1 has the effect of clearing the cached height value, and the value is recalculated the next time the property is referenced. + ]]> @@ -5721,20 +5721,20 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the foreground color of the control. The foreground of the control. The default is the value of the property. - property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. - - - -## Examples - The following code example sets the and of the controls to the default system colors. The code recursively calls itself if the control has any child controls. This code example requires that you have a with at least one child control; however, a child container control, like a or , with its own child control(s) would better demonstrate the recursion. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet1"::: - + property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. + + + +## Examples + The following code example sets the and of the controls to the default system colors. The code recursively calls itself if the control has any child controls. This code example requires that you have a with at least one child control; however, a child container control, like a or , with its own child control(s) would better demonstrate the recursion. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet1"::: + ]]> @@ -5767,24 +5767,24 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the property value changes. - property is changed by either a programmatic modification or through interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or through interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -5825,11 +5825,11 @@ MyControl.Font = New Font(MyControl.Font, _ Retrieves the control that contains the specified handle. The that represents the control associated with the specified handle; returns if no control with the specified handle is found. - method, because it correctly returns controls that own more than one handle. - + method, because it correctly returns controls that own more than one handle. + ]]> @@ -5869,11 +5869,11 @@ MyControl.Font = New Font(MyControl.Font, _ Returns the control that is currently associated with the specified handle. A that represents the control associated with the specified handle; returns if no control with the specified handle is found. - method if you need to return controls that own more than one handle. - + method if you need to return controls that own more than one handle. + ]]> @@ -5976,11 +5976,11 @@ MyControl.Font = New Font(MyControl.Font, _ Retrieves the child control that is located at the specified coordinates. A that represents the control that is located at the specified point. - method returns `null`. - + method returns `null`. + ]]> @@ -6076,11 +6076,11 @@ MyControl.Font = New Font(MyControl.Font, _ Retrieves the next control forward or back in the tab order of child controls. The next in the tab order. - method is dependent on tab order. To iterate through all controls of a form, including nested controls, use the property. To get or set the active control of a container control, use the property. - + method is dependent on tab order. To iterate through all controls of a form, including nested controls, use the property. To get or set the active control of a container control, use the property. + ]]> @@ -6118,11 +6118,11 @@ MyControl.Font = New Font(MyControl.Font, _ Retrieves the size of a rectangular area into which a control can be fitted. An ordered pair of type representing the width and height of a rectangle. - differs by control. The might be unable to assign the returned size to the control. You can return a size larger than the constraints indicated in the `proposedSize` parameter, but `proposedSize` should decrease as the constraint decreases. For example, `GetPreferredSize(new Size(100, 0))` should not be wider than `GetPreferredSize(new Size(200, 0))`. The exception is a `proposedSize` of 0 or `Size.Empty`, which are defined as unconstrained. - + differs by control. The might be unable to assign the returned size to the control. You can return a size larger than the constraints indicated in the `proposedSize` parameter, but `proposedSize` should decrease as the constraint decreases. For example, `GetPreferredSize(new Size(100, 0))` should not be wider than `GetPreferredSize(new Size(200, 0))`. The exception is a `proposedSize` of 0 or `Size.Empty`, which are defined as unconstrained. + ]]> @@ -6163,11 +6163,11 @@ MyControl.Font = New Font(MyControl.Font, _ Retrieves the bounds within which the control is scaled. A representing the bounds within which the control is scaled. - to retrieve the bounds within which the control is scaled. You can override this method to reuse the scaling logic, but you must supply your own bounds. The default implementation returns scaled bounds that take into account the `specified` bounds, whether the control is top level, whether the control is fixed width or auto size, and any adornments the control might have. - + to retrieve the bounds within which the control is scaled. You can override this method to reuse the scaling logic, but you must supply your own bounds. The default implementation returns scaled bounds that take into account the `specified` bounds, whether the control is top level, whether the control is fixed width or auto size, and any adornments the control might have. + ]]> @@ -6203,20 +6203,20 @@ MyControl.Font = New Font(MyControl.Font, _ if the specified control style bit is set to ; otherwise, . - method and passing in the appropriate bit and the Boolean value to set the bit to. To determine the value assigned to a specified bit, use the method and pass in the member to evaluate. - - - -## Examples - The following code example returns the value of the double-buffering related style bits for a . This example returns `true` only if all the style bits are set to `true`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet4"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet4"::: - + method and passing in the appropriate bit and the Boolean value to set the bit to. To determine the value assigned to a specified bit, use the method and pass in the member to evaluate. + + + +## Examples + The following code example returns the value of the double-buffering related style bits for a . This example returns `true` only if all the style bits are set to `true`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet4"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet4"::: + ]]> @@ -6273,55 +6273,55 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs during a drag operation. - event is raised when a drag-and-drop operation is started. With the event, the source of a drag event can modify the appearance of the mouse pointer in order to give the user visual feedback during a drag-and-drop operation. - - The following describes how and when events related to drag-and-drop operations are raised. - - The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. - - If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - - Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. - -- If the user moves out of a window, the event is raised. - -- If the mouse enters another control, the for that control is raised. - -- If the mouse moves but stays within the same control, the event is raised. - - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . - -- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. - - > [!NOTE] - > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. - -- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - -- If the value of is `Cancel`, the event is raised. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. - - The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. - - The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. - - The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. - - This code excerpt demonstrates using the event. See the method for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet3"::: - + event is raised when a drag-and-drop operation is started. With the event, the source of a drag event can modify the appearance of the mouse pointer in order to give the user visual feedback during a drag-and-drop operation. + + The following describes how and when events related to drag-and-drop operations are raised. + + The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. + + If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + + Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. + +- If the user moves out of a window, the event is raised. + +- If the mouse enters another control, the for that control is raised. + +- If the mouse moves but stays within the same control, the event is raised. + + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . + +- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + + > [!NOTE] + > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. + +- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. + +- If the value of is `Cancel`, the event is raised. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates a drag-and-drop operation between two controls. The example calls the method when the drag action starts. The drag action starts if the mouse has moved more than from the mouse location during the event. The method is used to determine the index of the item to drag during the `MouseDown` event. + + The example also demonstrates using custom cursors for the drag-and-drop operation. The example requires that two cursor files, `3dwarro.cur` and `3dwno.cur`, exist in the application directory, for the custom drag and no-drop cursors, respectively. The custom cursors will be used if the `UseCustomCursorsCheck` is checked. The custom cursors are set in the event handler. + + The keyboard state is evaluated in the event handler for the right `ListBox`, to determine what the drag operation will be based on state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. The location in the `ListBox` where the drop would occur is also determined during the `DragOver` event. If the data to drop is not a `String`, then the is set to `None` in . Finally, the status of the drop is displayed in the `DropLocationLabel`. + + The data to drop for the right `ListBox` is determined in the event handler and the `String` value is added at the appropriate place in the `ListBox`. If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the event handler. + + This code excerpt demonstrates using the event. See the method for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet3"::: + ]]> @@ -6359,56 +6359,56 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control receives focus. - or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - - **Note** The and events are low-level focus events that are tied to the WM_KILLFOCUS and WM_SETFOCUS Windows messages. Typically, the and events are only used when updating or when writing custom controls. Instead the and events should be used for all controls except the class, which uses the and events. For more information about the and events, see the [WM_SETFOCUS](/windows/win32/inputdev/wm-setfocus) and [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topics. - -> [!CAUTION] -> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topic. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet47"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet47"::: - + or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + + **Note** The and events are low-level focus events that are tied to the WM_KILLFOCUS and WM_SETFOCUS Windows messages. Typically, the and events are only used when updating or when writing custom controls. Instead the and events should be used for all controls except the class, which uses the and events. For more information about the and events, see the [WM_SETFOCUS](/windows/win32/inputdev/wm-setfocus) and [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topics. + +> [!CAUTION] +> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topic. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet47"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet47"::: + ]]> @@ -6458,20 +6458,20 @@ MyControl.Font = New Font(MyControl.Font, _ Gets the window handle that the control is bound to. An that contains the window handle () of the control. - property is a Windows `HWND`. If the handle has not yet been created, referencing this property will force the handle to be created. - - - -## Examples - The following code example demonstrates using the and the property. To run the example paste the following code in a form. Add two buttons named `Button1` and `Button2` to the form and ensure all events are connected to their event handlers. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlPaint1/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlPaint1/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlPaint1/VB/form1.vb" id="Snippet2"::: - + property is a Windows `HWND`. If the handle has not yet been created, referencing this property will force the handle to be created. + + + +## Examples + The following code example demonstrates using the and the property. To run the example paste the following code in a form. Add two buttons named `Button1` and `Button2` to the form and ensure all events are connected to their event handlers. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlPaint1/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlPaint1/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlPaint1/VB/form1.vb" id="Snippet2"::: + ]]> @@ -6517,23 +6517,23 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when a handle is created for the control. - is displayed for the first time. For example, if a is created that has set to `false`, the event will not be raised until is set to `true`. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet37"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet37"::: - + is displayed for the first time. For example, if a is created that has set to `false`, the event will not be raised until is set to `true`. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet37"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet37"::: + ]]> @@ -6580,23 +6580,23 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control's handle is in the process of being destroyed. - event, the control is still a valid Windows control and the can be recreated by calling the method. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet38"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet38"::: - + event, the control is still a valid Windows control and the can be recreated by calling the method. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet38"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet38"::: + ]]> @@ -6649,20 +6649,20 @@ MyControl.Font = New Font(MyControl.Font, _ if the control contains one or more child controls; otherwise, . - collection has a greater than zero, the property will return `true`. Accessing the property does not force the creation of a if the control has no children, so referencing this property can provide a performance benefit when walking a tree of controls. - - - -## Examples - The following code example sets the and of the controls to the default system colors. The code recursively calls itself if the control has any child controls. This code example requires that you have a with at least one child control; however, a child container control, like a or , with its own child control(s) would better demonstrate the recursion. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet1"::: - + collection has a greater than zero, the property will return `true`. Accessing the property does not force the creation of a if the control has no children, so referencing this property can provide a performance benefit when walking a tree of controls. + + + +## Examples + The following code example sets the and of the controls to the default system colors. The code recursively calls itself if the control has any child controls. This code example requires that you have a with at least one child control; however, a child container control, like a or , with its own child control(s) would better demonstrate the recursion. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet1"::: + ]]> @@ -6709,23 +6709,23 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the height of the control. The height of the control in pixels. - and property values cause the property value of the control to change. - -> [!NOTE] -> The minimum height for the derived control is one pixel. The default height for the control is three pixels. Setting the height of the control to a value less than one will reset the property value to the default height. - - - -## Examples - The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: - + and property values cause the property value of the control to change. + +> [!NOTE] +> The minimum height for the derived control is one pixel. The default height for the control is three pixels. Setting the height of the control to a value less than one will reset the property value to the default height. + + + +## Examples + The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: + ]]> @@ -6755,22 +6755,22 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the user requests help for a control. - event is commonly raised when the user presses the F1 key or an associated context-sensitive help button is clicked. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates handling the event to display custom Help content on a form containing four address fields. The event is raised either by pressing the F1 key with the focus in an address field, or by the using the context-sensitive Help button and clicking the Help cursor on an address field. The property is set to true to indicate that the `HelpRequested` event is handled. The example also demonstrates storing the Help text in the property. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.HelpEventHandler/CPP/helpevent.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.HelpEventHandler/CS/helpevent.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.HelpEventHandler/VB/helpevent.vb" id="Snippet1"::: - + event is commonly raised when the user presses the F1 key or an associated context-sensitive help button is clicked. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates handling the event to display custom Help content on a form containing four address fields. The event is raised either by pressing the F1 key with the focus in an address field, or by the using the context-sensitive Help button and clicking the Help cursor on an address field. The property is set to true to indicate that the `HelpRequested` event is handled. The example also demonstrates storing the Help text in the property. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.HelpEventHandler/CPP/helpevent.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.HelpEventHandler/CS/helpevent.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.HelpEventHandler/VB/helpevent.vb" id="Snippet1"::: + ]]> @@ -6807,20 +6807,20 @@ MyControl.Font = New Font(MyControl.Font, _ Conceals the control from the user. - property to `false`. After the method is called, the property returns a value of `false` until the method is called. - - - -## Examples - The following code example hides a button if the CTRL key is pressed when the button is clicked. This example requires that you have a named `button1` on a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet2"::: - + property to `false`. After the method is called, the property returns a value of `false` until the method is called. + + + +## Examples + The following code example hides a button if the CTRL key is pressed when the button is clicked. This example requires that you have a named `button1` on a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet2"::: + ]]> @@ -6864,18 +6864,18 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the Input Method Editor (IME) mode of the control. One of the values. The default is . - property is typically set to for a control that is intended to only enter numeric values. The property value is set to for the class. - - Most classes that do not directly support Input Method Editors, or allow direct input from an IME, will set the value of this property to . - -> [!IMPORTANT] -> The user can interactively change the unless it has been programmatically set to . In this case, the user will not be able to use the IME. -> -> The property is ignored on Windows 8 when the global input mode is in effect. For more info, see [Switch Text Input Changed from Per-Thread to Per-User](https://go.microsoft.com/fwlink/?LinkID=256509). - + property is typically set to for a control that is intended to only enter numeric values. The property value is set to for the class. + + Most classes that do not directly support Input Method Editors, or allow direct input from an IME, will set the value of this property to . + +> [!IMPORTANT] +> The user can interactively change the unless it has been programmatically set to . In this case, the user will not be able to use the IME. +> +> The property is ignored on Windows 8 when the global input mode is in effect. For more info, see [Switch Text Input Changed from Per-Thread to Per-User](https://go.microsoft.com/fwlink/?LinkID=256509). + ]]> The assigned value is not one of the enumeration values. @@ -6929,26 +6929,26 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the property has changed. - property is changed by either a programmatic modification or through interaction. - - Controls that do not support Input Method Managers will never raise this event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or through interaction. + + Controls that do not support Input Method Managers will never raise this event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -6985,11 +6985,11 @@ MyControl.Font = New Font(MyControl.Font, _ Called after the control has been added to another container. - method is called immediately after adding a control to a container. The method enables a control to initialize its layout state based on its container. For example, you would typically apply anchoring and docking to the control in the method. - + method is called immediately after adding a control to a container. The method enables a control to initialize its layout state based on its container. For example, you would typically apply anchoring and docking to the control in the method. + ]]> @@ -7041,20 +7041,20 @@ MyControl.Font = New Font(MyControl.Font, _ Invalidates the entire surface of the control and causes the control to be redrawn. - method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. - - - -## Examples - The following code example enables the user to drag an image or image file onto the form, and have it be displayed at the point on it is dropped. The method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: - + method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. + + + +## Examples + The following code example enables the user to drag an image or image file onto the form, and have it be displayed at the point on it is dropped. The method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: + ]]> @@ -7088,11 +7088,11 @@ MyControl.Font = New Font(MyControl.Font, _ to invalidate the control's child controls; otherwise, . Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. - method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. - + method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. + ]]> @@ -7131,11 +7131,11 @@ MyControl.Font = New Font(MyControl.Font, _ A that represents the region to invalidate. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. - method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. - + method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. + ]]> @@ -7174,11 +7174,11 @@ MyControl.Font = New Font(MyControl.Font, _ The to invalidate. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. - method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. - + method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. + ]]> @@ -7214,11 +7214,11 @@ MyControl.Font = New Font(MyControl.Font, _ to invalidate the control's child controls; otherwise, . Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. - method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. - + method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. + ]]> @@ -7254,11 +7254,11 @@ MyControl.Font = New Font(MyControl.Font, _ to invalidate the control's child controls; otherwise, . Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. - method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. - + method does not force a synchronous paint; to force a synchronous paint, call the method after calling the method. When this method is called with no parameters, the entire client area is added to the update region. + ]]> @@ -7297,21 +7297,21 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when a control's display requires redrawing. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet40"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet40"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet40"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet40"::: + ]]> @@ -7346,8 +7346,8 @@ MyControl.Font = New Font(MyControl.Font, _ - To be added. - To be added. + A delegate that contains a method to be called in the control's thread context. + Executes the specified delegate on the thread that owns the control's underlying window handle. To be added. @@ -7384,30 +7384,30 @@ MyControl.Font = New Font(MyControl.Font, _ Executes the specified delegate on the thread that owns the control's underlying window handle. The return value from the delegate being invoked, or if the delegate has no return value. - method searches up the control's parent chain until it finds a control or form that has a window handle if the current control's underlying window handle does not exist yet. If no appropriate handle can be found, the method will throw an exception. Exceptions that are raised during the call will be propagated back to the caller. - -> [!NOTE] -> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. - - The delegate can be an instance of , in which case the sender parameter will contain this control, and the event parameter will contain . The delegate can also be an instance of , or any other delegate that takes a void parameter list. A call to an or delegate will be faster than a call to another type of delegate. - -> [!NOTE] -> An exception might be thrown if the thread that should process the message is no longer active. - - - -## Examples - The following code example shows controls that contain a delegate. The delegate encapsulates a method that adds items to the list box, and this method is executed on the thread that owns the underlying handle of the form. When the user clicks on the button, `Invoke` runs the delegate. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Invoke2/CPP/control_invoke2.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Invoke2/CS/control_invoke2.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Invoke2/VB/control_invoke2.vb" id="Snippet1"::: - + method searches up the control's parent chain until it finds a control or form that has a window handle if the current control's underlying window handle does not exist yet. If no appropriate handle can be found, the method will throw an exception. Exceptions that are raised during the call will be propagated back to the caller. + +> [!NOTE] +> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. + + The delegate can be an instance of , in which case the sender parameter will contain this control, and the event parameter will contain . The delegate can also be an instance of , or any other delegate that takes a void parameter list. A call to an or delegate will be faster than a call to another type of delegate. + +> [!NOTE] +> An exception might be thrown if the thread that should process the message is no longer active. + + + +## Examples + The following code example shows controls that contain a delegate. The delegate encapsulates a method that adds items to the list box, and this method is executed on the thread that owns the underlying handle of the form. When the user clicks on the button, `Invoke` runs the delegate. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Invoke2/CPP/control_invoke2.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Invoke2/CS/control_invoke2.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Invoke2/VB/control_invoke2.vb" id="Snippet1"::: + ]]> @@ -7456,30 +7456,30 @@ MyControl.Font = New Font(MyControl.Font, _ Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. An that contains the return value from the delegate being invoked, or if the delegate has no return value. - [!NOTE] -> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. - - The delegate can be an instance of , in which case the sender parameter will contain this control, and the event parameter will contain . The delegate can also be an instance of , or any other delegate that takes a void parameter list. A call to an or delegate will be faster than a call to another type of delegate. - -> [!NOTE] -> An exception might be thrown if the thread that should process the message is no longer active. - - - -## Examples - The following code example shows controls that contain a delegate. The delegate encapsulates a method that adds items to the list box, and this method is executed on the thread that owns the underlying handle of the form, using the specified arguments. When the user clicks on the button, `Invoke` runs the delegate. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Invoke1/CPP/control_invoke1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Invoke1/CS/control_invoke1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Invoke1/VB/control_invoke1.vb" id="Snippet1"::: - + [!NOTE] +> In addition to the property, there are four methods on a control that are thread safe: , , , and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread. + + The delegate can be an instance of , in which case the sender parameter will contain this control, and the event parameter will contain . The delegate can also be an instance of , or any other delegate that takes a void parameter list. A call to an or delegate will be faster than a call to another type of delegate. + +> [!NOTE] +> An exception might be thrown if the thread that should process the message is no longer active. + + + +## Examples + The following code example shows controls that contain a delegate. The delegate encapsulates a method that adds items to the list box, and this method is executed on the thread that owns the underlying handle of the form, using the specified arguments. When the user clicks on the button, `Invoke` runs the delegate. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Invoke1/CPP/control_invoke1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Invoke1/CS/control_invoke1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Invoke1/VB/control_invoke1.vb" id="Snippet1"::: + ]]> @@ -7508,10 +7508,10 @@ MyControl.Font = New Font(MyControl.Font, _ - To be added. - To be added. - To be added. - To be added. + The return type of the . + A function to be called in the control's thread context. + Executes the specified delegate on the thread that owns the control's underlying window handle. + The return value from the function being invoked. To be added. @@ -7743,31 +7743,31 @@ MyControl.Font = New Font(MyControl.Font, _ if the control's was created on a different thread than the calling thread (indicating that you must make calls to the control through an invoke method); otherwise, . - [!NOTE] -> In addition to the property, there are four methods on a control that are thread safe to call: ,, and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of these invoke methods when calling from a different thread. - - If the control's handle does not yet exist, searches up the control's parent chain until it finds a control or form that does have a window handle. If no appropriate handle can be found, the method returns `false`. - - This means that can return `false` if is not required (the call occurs on the same thread), or if the control was created on a different thread but the control's handle has not yet been created. - - In the case where the control's handle has not yet been created, you should not simply call properties, methods, or events on the control. This might cause the control's handle to be created on the background thread, isolating the control on a thread without a message pump and making the application unstable. - - You can protect against this case by also checking the value of when returns `false` on a background thread. If the control handle has not yet been created, you must wait until it has been created before calling or . Typically, this happens only if a background thread is created in the constructor of the primary form for the application (as in `Application.Run(new MainForm())`, before the form has been shown or `Application.Run` has been called. - - One solution is to wait until the form's handle has been created before starting the background thread. Either force handle creation by calling the property, or wait until the event to start the background process. - - An even better solution is to use the `SynchronizationContext` returned by rather than a control for cross-thread marshaling. - -> [!NOTE] -> An exception might be thrown if the thread that should process the message is no longer active. - - For more information about multithreaded Windows Forms controls, see [How to: Use a Background Thread to Search for Files](/dotnet/framework/winforms/controls/how-to-use-a-background-thread-to-search-for-files) and [How to: Make Thread-Safe Calls to Windows Forms Controls](/dotnet/framework/winforms/controls/how-to-make-thread-safe-calls-to-windows-forms-controls). - + [!NOTE] +> In addition to the property, there are four methods on a control that are thread safe to call: ,, and if the handle for the control has already been created. Calling before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of these invoke methods when calling from a different thread. + + If the control's handle does not yet exist, searches up the control's parent chain until it finds a control or form that does have a window handle. If no appropriate handle can be found, the method returns `false`. + + This means that can return `false` if is not required (the call occurs on the same thread), or if the control was created on a different thread but the control's handle has not yet been created. + + In the case where the control's handle has not yet been created, you should not simply call properties, methods, or events on the control. This might cause the control's handle to be created on the background thread, isolating the control on a thread without a message pump and making the application unstable. + + You can protect against this case by also checking the value of when returns `false` on a background thread. If the control handle has not yet been created, you must wait until it has been created before calling or . Typically, this happens only if a background thread is created in the constructor of the primary form for the application (as in `Application.Run(new MainForm())`, before the form has been shown or `Application.Run` has been called. + + One solution is to wait until the form's handle has been created before starting the background thread. Either force handle creation by calling the property, or wait until the event to start the background process. + + An even better solution is to use the `SynchronizationContext` returned by rather than a control for cross-thread marshaling. + +> [!NOTE] +> An exception might be thrown if the thread that should process the message is no longer active. + + For more information about multithreaded Windows Forms controls, see [How to: Use a Background Thread to Search for Files](/dotnet/framework/winforms/controls/how-to-use-a-background-thread-to-search-for-files) and [How to: Make Thread-Safe Calls to Windows Forms Controls](/dotnet/framework/winforms/controls/how-to-make-thread-safe-calls-to-windows-forms-controls). + ]]> @@ -7827,6 +7827,41 @@ MyControl.Font = New Font(MyControl.Font, _ + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Indicates if one of the Ancestors of this control is sited and that site in DesignMode. This property is read-only. + To be added. + To be added. + + @@ -7869,11 +7904,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the control has been disposed of; otherwise, . - method. - + method. + ]]> @@ -7923,11 +7958,11 @@ MyControl.Font = New Font(MyControl.Font, _ if a handle has been assigned to the control; otherwise, . - property to determine whether has been called. - + property to determine whether has been called. + ]]> @@ -7969,11 +8004,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the character should be sent directly to the control and not preprocessed; otherwise, . - method to determine whether the character specified by the `charCode` parameter is an input character that the control wants. This method is called during window message preprocessing to determine whether the specified input character should be preprocessed or sent directly to the control. If returns `true`, the specified character is sent directly to the control. If returns `false`, the specified character is preprocessed and only sent to the control if it is not consumed by the preprocessing phase. The preprocessing of a character includes checking whether the character is a mnemonic of another control. - + method to determine whether the character specified by the `charCode` parameter is an input character that the control wants. This method is called during window message preprocessing to determine whether the specified input character should be preprocessed or sent directly to the control. If returns `true`, the specified character is sent directly to the control. If returns `false`, the specified character is preprocessed and only sent to the control if it is not consumed by the preprocessing phase. The preprocessing of a character includes checking whether the character is a mnemonic of another control. + ]]> @@ -8007,19 +8042,19 @@ MyControl.Font = New Font(MyControl.Font, _ if the specified key is a regular input key; otherwise, . - method to determine whether the key specified by the `keyData` parameter is an input key that the control wants. This method is called during window message preprocessing to determine whether the specified input key should be preprocessed or sent directly to the control. If returns `true`, the specified key is sent directly to the control. If returns `false`, the specified key is preprocessed and only sent to the control if it is not consumed by the preprocessing phase. Keys that are preprocessed include the TAB, RETURN, ESC, and the UP ARROW, DOWN ARROW, LEFT ARROW, and RIGHT ARROW keys. - - - -## Examples - The following code example shows you how to override the method for a control. In this example, the `TabTextBox` class handles the TAB key. When the `TabTextBox` has the focus and the user presses the TAB key four spaces are added at the text insertion point, replacing any selected text. By default, the control handles the TAB key by moving the input focus to the next control. In this case, the keypress never reaches the method override. To prevent this default behavior, the method override returns `true` when the user presses the TAB key. For all other keypresses, the method override returns the result of calling the base-class version of the method. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.IsInputKey/cs/form1.cs" id="Snippet0"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.IsInputKey/vb/form1.vb" id="Snippet0"::: - + method to determine whether the key specified by the `keyData` parameter is an input key that the control wants. This method is called during window message preprocessing to determine whether the specified input key should be preprocessed or sent directly to the control. If returns `true`, the specified key is sent directly to the control. If returns `false`, the specified key is preprocessed and only sent to the control if it is not consumed by the preprocessing phase. Keys that are preprocessed include the TAB, RETURN, ESC, and the UP ARROW, DOWN ARROW, LEFT ARROW, and RIGHT ARROW keys. + + + +## Examples + The following code example shows you how to override the method for a control. In this example, the `TabTextBox` class handles the TAB key. When the `TabTextBox` has the focus and the user presses the TAB key four spaces are added at the text insertion point, replacing any selected text. By default, the control handles the TAB key by moving the input focus to the next control. In this case, the keypress never reaches the method override. To prevent this default behavior, the method override returns `true` when the user presses the TAB key. For all other keypresses, the method override returns the result of calling the base-class version of the method. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.IsInputKey/cs/form1.cs" id="Snippet0"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.IsInputKey/vb/form1.vb" id="Snippet0"::: + ]]> @@ -8054,20 +8089,20 @@ MyControl.Font = New Font(MyControl.Font, _ if the specified key or keys are in effect; otherwise, . - property to determine whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK keys are on, whether individually or in combination. - - - -## Examples - The following code example displays a message box indicating whether the specified key (the Caps Lock key in this case) is in effect. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/ControlIsKeyLocked/CPP/controliskeylocked.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/ControlIsKeyLocked/CS/controliskeylocked.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/ControlIsKeyLocked/VB/controliskeylocked.vb" id="Snippet1"::: - + property to determine whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK keys are on, whether individually or in combination. + + + +## Examples + The following code example displays a message box indicating whether the specified key (the Caps Lock key in this case) is in effect. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/ControlIsKeyLocked/CPP/controliskeylocked.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/ControlIsKeyLocked/CS/controliskeylocked.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/ControlIsKeyLocked/VB/controliskeylocked.vb" id="Snippet1"::: + ]]> The parameter refers to a key other than the CAPS LOCK, NUM LOCK, or SCROLL LOCK key. @@ -8110,11 +8145,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the control is mirrored; otherwise, . - @@ -8149,20 +8184,20 @@ MyControl.Font = New Font(MyControl.Font, _ if the character is the mnemonic character assigned to the control; otherwise, . - . - - - -## Examples - The following code example demonstrates an extension of the button class that overrides the method to exhibit custom behavior. The example also demonstrates the use of the and properties. To run this example paste the following code after a form class, in the same file. Add a button of type `MnemonicButton` to the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/VB/form1.vb" id="Snippet1"::: - + . + + + +## Examples + The following code example demonstrates an extension of the button class that overrides the method to exhibit custom behavior. The example also demonstrates the use of the and properties. To run this example paste the following code after a form class, in the same file. Add a button of type `MnemonicButton` to the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/VB/form1.vb" id="Snippet1"::: + ]]> @@ -8190,36 +8225,36 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when a key is pressed while the control has focus. - - -2. - -3. - - To handle keyboard events only at the form level and not enable other controls to receive keyboard events, set the property in your form's event-handling method to `true`. Certain keys, such as the TAB, RETURN, ESC, and arrow keys are handled by controls automatically. To have these keys raise the event, you must override the method in each control on your form. The code for the override of the would need to determine if one of the special keys is pressed and return a value of `true`. Instead of overriding the method, you can handle the event and set the property to `true`. For a code example, see the event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the event to determine the type of character entered into the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: - - - The following code example demonstrates the order of raising the , , events, and how to register event handlers on them. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form2.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/Form2.vb" id="Snippet1"::: - + + +2. + +3. + + To handle keyboard events only at the form level and not enable other controls to receive keyboard events, set the property in your form's event-handling method to `true`. Certain keys, such as the TAB, RETURN, ESC, and arrow keys are handled by controls automatically. To have these keys raise the event, you must override the method in each control on your form. The code for the override of the would need to determine if one of the special keys is pressed and return a value of `true`. Instead of overriding the method, you can handle the event and set the property to `true`. For a code example, see the event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the event to determine the type of character entered into the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: + + + The following code example demonstrates the order of raising the , , events, and how to register event handlers on them. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form2.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/Form2.vb" id="Snippet1"::: + ]]> @@ -8252,40 +8287,40 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when a character. space or backspace key is pressed while the control has focus. - - -2. - -3. - - The event is not raised by non-character keys other than space and backspace; however, the non-character keys do raise the and events. - - Use the property to sample keystrokes at run time and to consume or modify a subset of common keystrokes. - - To handle keyboard events only at the form level and not enable other controls to receive keyboard events, set the property in your form's event-handling method to `true`. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the event to prevent characters from entering the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: - - - The following code example demonstrates the order of rising the , and events, also how to register event handlers on them. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form2.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/Form2.vb" id="Snippet1"::: - + + +2. + +3. + + The event is not raised by non-character keys other than space and backspace; however, the non-character keys do raise the and events. + + Use the property to sample keystrokes at run time and to consume or modify a subset of common keystrokes. + + To handle keyboard events only at the form level and not enable other controls to receive keyboard events, set the property in your form's event-handling method to `true`. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the event to prevent characters from entering the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: + + + The following code example demonstrates the order of rising the , and events, also how to register event handlers on them. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form2.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/Form2.vb" id="Snippet1"::: + ]]> @@ -8317,36 +8352,36 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when a key is released while the control has focus. - - -2. - -3. - - To handle keyboard events only at the form level and not enable other controls to receive keyboard events, set the property in your form's event-handling method to `true`. Certain keys, such as the TAB, RETURN, ESC, and arrow keys are handled by controls automatically. To have these keys raise the event, you must override the method in each control on your form. The code for the override of would need to determine if one of the special keys is pressed and return a value of `true`. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the event with the class to display pop-up style help to the user. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: - - - The following code example demonstrates the order of rising the , and events, also how to register event handlers on them. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form2.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/Form2.vb" id="Snippet1"::: - + + +2. + +3. + + To handle keyboard events only at the form level and not enable other controls to receive keyboard events, set the property in your form's event-handling method to `true`. Certain keys, such as the TAB, RETURN, ESC, and arrow keys are handled by controls automatically. To have these keys raise the event, you must override the method in each control on your form. The code for the override of would need to determine if one of the special keys is pressed and return a value of `true`. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the event with the class to display pop-up style help to the user. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: + + + The following code example demonstrates the order of rising the , and events, also how to register event handlers on them. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form2.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/Form2.vb" id="Snippet1"::: + ]]> @@ -8376,22 +8411,22 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when a control should reposition its child controls. - event occurs when child controls are added or removed, when the bounds of the control changes, and when other changes occur that can affect the layout of the control. The layout event can be suppressed using the and methods. Suspending layout enables you to perform multiple actions on a control without having to perform a layout for each change. For example, if you resize and move a control, each operation would raise a event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example centers a on the screen in the event. This will keep the form centered as the user resizes it. This example requires that you have created a control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Layout/CPP/layout.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Layout/CS/layout.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Layout/VB/layout.vb" id="Snippet1"::: - + event occurs when child controls are added or removed, when the bounds of the control changes, and when other changes occur that can affect the layout of the control. The layout event can be suppressed using the and methods. Suspending layout enables you to perform multiple actions on a control without having to perform a layout for each change. For example, if you resize and move a control, each operation would raise a event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example centers a on the screen in the event. This will keep the form centered as the user resizes it. This example requires that you have created a control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Layout/CPP/layout.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Layout/CS/layout.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Layout/VB/layout.vb" id="Snippet1"::: + ]]> @@ -8439,11 +8474,11 @@ MyControl.Font = New Font(MyControl.Font, _ Gets a cached instance of the control's layout engine. The for the control's contents. - property gets the layout engine for the control's children rather than for the control itself. - + property gets the layout engine for the control's children rather than for the control itself. + ]]> @@ -8477,56 +8512,56 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the input focus leaves the control. - or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - -> [!NOTE] -> The and events are suppressed by the class. The equivalent events in the class are the and events. The and events are hierarchical and will cascade up and down the parent chain until the appropriate control is reached. For example, assume you have a with two controls, and each control has one control. When the caret is moved from one to the other, the event is raised for the and , and the event is raised for the other and . - -> [!CAUTION] -> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topic. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the event to reset a control to its former state. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: - + or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + +> [!NOTE] +> The and events are suppressed by the class. The equivalent events in the class are the and events. The and events are hierarchical and will cascade up and down the parent chain until the appropriate control is reached. For example, assume you have a with two controls, and each control has one control. When the caret is moved from one to the other, the event is raised for the and , and the event is raised for the other and . + +> [!CAUTION] +> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topic. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the event to reset a control to its former state. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: + ]]> @@ -8574,22 +8609,22 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. An representing the distance, in pixels, between the left edge of the control and the left edge of its container's client area. - property value is equivalent to the property of the property value of the control. - - Changes made to the and property values cause the property value of the control to change. - - - -## Examples - The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: - + property value is equivalent to the property of the property value of the control. + + Changes made to the and property values cause the property value of the control to change. + + + +## Examples + The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: + ]]> @@ -8625,22 +8660,22 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. The that represents the upper-left corner of the control relative to the upper-left corner of its container. - class is a value type (`Structure` in Visual Basic, `struct` in Visual C#), it is returned by value, meaning accessing the property returns a copy of the upper-left point of the control. So, adjusting the or properties of the returned from this property will not affect the , , , or property values of the control. To adjust these properties set each property value individually, or set the property with a new . - - If the is a , the property value represents the upper-left corner of the in screen coordinates. - - - -## Examples - The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: - + class is a value type (`Structure` in Visual Basic, `struct` in Visual C#), it is returned by value, meaning accessing the property returns a copy of the upper-left point of the control. So, adjusting the or properties of the returned from this property will not affect the , , , or property values of the control. To adjust these properties set each property value individually, or set the property with a new . + + If the is a , the property value represents the upper-left corner of the in screen coordinates. + + + +## Examples + The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: + ]]> @@ -8669,21 +8704,21 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the property value has changed. - property is changed by either a programmatic modification or through interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example raises the event on a when the form is resized. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.LocationChanged/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LocationChanged/VB/form1.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or through interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example raises the event on a when the form is resized. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.LocationChanged/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LocationChanged/VB/form1.vb" id="Snippet1"::: + ]]> @@ -8776,58 +8811,58 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control loses focus. - or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - - If the property of the is set to `true` in the event delegate, all events that would usually occur after the event are suppressed. - -> [!NOTE] -> The and events are low-level focus events that are tied to the WM_KILLFOCUS and WM_SETFOCUS Windows messages. Typically, the and events are only used when updating or when writing custom controls. Instead the and events should be used for all controls except the class, which uses the and events. For more information about the and events, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) and [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topics. - -> [!CAUTION] -> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topic. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates validating the text for TextBox1. It also demonstrates handling the event by setting the property to the text in TextBox1. The code example used the method to check for an error before opening the file dialog box. To run this example, paste the following code into a form containing a named `TextBox1`, an named `OpenFileDialog1`, a named `Button1`, and an named `ErrorProvider1`. Ensure all events are associated with their event handlers. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CPP/filedialogform.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CS/filedialogform.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/VB/filedialogform.vb" id="Snippet2"::: - + or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + + If the property of the is set to `true` in the event delegate, all events that would usually occur after the event are suppressed. + +> [!NOTE] +> The and events are low-level focus events that are tied to the WM_KILLFOCUS and WM_SETFOCUS Windows messages. Typically, the and events are only used when updating or when writing custom controls. Instead the and events should be used for all controls except the class, which uses the and events. For more information about the and events, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) and [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topics. + +> [!CAUTION] +> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/inputdev/wm-killfocus) topic. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates validating the text for TextBox1. It also demonstrates handling the event by setting the property to the text in TextBox1. The code example used the method to check for an error before opening the file dialog box. To run this example, paste the following code into a form containing a named `TextBox1`, an named `OpenFileDialog1`, a named `Button1`, and an named `ErrorProvider1`. Ensure all events are associated with their event handlers. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CPP/filedialogform.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/CS/filedialogform.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FileDialog/VB/filedialogform.vb" id="Snippet2"::: + ]]> @@ -8864,14 +8899,14 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the space between controls. A representing the space between controls. - that are reasonably close to Windows user interface guidelines. Some adjustments might still be necessary for particular applications. - -> [!NOTE] -> Setting the property on a docked control has no effect on the distance of the control from the edges of its container. - + that are reasonably close to Windows user interface guidelines. Some adjustments might still be necessary for particular applications. + +> [!NOTE] +> Setting the property on a docked control has no effect on the distance of the control from the edges of its container. + ]]> @@ -8897,21 +8932,21 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control's margin changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet21"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet21"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet21"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet21"::: + ]]> @@ -9003,15 +9038,15 @@ MyControl.Font = New Font(MyControl.Font, _ Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. A bitwise combination of the values. The default is . - named `button1` on a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet2"::: - + named `button1` on a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet2"::: + ]]> @@ -9040,15 +9075,15 @@ MyControl.Font = New Font(MyControl.Font, _ Gets a value indicating which of the mouse buttons is in a pressed state. A bitwise combination of the enumeration values. The default is . - , , , , , and members. To run the example, paste the following code in a form called Form1 containing several controls. This example requires that the , , and events are connected to the event handlers defined in the example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/VB/form1.vb" id="Snippet2"::: - + , , , , , and members. To run the example, paste the following code in a form called Form1 containing several controls. This example requires that the , , and events are connected to the event handlers defined in the example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/VB/form1.vb" id="Snippet2"::: + ]]> @@ -9076,41 +9111,41 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control loses mouse capture. - event. - - - -## Examples - The following code example demonstrates the event for a control. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.mousecapturechanged/cs/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.mousecapturechanged/vb/form1.vb" id="Snippet1"::: - - To test this example, run it in the debugger by pressing F5. Open the **Output** window in Visual Studio so that you can see when events are raised. Click the and notice the following output. - - `button1_MouseDown` - - `button1_MouseUp` - - `button1_MouseCaptureChanged` - - Now, click and hold the left mouse button on the control. While still clicking the mouse, press ALT+TAB to switch to another program. Notice that the event is raised enabling you to potentially handle this scenario. Depending on your actions, the event might not be raised. You can also try this test with the Windows key or CTRL+ESC. - - `button1_MouseDown` - - `button1_MouseCaptureChanged` - + event. + + + +## Examples + The following code example demonstrates the event for a control. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.mousecapturechanged/cs/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.mousecapturechanged/vb/form1.vb" id="Snippet1"::: + + To test this example, run it in the debugger by pressing F5. Open the **Output** window in Visual Studio so that you can see when events are raised. Click the and notice the following output. + + `button1_MouseDown` + + `button1_MouseUp` + + `button1_MouseCaptureChanged` + + Now, click and hold the left mouse button on the control. While still clicking the mouse, press ALT+TAB to switch to another program. Notice that the event is raised enabling you to potentially handle this scenario. Depending on your actions, the event might not be raised. You can also try this test with the Windows key or CTRL+ESC. + + `button1_MouseDown` + + `button1_MouseCaptureChanged` + ]]> @@ -9136,38 +9171,38 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control is clicked by the mouse. - event. - -2. event. - -3. event. - -4. event. - - For this to occur, the various events cannot be disabled in the control's class. - - Two single clicks that occur close enough in time, as determined by the mouse settings of the user's operating system, will generate a event instead of the second event. - -> [!IMPORTANT] -> events are logically higher-level events of a control. They are often raised by other actions, such as pressing the ENTER key when the control has focus. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet54"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet54"::: - + event. + +2. event. + +3. event. + +4. event. + + For this to occur, the various events cannot be disabled in the control's class. + + Two single clicks that occur close enough in time, as determined by the mouse settings of the user's operating system, will generate a event instead of the second event. + +> [!IMPORTANT] +> events are logically higher-level events of a control. They are often raised by other actions, such as pressing the ENTER key when the control has focus. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet54"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet54"::: + ]]> @@ -9199,46 +9234,46 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control is double clicked by the mouse. - event occurs when the user depresses a mouse button twice in quick succession when the cursor is over the control. The time interval that separates two single clicks from a double-click is determined by the mouse settings of the user's operating system. - - The following series of events is raised by the control when such a user action takes place: - -1. event. - -2. event. - -3. event. - -4. event. - -5. event. - -6. event. - -7. event. - -8. event. - - For this to occur, the various events cannot be disabled in the control's class. - -> [!IMPORTANT] -> events are logically higher-level events of a control. They may be raised by other user actions, such as shortcut key combinations. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet55"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet55"::: - + event occurs when the user depresses a mouse button twice in quick succession when the cursor is over the control. The time interval that separates two single clicks from a double-click is determined by the mouse settings of the user's operating system. + + The following series of events is raised by the control when such a user action takes place: + +1. event. + +2. event. + +3. event. + +4. event. + +5. event. + +6. event. + +7. event. + +8. event. + + For this to occur, the various events cannot be disabled in the control's class. + +> [!IMPORTANT] +> events are logically higher-level events of a control. They may be raised by other user actions, such as shortcut key combinations. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet55"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet55"::: + ]]> @@ -9270,35 +9305,35 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse pointer is over the control and a mouse button is pressed. - - -2. - -3. / / - -4. - -5. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + + +2. + +3. / / + +4. + +5. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9329,35 +9364,35 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse pointer enters the control. - - -2. - -3. / / - -4. - -5. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + + +2. + +3. / / + +4. + +5. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9388,39 +9423,39 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse pointer rests on the control. - is to display a tool tip when the mouse pauses on a control within a specified area around the control (the "hover rectangle"). The pause required for this event to be raised is specified in milliseconds by the property. - - The event is defined and detected in connection with the and properties. - - Mouse events occur in the following order: - -1. - -2. - -3. / / - -4. - -5. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + is to display a tool tip when the mouse pauses on a control within a specified area around the control (the "hover rectangle"). The pause required for this event to be raised is specified in milliseconds by the property. + + The event is defined and detected in connection with the and properties. + + Mouse events occur in the following order: + +1. + +2. + +3. / / + +4. + +5. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9450,35 +9485,35 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse pointer leaves the control. - - -2. - -3. / / - -4. - -5. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + + +2. + +3. / / + +4. + +5. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9507,37 +9542,37 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse pointer is moved over the control. - are to change the control's color or to paint a raised rectangle around the control. - - Mouse events occur in the following order: - -1. - -2. - -3. / / - -4. - -5. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + are to change the control's color or to paint a raised rectangle around the control. + + Mouse events occur in the following order: + +1. + +2. + +3. / / + +4. + +5. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9567,22 +9602,22 @@ MyControl.Font = New Font(MyControl.Font, _ Gets the position of the mouse cursor in screen coordinates. A that contains the coordinates of the mouse cursor relative to the upper-left corner of the screen. - property returns a that represents the mouse cursor position at the time the property was referenced. The coordinates indicate the position on the screen, not relative to the control, and are returned regardless of whether the cursor is positioned over the control. The coordinates of the upper-left corner of the screen are 0,0. - - The property is identical to the property. - - - -## Examples - The following code example puts a label into an editable state when the user presses ALT+E while the mouse cursor is over the tree node. After the user is done editing the label, the labels cannot be edited again until the ALT+E key combination is pressed again. This example requires that you have a on a . The tree view should also have at least one in its collection. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet3"::: - + property returns a that represents the mouse cursor position at the time the property was referenced. The coordinates indicate the position on the screen, not relative to the control, and are returned regardless of whether the cursor is positioned over the control. The coordinates of the upper-left corner of the screen are 0,0. + + The property is identical to the property. + + + +## Examples + The following code example puts a label into an editable state when the user presses ALT+E while the mouse cursor is over the tree node. After the user is done editing the label, the labels cannot be edited again until the ALT+E key combination is pressed again. This example requires that you have a on a . The tree view should also have at least one in its collection. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CPP/controlmembers4.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members4/CS/controlmembers4.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members4/VB/controlmembers4.vb" id="Snippet3"::: + ]]> @@ -9611,35 +9646,35 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse pointer is over the control and a mouse button is released. - - -2. - -3. / / - -4. - -5. - -> [!NOTE] -> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + + +2. + +3. / / + +4. + +5. + +> [!NOTE] +> The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the client area of the tab page, the raises the appropriate event. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9678,36 +9713,36 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the mouse wheel moves while the control has focus. - event it is important to follow the user interface (UI) standards associated with the mouse wheel. The property value indicates the amount the mouse wheel has been moved. The UI should scroll when the accumulated delta is plus or minus 120. The UI should scroll the number of logical lines returned by the property for every delta value reached. You can also scroll more smoothly in smaller that 120 unit increments, however the ratio should remain constant, that is lines scrolled per 120 delta units of wheel movement. - - For more information about handling mouse wheel messages, see the [WM_MOUSEWHEEL](/windows/win32/inputdev/wm-mousewheel) topic. - - Mouse events occur in the following order: - -1. - -2. - -3. / / - -4. - -5. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: - + event it is important to follow the user interface (UI) standards associated with the mouse wheel. The property value indicates the amount the mouse wheel has been moved. The UI should scroll when the accumulated delta is plus or minus 120. The UI should scroll the number of logical lines returned by the property for every delta value reached. You can also scroll more smoothly in smaller that 120 unit increments, however the ratio should remain constant, that is lines scrolled per 120 delta units of wheel movement. + + For more information about handling mouse wheel messages, see the [WM_MOUSEWHEEL](/windows/win32/inputdev/wm-mousewheel) topic. + + Mouse events occur in the following order: + +1. + +2. + +3. / / + +4. + +5. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates using different mouse events to draw the path of the mouse on a . A line segment is added to the for each and events that occur. To update the graphics, the method is called for the on each `MouseDown` and `MouseUp` event. In addition, the graphic path is scrolled up or down when the event occurs. Additional mouse events, like , are identified on screen as well. Also displayed on the screen is additional information about the mouse from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CPP/mouseeventexample.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/CS/mouseeventexample.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MouseEvent/VB/mouseeventexample.vb" id="Snippet1"::: + ]]> @@ -9736,20 +9771,20 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control is moved. - event to display the location of the form in screen coordinates on the caption bar of the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Move/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Move/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Move/VB/form1.vb" id="Snippet1"::: - + event to display the location of the form in screen coordinates on the caption bar of the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Move/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Move/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Move/VB/form1.vb" id="Snippet1"::: + ]]> @@ -9784,20 +9819,20 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the name of the control. The name of the control. The default is an empty string (""). - property can be used at run time to evaluate the object by name rather than type and programmatic name. Because the property returns a type, it can be evaluated in case-style logic statements (`Select` statement in Visual Basic, `switch` statement in Visual C# and Visual C++). - - - -## Examples - The following code example displays the of a control in a when the control is added or removed from a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: - + property can be used at run time to evaluate the object by name rather than type and programmatic name. Because the property returns a type, it can be evaluated in case-style logic statements (`Select` statement in Visual Basic, `switch` statement in Visual C# and Visual C++). + + + +## Examples + The following code example displays the of a control in a when the control is added or removed from a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: + ]]> @@ -9862,13 +9897,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -9908,24 +9943,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -9967,24 +10002,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -10025,13 +10060,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10073,13 +10108,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10121,24 +10156,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -10180,13 +10215,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10228,28 +10263,28 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example demonstrates overriding the method in a derived class. To run the example, paste the following code after a form class, in the same file. Add a textbox of type `SingleClickTextBox` to the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlOnClick/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlOnClick/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlOnClick/VB/form1.vb" id="Snippet1"::: - - The following code example shows one of the many uses of the event and event handler. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example demonstrates overriding the method in a derived class. To run the example, paste the following code after a form class, in the same file. Add a textbox of type `SingleClickTextBox` to the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlOnClick/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlOnClick/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlOnClick/VB/form1.vb" id="Snippet1"::: + + The following code example shows one of the many uses of the event and event handler. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: + ]]> @@ -10289,13 +10324,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10333,24 +10368,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -10391,13 +10426,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10437,24 +10472,24 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses to add a control to a form and displays the name of the added control in a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses to add a control to a form and displays the name of the added control in a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: + ]]> @@ -10495,24 +10530,24 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses to remove a control from a form and displays the name of the removed control in a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses to remove a control from a form and displays the name of the removed control in a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.ControlRemoved/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.ControlRemoved/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.ControlRemoved/VB/form1.vb" id="Snippet1"::: + ]]> @@ -10550,13 +10585,13 @@ MyControl.Font = New Font(MyControl.Font, _ Raises the method. - method is called when the control is first created. - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method is called when the control is first created. + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10597,24 +10632,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -10656,24 +10691,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -10715,22 +10750,22 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event of a to load text files listed in the into a control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.DoubleClick/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.DoubleClick/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.DoubleClick/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event of a to load text files listed in the into a control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.DoubleClick/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.DoubleClick/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.DoubleClick/VB/form1.vb" id="Snippet1"::: + ]]> @@ -10843,13 +10878,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10890,13 +10925,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10937,13 +10972,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -10984,13 +11019,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11031,13 +11066,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11079,22 +11114,22 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event to change the foreground and background colors of a under particular conditions. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event to change the foreground and background colors of a under particular conditions. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: + ]]> @@ -11135,24 +11170,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -11193,24 +11228,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -11251,13 +11286,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11298,13 +11333,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11345,13 +11380,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11401,13 +11436,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11458,13 +11493,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11499,24 +11534,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -11558,13 +11593,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11605,22 +11640,22 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event to determine the type of character entered into the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event to determine the type of character entered into the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: + ]]> @@ -11661,22 +11696,22 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event to prevent characters from entering the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event to prevent characters from entering the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyDown/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyDown/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyDown/VB/form1.vb" id="Snippet1"::: + ]]> @@ -11717,22 +11752,22 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event with the class to display pop-up style help to the user. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event with the class to display pop-up style help to the user. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: + ]]> @@ -11773,13 +11808,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11820,22 +11855,22 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event to reset a control to its former state. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event to reset a control to its former state. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Enter/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Enter/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Enter/VB/form1.vb" id="Snippet1"::: + ]]> @@ -11876,24 +11911,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName* `Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName* `Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -11935,13 +11970,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -11975,13 +12010,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12020,13 +12055,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12065,13 +12100,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12110,13 +12145,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12156,13 +12191,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12204,13 +12239,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12252,22 +12287,22 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example demonstrates how to override the and methods in a derived class. To run the example, paste the following code in a new form and paste this class, forming the same file, after the form. Add a button of type `FunButton` to the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet2"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example demonstrates how to override the and methods in a derived class. To run the example, paste the following code in a new form and paste this class, forming the same file, after the form. Add a button of type `FunButton` to the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet2"::: + ]]> @@ -12309,13 +12344,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12357,22 +12392,22 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example demonstrates how to override the and methods in a derived class. To run the example, paste the following code in a new form and paste this class, forming the same file, after the form. Add a button of type `FunButton` to the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet2"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example demonstrates how to override the and methods in a derived class. To run the example, paste the following code in a new form and paste this class, forming the same file, after the form. Add a button of type `FunButton` to the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ControlDefaultProperties/VB/form1.vb" id="Snippet2"::: + ]]> @@ -12414,13 +12449,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12462,13 +12497,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12510,22 +12545,22 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example uses the event to display the location of the form in screen coordinates on the caption bar of the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Move/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Move/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Move/VB/form1.vb" id="Snippet1"::: - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example uses the event to display the location of the form in screen coordinates on the caption bar of the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Move/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Move/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Move/VB/form1.vb" id="Snippet1"::: + ]]> @@ -12566,11 +12601,11 @@ MyControl.Font = New Font(MyControl.Font, _ A that represents the Windows message. Notifies the control of Windows messages. - method is called if the control's `EnableNotifyMessage` style bit is set in . The `EnableNotifyMessage` style in enables the control to be notified when the method receives a Windows message. With this method, semi-trusted controls can listen for Windows messages without enabling them to modify the message. - + method is called if the control's `EnableNotifyMessage` style bit is set in . The `EnableNotifyMessage` style in enables the control to be notified when the method receives a Windows message. With this method, semi-trusted controls can listen for Windows messages without enabling them to modify the message. + ]]> @@ -12603,13 +12638,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -12649,26 +12684,26 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example enables the user to drag an image or image file onto the form, and have it be displayed at the point on which it is dropped. The method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Paint/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Paint/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Paint/VB/form1.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example enables the user to drag an image or image file onto the form, and have it be displayed at the point on which it is dropped. The method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Paint/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Paint/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Paint/VB/form1.vb" id="Snippet1"::: + ]]> @@ -12709,11 +12744,11 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains information about the control to paint. Paints the background of the control. - method enables derived classes to handle Windows background erase requests. - + method enables derived classes to handle Windows background erase requests. + ]]> @@ -12754,24 +12789,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -12816,24 +12851,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -12874,24 +12909,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -12932,24 +12967,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -12989,13 +13024,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13035,24 +13070,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13093,24 +13128,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13151,24 +13186,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13209,24 +13244,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13267,24 +13302,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event when the property value of the control's container changes. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13324,13 +13359,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13369,11 +13404,11 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - is set, you can override to do layered painting. See for more information. - + is set, you can override to do layered painting. See for more information. + ]]> The parameter is . @@ -13412,18 +13447,18 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - [!NOTE] -> Override this method if you want to change the point at which dragging is canceled or at which a drop occurs. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + [!NOTE] +> Override this method if you want to change the point at which dragging is canceled or at which a drop occurs. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13463,13 +13498,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13509,13 +13544,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13556,24 +13591,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13614,13 +13649,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13661,13 +13696,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13711,13 +13746,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13758,13 +13793,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13805,24 +13840,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13863,22 +13898,22 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -13919,13 +13954,13 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -13966,13 +14001,13 @@ MyControl.Font = New Font(MyControl.Font, _ A that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -14013,24 +14048,24 @@ MyControl.Font = New Font(MyControl.Font, _ An that contains the event data. Raises the event. - method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - - - -## Examples - The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: - + method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + + + +## Examples + The following code example is an event-raising method that is executed when the property value changes. The class has several methods with the name pattern `On`*PropertyName*`Changed` that raise the corresponding *PropertyName*`Changed` event when the *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a derived class displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a class that derives from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CPP/onpropertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/CS/onpropertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_OnPropertyChangedEvents/VB/onpropertychangedevents.vb" id="Snippet1"::: + ]]> @@ -14070,55 +14105,55 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets padding within the control. A representing the control's internal spacing characteristics. - and , the property gets or sets their respective properties. The property is equal to its property. - - Controls receive default values for that are reasonably close to Windows user interface guidelines. Some adjustments might still be necessary for particular applications. - - All controls that implement are enlarged by the amount in when is `true`. - - The following controls do not use : - -- Controls that do not implement through - -- Custom controls that directly inherit from - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - + and , the property gets or sets their respective properties. The property is equal to its property. + + Controls receive default values for that are reasonably close to Windows user interface guidelines. Some adjustments might still be necessary for particular applications. + + All controls that implement are enlarged by the amount in when is `true`. + + The following controls do not use : + +- Controls that do not implement through + +- Custom controls that directly inherit from + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + ]]> @@ -14144,21 +14179,21 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control's padding changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet41"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet41"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet41"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet41"::: + ]]> @@ -14185,24 +14220,24 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the control is redrawn. - event is raised when the control is redrawn. It passes an instance of to the method(s) that handles the event. - - When creating a new custom control or an inherited control with a different visual appearance, you must provide code to render the control by overriding the method. For more information, see [Overriding the OnPaint Method](/dotnet/framework/winforms/controls/overriding-the-onpaint-method) and [Custom Control Painting and Rendering](/dotnet/framework/winforms/controls/custom-control-painting-and-rendering). - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example creates a control on the form and uses the event to draw to it. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Paint/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Paint/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Paint/VB/form1.vb" id="Snippet1"::: - + event is raised when the control is redrawn. It passes an instance of to the method(s) that handles the event. + + When creating a new custom control or an inherited control with a different visual appearance, you must provide code to render the control by overriding the method. For more information, see [Overriding the OnPaint Method](/dotnet/framework/winforms/controls/overriding-the-onpaint-method) and [Custom Control Painting and Rendering](/dotnet/framework/winforms/controls/custom-control-painting-and-rendering). + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example creates a control on the form and uses the event to draw to it. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Paint/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Paint/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Paint/VB/form1.vb" id="Snippet1"::: + ]]> @@ -14245,20 +14280,20 @@ MyControl.Font = New Font(MyControl.Font, _ Gets or sets the parent container of the control. A that represents the parent or container control of the control. - property value to `null` removes the control from the of its current parent control. - - - -## Examples - The following code example uses the property and the method to set properties on the parent control of a button and its form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: - + property value to `null` removes the control from the of its current parent control. + + + +## Examples + The following code example uses the property and the method to set properties on the parent control of a button and its form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.FindForm/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.FindForm/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.FindForm/VB/form1.vb" id="Snippet1"::: + ]]> @@ -14287,13 +14322,13 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs when the property value changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + ]]> @@ -14344,24 +14379,24 @@ MyControl.Font = New Font(MyControl.Font, _ Forces the control to apply layout logic to all its child controls. - method was called before calling the method, the event is suppressed. - - The and properties of the created are set to `null` if no values were provided when the method was called. - - - -## Examples - The following code example demonstrates how to use the method. It also demonstrates ways in which the event is raised. In this example, the `Click` event handler for `Button1` explicitly calls . The `Click` event handler for `Button2` implicitly calls . is also called when the form is loaded. `Button3` returns the control to the state it was in when loaded. In each case, the event is raised. - - This is a complete example. To run the example, paste the following code in a blank form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/VB/form1.vb" id="Snippet1"::: - + method was called before calling the method, the event is suppressed. + + The and properties of the created are set to `null` if no values were provided when the method was called. + + + +## Examples + The following code example demonstrates how to use the method. It also demonstrates ways in which the event is raised. In this example, the `Click` event handler for `Button1` explicitly calls . The `Click` event handler for `Button2` implicitly calls . is also called when the form is loaded. `Button3` returns the control to the state it was in when loaded. In each case, the event is raised. + + This is a complete example. To run the example, paste the following code in a blank form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/VB/form1.vb" id="Snippet1"::: + ]]> @@ -14407,24 +14442,24 @@ MyControl.Font = New Font(MyControl.Font, _ The name of the most recently changed property on the control. Forces the control to apply layout logic to all its child controls. - method was called before calling the method, the event is suppressed. - - The `affectedControl` and `affectedProperty` parameters can both be set to `null`. Doing so causes the and properties of the created to be set to `null`. - - - -## Examples - The following code example demonstrates how to use the method. It also demonstrates ways in which the event is raised. In this example, the `Click` event handler for `Button1` explicitly calls . The `Click` event handler for `Button2` implicitly calls . is also called when the form is loaded. `Button3` returns the control to the state it was in when loaded. In each case, the event is raised. - - This is a complete example. To run the example, paste the following code in a blank form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/VB/form1.vb" id="Snippet1"::: - + method was called before calling the method, the event is suppressed. + + The `affectedControl` and `affectedProperty` parameters can both be set to `null`. Doing so causes the and properties of the created to be set to `null`. + + + +## Examples + The following code example demonstrates how to use the method. It also demonstrates ways in which the event is raised. In this example, the `Click` event handler for `Button1` explicitly calls . The `Click` event handler for `Button2` implicitly calls . is also called when the form is loaded. `Button3` returns the control to the state it was in when loaded. In each case, the event is raised. + + This is a complete example. To run the example, paste the following code in a blank form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.PerformLayout/VB/form1.vb" id="Snippet1"::: + ]]> @@ -14469,15 +14504,15 @@ MyControl.Font = New Font(MyControl.Font, _ Computes the location of the specified screen point into client coordinates. A that represents the converted , , in client coordinates. - method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: - + method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The event-handling method displays the image on the form, if an can be created from the data. Because the and values are screen coordinates, the example uses the method to convert them to client coordinates. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CPP/imagedrag.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/CS/imagedrag.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control.DragOperations/VB/imagedrag.vb" id="Snippet1"::: + ]]> @@ -14511,15 +14546,15 @@ MyControl.Font = New Font(MyControl.Font, _ Computes the location of the specified client point into screen coordinates. A that represents the converted , , in screen coordinates. - , , , , , and members. To run the example, paste the following code in a form called Form1 containing several controls. This example requires that the , , and events are connected to the event handlers defined in the example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/VB/form1.vb" id="Snippet2"::: - + , , , , , and members. To run the example, paste the following code in a form called Form1 containing several controls. This example requires that the , , and events are connected to the event handlers defined in the example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/VB/form1.vb" id="Snippet2"::: + ]]> @@ -14622,13 +14657,13 @@ MyControl.Font = New Font(MyControl.Font, _ if the message was processed by the control; otherwise, . - is called by the application's message loop to preprocess input messages before they are dispatched. Possible values for the `msg` parameter are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. - - When overriding , a control should return `true` to indicate that it has processed the message. For messages that are not processed by the control, the result of `base.PreProcessMessage` should be returned. Controls will typically override one of the more specialized methods such as , , , , or instead of overriding . - + is called by the application's message loop to preprocess input messages before they are dispatched. Possible values for the `msg` parameter are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. + + When overriding , a control should return `true` to indicate that it has processed the message. For messages that are not processed by the control, the result of `base.PreProcessMessage` should be returned. Controls will typically override one of the more specialized methods such as , , , , or instead of overriding . + ]]> @@ -14654,21 +14689,21 @@ MyControl.Font = New Font(MyControl.Font, _ Occurs before the event when a key is pressed while focus is on this control. - control ignores the arrow keys. Pressing the arrow keys typically causes the focus to move to the previous or next control. The arrow keys are considered navigation keys and pressing these keys typically do not raise the event for a . However, pressing the arrow keys for a does raise the event. By handling the event for a and setting the property to `true`, you can raise the event when the arrow keys are pressed. However, if you handle the arrow keys, the focus will no longer move to the previous or next control. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates a that includes a . When the has the focus and you press the UP ARROW or DOWN ARROW keys, the appears. The event handler detects when the UP ARROW or DOWN ARROW keys are pressed and sets the property to `true`. This raises the event so that you can display the . You should not put any logic in the event handler, other than to set the property. Instead, you should put your logic in the event handler. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.previewkeydown/cs/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.previewkeydown/vb/form1.vb" id="Snippet1"::: - + control ignores the arrow keys. Pressing the arrow keys typically causes the focus to move to the previous or next control. The arrow keys are considered navigation keys and pressing these keys typically do not raise the event for a . However, pressing the arrow keys for a does raise the event. By handling the event for a and setting the property to `true`, you can raise the event when the arrow keys are pressed. However, if you handle the arrow keys, the focus will no longer move to the previous or next control. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates a that includes a . When the has the focus and you press the UP ARROW or DOWN ARROW keys, the appears. The event handler detects when the UP ARROW or DOWN ARROW keys are pressed and sets the property to `true`. This raises the event so that you can display the . You should not put any logic in the event handler, other than to set the property. Instead, you should put your logic in the event handler. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.previewkeydown/cs/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.previewkeydown/vb/form1.vb" id="Snippet1"::: + ]]> @@ -14703,13 +14738,13 @@ MyControl.Font = New Font(MyControl.Font, _ if the character was processed by the control; otherwise, . - method first determines whether the control has a , and if so, enables the to process the command key. If the command key is not a menu shortcut and the control has a parent, the key is passed to the parent's method. The net effect is that command keys are "bubbled" up the control hierarchy. In addition to the key the user pressed, the key data also indicates which, if any, modifier keys were pressed at the same time as the key. Modifier keys include the SHIFT, CTRL, and ALT keys. - + method first determines whether the control has a , and if so, enables the to process the command key. If the command key is not a menu shortcut and the control has a parent, the key is passed to the parent's method. The net effect is that command keys are "bubbled" up the control hierarchy. In addition to the key the user pressed, the key data also indicates which, if any, modifier keys were pressed at the same time as the key. Modifier keys include the SHIFT, CTRL, and ALT keys. + ]]> @@ -14745,11 +14780,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the character was processed by the control; otherwise, . - method indicates that the control is not processing the character. The method simply sends the character to the parent's method, or returns `false` if the control has no parent. The class overrides this method to perform actual processing of dialog characters. This method is only called when the control is hosted in a Windows Forms application or as an ActiveX control. - + method indicates that the control is not processing the character. The method simply sends the character to the parent's method, or returns `false` if the control has no parent. The class overrides this method to perform actual processing of dialog characters. This method is only called when the control is hosted in a Windows Forms application or as an ActiveX control. + ]]> @@ -14785,11 +14820,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the key was processed by the control; otherwise, . - method indicates that the control is not processing the key. The simply sends the character to the parent's method, or returns `false` if the control has no parent. The class overrides this method to perform actual processing of dialog keys. This method is only called when the control is hosted in a Windows Forms application or as an ActiveX control. - + method indicates that the control is not processing the key. The simply sends the character to the parent's method, or returns `false` if the control has no parent. The class overrides this method to perform actual processing of dialog keys. This method is only called when the control is hosted in a Windows Forms application or as an ActiveX control. + ]]> @@ -14825,11 +14860,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the message was processed by the control; otherwise, . - , , or methods. The `m` parameter contains the window message that must be processed. Possible values for the property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, WM_SYSKEYUP, and WM_IME_CHAR. - + , , or methods. The `m` parameter contains the window message that must be processed. Possible values for the property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, WM_SYSKEYUP, and WM_IME_CHAR. + ]]> @@ -14865,11 +14900,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the message was processed by the control; otherwise, . - method. If the parent's method does not process the message then the method is called to generate the appropriate keyboard events. The `m` parameter contains the window message that must be processed. Possible values for the property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP. - + method. If the parent's method does not process the message then the method is called to generate the appropriate keyboard events. The `m` parameter contains the window message that must be processed. Possible values for the property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP. + ]]> @@ -14908,11 +14943,11 @@ MyControl.Font = New Font(MyControl.Font, _ if the message was processed by the control; otherwise, . - property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP. The method simply sends the character to the parent's method, or returns `false` if the control has no parent. The class overrides this method to perform actual processing of dialog keys. - + property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP. The method simply sends the character to the parent's method, or returns `false` if the control has no parent. The class overrides this method to perform actual processing of dialog keys. + ]]> @@ -14955,30 +14990,30 @@ MyControl.Font = New Font(MyControl.Font, _ if the character was processed as a mnemonic by the control; otherwise, . - method to determine whether the given character matches a mnemonic in the control's text. - - For example: - -```csharp -if (CanSelect && IsMnemonic(charCode, MyControl.Text) { - // Perform action associated with mnemonic. - } -``` - - This default implementation of the method simply returns `false` to indicate that the control has no mnemonic. - - - -## Examples - The following code example demonstrates an extension of the button class that overrides the method to exhibit custom behavior. The example also demonstrates the use of the and properties. To run this example paste the following code after a form class, in the same file. Add a button of type `MnemonicButton` to the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/VB/form1.vb" id="Snippet1"::: - + method to determine whether the given character matches a mnemonic in the control's text. + + For example: + +```csharp +if (CanSelect && IsMnemonic(charCode, MyControl.Text) { + // Perform action associated with mnemonic. + } +``` + + This default implementation of the method simply returns `false` to indicate that the control has no mnemonic. + + + +## Examples + The following code example demonstrates an extension of the button class that overrides the method to exhibit custom behavior. The example also demonstrates the use of the and properties. To run this example paste the following code after a form class, in the same file. Add a button of type `MnemonicButton` to the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/VB/form1.vb" id="Snippet1"::: + ]]> @@ -15022,27 +15057,27 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Gets the product name of the assembly containing the control. The product name of the assembly containing the control. - property is a read-only property. To change the value of this property, set the property value of the . The following line of C# code sets the property. - -``` -[assembly: AssemblyProduct("MyApplication")] -``` - -> [!NOTE] -> It is strongly recommended that you provide the company name, product name, and product version. Providing this information enables the use of Windows Forms features such as that make it easier to write applications that comply with the "Certified for Windows" program. - - - -## Examples - The following code example displays information about the application in a contained by a . This example requires that the , and have been set. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CPP/aboutdialog.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CS/aboutdialog.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties3/VB/aboutdialog.vb" id="Snippet1"::: - + property is a read-only property. To change the value of this property, set the property value of the . The following line of C# code sets the property. + +``` +[assembly: AssemblyProduct("MyApplication")] +``` + +> [!NOTE] +> It is strongly recommended that you provide the company name, product name, and product version. Providing this information enables the use of Windows Forms features such as that make it easier to write applications that comply with the "Certified for Windows" program. + + + +## Examples + The following code example displays information about the application in a contained by a . This example requires that the , and have been set. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CPP/aboutdialog.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CS/aboutdialog.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties3/VB/aboutdialog.vb" id="Snippet1"::: + ]]> @@ -15085,27 +15120,27 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Gets the version of the assembly containing the control. The file version of the assembly containing the control. - property is a read-only property. To change the value of this property, set the property value of the . The following line of C# code sets the property. - -``` -[assembly: AssemblyVersion("1.0.1")] -``` - -> [!NOTE] -> It is strongly recommended that you provide the company name, product name, and product version. Providing this information enables the use of Windows Forms features such as that make it easier to write applications that comply with the "Certified for Windows" program. - - - -## Examples - The following code example displays information about the application in a contained by a . This example requires that the , and have been set. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CPP/aboutdialog.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CS/aboutdialog.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties3/VB/aboutdialog.vb" id="Snippet1"::: - + property is a read-only property. To change the value of this property, set the property value of the . The following line of C# code sets the property. + +``` +[assembly: AssemblyVersion("1.0.1")] +``` + +> [!NOTE] +> It is strongly recommended that you provide the company name, product name, and product version. Providing this information enables the use of Windows Forms features such as that make it easier to write applications that comply with the "Certified for Windows" program. + + + +## Examples + The following code example displays information about the application in a contained by a . This example requires that the , and have been set. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CPP/aboutdialog.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties3/CS/aboutdialog.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties3/VB/aboutdialog.vb" id="Snippet1"::: + ]]> @@ -15157,22 +15192,22 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Occurs when is providing help to accessibility applications. - class to enable users to invoke help on your accessible object by pressing the F1 key. Using the provides you with complete information in the . For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the creation of an accessibility-aware chart control, using the and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Since the chart legend is not an actual -based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. - - This code excerpt demonstrates handling the event. See the class overview for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CS/chartcontrol.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet3"::: - + class to enable users to invoke help on your accessible object by pressing the F1 key. Using the provides you with complete information in the . For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the creation of an accessibility-aware chart control, using the and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Since the chart legend is not an actual -based control, but instead is drawn by the chart control, it does not any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. + + This code excerpt demonstrates handling the event. See the class overview for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CS/chartcontrol.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet3"::: + ]]> @@ -15200,49 +15235,49 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. - event is raised when there is a change in the keyboard or mouse button state during a drag-and-drop operation. The event enables the drag source to determine whether the drag-and-drop operation should be canceled. - - The following describes how and when events related to drag-and-drop operations are raised. - - The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. - - If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - - Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. - -- If the user moves out of a window, the event is raised. - -- If the mouse enters another control, the for that control is raised. - -- If the mouse moves but stays within the same control, the event is raised. - - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . - -- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. - - > [!NOTE] - > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. - -- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - -- If the value of is `Cancel`, the event is raised. - - By default, the event sets to `Cancel` in if the ESC key was pressed and sets to `Drop` in if the left, middle, or right mouse button is pressed. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - This code excerpt demonstrates using the event to cancel the drag-and-drop operation if the drag operation moves outside the bounds of the form. See the method for the complete code example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet6"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet6"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet6"::: - + event is raised when there is a change in the keyboard or mouse button state during a drag-and-drop operation. The event enables the drag source to determine whether the drag-and-drop operation should be canceled. + + The following describes how and when events related to drag-and-drop operations are raised. + + The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. + + If the control is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + + Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. + +- If the user moves out of a window, the event is raised. + +- If the mouse enters another control, the for that control is raised. + +- If the mouse moves but stays within the same control, the event is raised. + + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the property of the event's . + +- If the value of is `Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + + > [!NOTE] + > The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse's position. + +- If the value of is `Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. + +- If the value of is `Cancel`, the event is raised. + + By default, the event sets to `Cancel` in if the ESC key was pressed and sets to `Drop` in if the left, middle, or right mouse button is pressed. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + This code excerpt demonstrates using the event to cancel the drag-and-drop operation if the drag operation moves outside the bounds of the form. See the method for the complete code example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CPP/form1.cpp" id="Snippet6"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/CS/form1.cs" id="Snippet6"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.DoDragDrop/VB/form1.vb" id="Snippet6"::: + ]]> @@ -15437,11 +15472,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Forces the re-creation of the handle for the control. - method is called whenever parameters are needed for a new control, but using a call from to is insufficient. This method also calls and and sets to `true`. - + method is called whenever parameters are needed for a new control, but using a call from to is insufficient. This method also calls and and sets to `true`. + ]]> @@ -15493,11 +15528,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { if the control is currently re-creating its handle; otherwise, . - property returns `true` if the method is still running on the control. - + property returns `true` if the method is still running on the control. + ]]> @@ -15569,15 +15604,15 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Computes the size and location of the specified client rectangle in screen coordinates. A that represents the converted , , in screen coordinates. - , , , , , and members. To run the example, paste the following code in a form called **Form1** containing several controls. This example requires that the , , and events are connected to the event handlers defined in the example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/VB/form1.vb" id="Snippet2"::: - + , , , , , and members. To run the example, paste the following code in a form called **Form1** containing several controls. This example requires that the , , and events are connected to the event handlers defined in the example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.RectangleToScreen/VB/form1.vb" id="Snippet2"::: + ]]> @@ -15620,15 +15655,15 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { if the message was reflected; otherwise, . - method is an infrastructure method and typically should not be called from your code. - - If the `hWnd` parameter does not represent a valid control, the method returns `false`. - - Because Windows messages are returned to the top-level window, the method is used to propagate the return message to the control that sent the message. - + method is an infrastructure method and typically should not be called from your code. + + If the `hWnd` parameter does not represent a valid control, the method returns `false`. + + Because Windows messages are returned to the top-level window, the method is used to propagate the return message to the control that sent the message. + ]]> @@ -15702,23 +15737,23 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Gets or sets the window region associated with the control. The window associated with the control. - [!NOTE] -> The collection of pixels contained with the region can be noncontiguous. - - - -## Examples - The following code example demonstrates how to use the property by creating a round button. To run the example, paste the following code in a form containing a button called `roundButton`. This example requires that the event is connected to the event handler defined in the example. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.Region/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.Region/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.Region/VB/form1.vb" id="Snippet1"::: - + [!NOTE] +> The collection of pixels contained with the region can be noncontiguous. + + + +## Examples + The following code example demonstrates how to use the property by creating a round button. To run the example, paste the following code in a form containing a button called `roundButton`. This example requires that the event is connected to the event handler defined in the example. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.Region/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.Region/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.Region/VB/form1.vb" id="Snippet1"::: + ]]> @@ -15746,21 +15781,21 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Occurs when the value of the property changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet22"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet22"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet22"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet22"::: + ]]> @@ -15871,11 +15906,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value. - @@ -15909,11 +15944,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Causes a control bound to the to reread all the items in the list and refresh their displayed values. - @@ -15952,11 +15987,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value. - @@ -15994,11 +16029,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value. - @@ -16032,11 +16067,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value. - @@ -16070,11 +16105,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value. - @@ -16143,11 +16178,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value. - @@ -16175,11 +16210,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resets the property to its default value (). - or creating your own control incorporating the . - + or creating your own control incorporating the . + ]]> @@ -16213,24 +16248,24 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Occurs when the control is resized. - of the resized control, you can cast the `sender` parameter of the registered method to a and get its property (or and properties individually). - - To handle custom layouts, use the event instead of the Resize event. The event is raised in response to a event, but also in response to other changes that affect the layout of the control. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example handles the event of a . When the form is resized, the event handler ensures that the form stays square (its and remain equal). To run this example, make sure and associate this event-handling method with the form's event. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/WinForms.Control.Resize/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/WinForms.Control.Resize/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/WinForms.Control.Resize/VB/form1.vb" id="Snippet1"::: - + of the resized control, you can cast the `sender` parameter of the registered method to a and get its property (or and properties individually). + + To handle custom layouts, use the event instead of the Resize event. The event is raised in response to a event, but also in response to other changes that affect the layout of the control. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example handles the event of a . When the form is resized, the event handler ensures that the form stays square (its and remain equal). To run this example, make sure and associate this event-handling method with the form's event. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/WinForms.Control.Resize/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/WinForms.Control.Resize/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/WinForms.Control.Resize/VB/form1.vb" id="Snippet1"::: + ]]> @@ -16272,11 +16307,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { if the control redraws itself when resized; otherwise, . - property value is equivalent to the return value of the method when passing in the value as a parameter. - + property value is equivalent to the return value of the method when passing in the value as a parameter. + ]]> @@ -16326,24 +16361,24 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Resumes usual layout logic. - method forces an immediate layout if there are any pending layout requests. - - The and methods are used in tandem to suppress multiple events while you adjust multiple attributes of the control. For example, you would typically call the method, then set the , , , or properties of the control, and then call the method to enable the changes to take effect. - - There must be no pending calls to for to be successfully called. - - - -## Examples - The following code example adds two buttons to a form. The example transactions the addition of the buttons by using the and methods. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet2"::: - + method forces an immediate layout if there are any pending layout requests. + + The and methods are used in tandem to suppress multiple events while you adjust multiple attributes of the control. For example, you would typically call the method, then set the , , , or properties of the control, and then call the method to enable the changes to take effect. + + There must be no pending calls to for to be successfully called. + + + +## Examples + The following code example adds two buttons to a form. The example transactions the addition of the buttons by using the and methods. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet2"::: + ]]> @@ -16380,18 +16415,18 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { to execute pending layout requests; otherwise, . Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. - method forces an immediate layout if there are any pending layout requests. When the `performLayout` parameter is set to `true`, an immediate layout occurs if there are any pending layout requests. - - The and methods are used in tandem to suppress multiple events while you adjust multiple attributes of the control. For example, you would typically call the method, then set the , , , or properties of the control, and then call the method to enable the changes to take effect. - - There must be no pending calls to for to be successfully called. - -> [!NOTE] -> When adding several controls to a parent control, it is recommended that you call the method before initializing the controls to be added. After adding the controls to the parent control, call the method. This will increase the performance of applications with many controls. - + method forces an immediate layout if there are any pending layout requests. When the `performLayout` parameter is set to `true`, an immediate layout occurs if there are any pending layout requests. + + The and methods are used in tandem to suppress multiple events while you adjust multiple attributes of the control. For example, you would typically call the method, then set the , , , or properties of the control, and then call the method to enable the changes to take effect. + + There must be no pending calls to for to be successfully called. + +> [!NOTE] +> When adding several controls to a parent control, it is recommended that you call the method before initializing the controls to be added. After adding the controls to the parent control, call the method. This will increase the performance of applications with many controls. + ]]> @@ -16438,26 +16473,26 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. An representing the distance, in pixels, between the right edge of the control and the left edge of its container's client area. - property is equal to the sum of the property value and the property value. - - The property is read-only. You can change this property value indirectly by changing the value of the or properties or calling the , , , or methods. - - - -## Examples - The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: - + property is equal to the sum of the property value and the property value. + + The property is read-only. You can change this property value indirectly by changing the value of the or properties or calling the , , , or methods. + + + +## Examples + The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.KeyUp/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.KeyUp/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.KeyUp/VB/form1.vb" id="Snippet1"::: + ]]> @@ -16496,34 +16531,34 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. One of the values. The default is . - property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. - - The property is used for international applications where the language is written from right to left, such as Hebrew or Arabic. When this property is set to , control elements that include text are displayed from right to left. - -> [!NOTE] -> If the value of the property is changed at run time, only raw text without formatting is preserved. - - The following are a few examples of how control elements are affected by the property value of : - -- Vertical scroll bars are displayed on the left side rather than right side of scrollable controls (for example, , , multiline , and ). - -- Horizontal scroll bars start with the scroll box (thumb) right-aligned. - -- The check box element alignment, controlled by the `CheckAlign` property, is reversed for and controls. - -- Items in list box, combo box, and up-down controls are right aligned. - -- Up and down buttons are left-aligned on and controls. - -- Menus (, , and ) are displayed right-aligned. - -- The alignment of toolbar buttons on a control or the alignment of text on a is not affected by the property. - -- supports right-to-left alignment; however, the effect on an ActiveX control depends on the extent to which the control author implemented support for right-to-left display. - + property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a will have the same as its parent by default. For more information about ambient properties, see the class or the class overview. + + The property is used for international applications where the language is written from right to left, such as Hebrew or Arabic. When this property is set to , control elements that include text are displayed from right to left. + +> [!NOTE] +> If the value of the property is changed at run time, only raw text without formatting is preserved. + + The following are a few examples of how control elements are affected by the property value of : + +- Vertical scroll bars are displayed on the left side rather than right side of scrollable controls (for example, , , multiline , and ). + +- Horizontal scroll bars start with the scroll box (thumb) right-aligned. + +- The check box element alignment, controlled by the `CheckAlign` property, is reversed for and controls. + +- Items in list box, combo box, and up-down controls are right aligned. + +- Up and down buttons are left-aligned on and controls. + +- Menus (, , and ) are displayed right-aligned. + +- The alignment of toolbar buttons on a control or the alignment of text on a is not affected by the property. + +- supports right-to-left alignment; however, the effect on an ActiveX control depends on the extent to which the control author implemented support for right-to-left display. + ]]> The assigned value is not one of the values. @@ -16560,24 +16595,24 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Occurs when the property value changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). - - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example is an event handler that is executed when the property value changes. The class has several methods with the name pattern *PropertyName*`Changed` that are raised when the corresponding *PropertyName* value changes (*PropertyName* represents the name of the corresponding property). + + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -16630,11 +16665,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Converts the specified to the appropriate to support right-to-left text. One of the values. - property of is set to `No`, the return value is equal to the `align` parameter passed in. - + property of is set to `No`, the return value is equal to the `align` parameter passed in. + ]]> @@ -16681,11 +16716,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Converts the specified to the appropriate to support right-to-left text. One of the values. - property of is set to `No`, the return value is equal to the `align` parameter passed in. - + property of is set to `No`, the return value is equal to the `align` parameter passed in. + ]]> @@ -16732,11 +16767,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Converts the specified to the appropriate to support right-to-left text. One of the values. - property of is set to `No`, the return value is equal to the `align` parameter passed in. - + property of is set to `No`, the return value is equal to the `align` parameter passed in. + ]]> @@ -16783,11 +16818,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Converts the specified to the appropriate to support right-to-left text. One of the values. - property of is set to `No`, the return value is equal to the `align` parameter passed in. - + property of is set to `No`, the return value is equal to the `align` parameter passed in. + ]]> @@ -16830,11 +16865,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Converts the specified to the appropriate to support right-to-left text. One of the values. - property of is set to `No`, the return value is equal to the `align` parameter passed in. - + property of is set to `No`, the return value is equal to the `align` parameter passed in. + ]]> @@ -16877,11 +16912,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Converts the specified to the appropriate to support right-to-left text. One of the values. - property of is set to `No`, the return value is equal to the `align` parameter passed in. - + property of is set to `No`, the return value is equal to the `align` parameter passed in. + ]]> @@ -16931,11 +16966,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { A containing the horizontal and vertical scaling factors. Scales the control and all child controls by the specified scaling factor. - method scales the control by the specified scaling `factor`. It also recursively scales all child controls if the property is `true`. Internally, this method calls to scale each control. - + method scales the control by the specified scaling `factor`. It also recursively scales all child controls if the property is `true`. Internally, this method calls to scale each control. + ]]> @@ -17088,13 +17123,13 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { if child controls will be scaled when the method on this control is called; otherwise, . The default is . - property is `true`, then the method will recursively call the method of each of its child controls. - - The default implementation of always returns `true`. Derived classes can override to return `false` to indicate that scaling should not be performed on their children. - + property is `true`, then the method will recursively call the method of each of its child controls. + + The default implementation of always returns `true`. Derived classes can override to return `false` to indicate that scaling should not be performed on their children. + ]]> @@ -17135,22 +17170,22 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { A value that specifies the bounds of the control to use when defining its size and position. Scales a control's location, size, padding and margin. - - - - - - - - + + + + + + + + ]]> @@ -17193,11 +17228,11 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { The vertical scaling factor. This method is not relevant for this class. - @@ -17210,22 +17245,22 @@ if (CanSelect && IsMnemonic(charCode, MyControl.Text) { Activates a control. - method activates the control if the control's style bit is set to `true`, it is contained in another control, and all its parent controls are both visible and enabled. - -The Windows Forms controls in the following list are not selectable. Controls derived from controls in the list will also not be selectable. - -- -- -- -- -- -- -- (when there is no link present in the control) - + method activates the control if the control's style bit is set to `true`, it is contained in another control, and all its parent controls are both visible and enabled. + +The Windows Forms controls in the following list are not selectable. Controls derived from controls in the list will also not be selectable. + +- +- +- +- +- +- +- (when there is no link present in the control) + ]]> @@ -17259,16 +17294,16 @@ The Windows Forms controls in the following list are not selectable. Controls de Activates the control. - , if it is selectable. - -:::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet2"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet2"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet2"::: - + , if it is selectable. + +:::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet2"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet2"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet2"::: + ]]> @@ -17305,11 +17340,11 @@ The following code example selects the specified to move forward in the tab order; to move backward in the tab order. Activates a child control. Optionally specifies the direction in the tab order to select the control from. - @@ -17356,56 +17391,56 @@ The following code example selects the specified if a control was activated; otherwise, . - method activates the next control in the tab order if the control's `Selectable` style bit is set to `true` in , it is contained in another control, and all its parent controls are both visible and enabled. - - The Windows Forms controls in the following list are not selectable. Controls derived from controls in the list will also not be selectable. - -- - -- - -- - -- - -- - -- - -- (when there is no link present in the control) - - When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), by calling the or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - - - -## Examples - The following code exampleshows the method being used in a form that has some controls. Each time that you click the form, the next control is activated. The property gets the currently active control in the container control. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/cs/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/vb/form1.vb" id="Snippet1"::: - - The following code example shows the method being used in a form that has a and some other controls. When you click the , the next control after the is activated. Notice that you have to get the parent of the control. Since is not a container, calling directly on the would not change the activation. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/cs/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/vb/form1.vb" id="Snippet2"::: - + method activates the next control in the tab order if the control's `Selectable` style bit is set to `true` in , it is contained in another control, and all its parent controls are both visible and enabled. + + The Windows Forms controls in the following list are not selectable. Controls derived from controls in the list will also not be selectable. + +- + +- + +- + +- + +- + +- + +- (when there is no link present in the control) + + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), by calling the or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + + + +## Examples + The following code exampleshows the method being used in a form that has some controls. Each time that you click the form, the next control is activated. The property gets the currently active control in the container control. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/cs/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/vb/form1.vb" id="Snippet1"::: + + The following code example shows the method being used in a form that has a and some other controls. When you click the , the next control after the is activated. Notice that you have to get the parent of the control. Since is not a container, calling directly on the would not change the activation. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/cs/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/system.windows.forms.control.selectnextcontrol/vb/form1.vb" id="Snippet2"::: + ]]> @@ -17435,11 +17470,11 @@ The following code example selects the specified Sends the control to the back of the z-order. - , that is not a child of another control. An active control is a visible control that has input focus. To use the method with an inactive, top-level control, first call the method on the control. - + , that is not a child of another control. An active control is a visible control that has input focus. To use the method with an inactive, top-level control, first call the method on the control. + ]]> @@ -17553,15 +17588,15 @@ The following code example selects the specified A bitwise combination of the values. For any parameter not specified, the current value will be used. Sets the specified bounds of the control to the specified location and size. - on the screen in the event. This will keep the form centered as the user resizes it. This example requires that you have created a control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Layout/CPP/layout.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Layout/CS/layout.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Layout/VB/layout.vb" id="Snippet1"::: - + on the screen in the event. This will keep the form centered as the user resizes it. This example requires that you have created a control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Layout/CPP/layout.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Layout/CS/layout.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Layout/VB/layout.vb" id="Snippet1"::: + ]]> @@ -17609,25 +17644,25 @@ The following code example selects the specified A bitwise combination of the values. Performs the work of setting the specified bounds of this control. - , , or the or properties of the property can be passed in with a reference to the current instance of the control. However all values passed in are honored and applied to the control. - - The `boundsSpecified` parameter represents the elements of the controls changed by your application. For example, if you change the of the control, the `boundsSpecified` parameter value is the `Size` value of . However, if the is adjusted in response to the property being set, the `boundsSpecified` parameter value is the `None` value of . - -> [!NOTE] -> On Windows Server 2003 systems, the size of a is restricted by the maximum pixel width and height of the monitor. - - - -## Examples - The following code example overrides the method to ensure that the control remains a fixed size. This example requires that you have a class that is either directly or indirectly derived from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CPP/controlmethods.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CS/controlmethods.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_Methods/VB/controlmethods.vb" id="Snippet1"::: - + , , or the or properties of the property can be passed in with a reference to the current instance of the control. However all values passed in are honored and applied to the control. + + The `boundsSpecified` parameter represents the elements of the controls changed by your application. For example, if you change the of the control, the `boundsSpecified` parameter value is the `Size` value of . However, if the is adjusted in response to the property being set, the `boundsSpecified` parameter value is the `None` value of . + +> [!NOTE] +> On Windows Server 2003 systems, the size of a is restricted by the maximum pixel width and height of the monitor. + + + +## Examples + The following code example overrides the method to ensure that the control remains a fixed size. This example requires that you have a class that is either directly or indirectly derived from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CPP/controlmethods.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CS/controlmethods.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_Methods/VB/controlmethods.vb" id="Snippet1"::: + ]]> @@ -17672,27 +17707,27 @@ The following code example selects the specified The client area height, in pixels. Sets the size of the client area of the control. - of the control. - - - -## Examples - The following code example overrides the method to ensure that the control remains square. This example requires that you have a class that is either directly or indirectly derived from the class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CPP/controlmethods.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CS/controlmethods.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_Methods/VB/controlmethods.vb" id="Snippet2"::: - + of the control. + + + +## Examples + The following code example overrides the method to ensure that the control remains square. This example requires that you have a class that is either directly or indirectly derived from the class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CPP/controlmethods.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_Methods/CS/controlmethods.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_Methods/VB/controlmethods.vb" id="Snippet2"::: + ]]> - When overriding in a derived class, be sure to call the base class's method so that the property is adjusted. - + When overriding in a derived class, be sure to call the base class's method so that the property is adjusted. + For more information about drawing on controls, see [Rendering a Windows Forms Control](/dotnet/framework/winforms/controls/rendering-a-windows-forms-control). @@ -17733,23 +17768,23 @@ The following code example selects the specified to apply the specified style to the control; otherwise, . Sets a specified flag to either or . - method and passing in the appropriate bit (or bits) and the Boolean value to set the bit(s) to. To determine the value assigned to a specified bit, use the method and pass in the member to evaluate. - -> [!CAUTION] -> Setting the control style bits can substantially change the behavior of the control. Review the enumeration documentation to understand the effects of changing the control style bits before calling the method. - - - -## Examples - The following code example enables double-buffering on a and updates the styles to reflect the changes. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet3"::: - + method and passing in the appropriate bit (or bits) and the Boolean value to set the bit(s) to. To determine the value assigned to a specified bit, use the method and pass in the member to evaluate. + +> [!CAUTION] +> Setting the control style bits can substantially change the behavior of the control. Review the enumeration documentation to understand the effects of changing the control style bits before calling the method. + + + +## Examples + The following code example enables double-buffering on a and updates the styles to reflect the changes. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet3"::: + ]]> @@ -17783,11 +17818,11 @@ The following code example selects the specified to set the control as the top-level control; otherwise, . Sets the control as the top-level control. - method of a and pass in a value of `false`, the form will not be visible until you call again, passing in a value of `true`. - + method of a and pass in a value of `false`, the form will not be visible until you call again, passing in a value of `true`. + ]]> The parameter is set to and the control is an ActiveX control. @@ -17822,11 +17857,11 @@ The following code example selects the specified to make the control visible; otherwise, . Sets the control to the specified visible state. - @@ -17864,20 +17899,20 @@ The following code example selects the specified Displays the control to the user. - property to `true`. After the method is called, the property returns a value of `true` until the method is called. - - - -## Examples - The following code example displays an about dialog box and temporarily draws a blue square on its surface. This example requires that you have defined a class that derives from named `AboutDialog`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet1"::: - + property to `true`. After the method is called, the property returns a value of `true` until the method is called. + + + +## Examples + The following code example displays an about dialog box and temporarily draws a blue square on its surface. This example requires that you have defined a class that derives from named `AboutDialog`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet1"::: + ]]> @@ -17925,11 +17960,11 @@ The following code example selects the specified if the control should display focus rectangles; otherwise, . - @@ -17981,13 +18016,13 @@ The following code example selects the specified if the keyboard accelerators are visible; otherwise, . - @@ -18060,26 +18095,26 @@ The following code example selects the specified Gets or sets the height and width of the control. The that represents the height and width of the control in pixels. - class is a value type (`Structure` in Visual Basic, `struct` in Visual C#), it is returned by value, meaning accessing the property returns a copy of the size of the control. So, adjusting the or properties of the returned from this property will not affect the or of the control. To adjust the or of the control, you must set the control's or property, or set the property with a new . - -> [!NOTE] -> To maintain better performance, do not set the of a control in its constructor. The preferred method is to override the property. - -> [!NOTE] -> On Windows Server 2003 systems, the size of a is restricted by the maximum pixel width and height of the monitor. - - - -## Examples - The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: - + class is a value type (`Structure` in Visual Basic, `struct` in Visual C#), it is returned by value, meaning accessing the property returns a copy of the size of the control. So, adjusting the or properties of the returned from this property will not affect the or of the control. To adjust the or of the control, you must set the control's or property, or set the property with a new . + +> [!NOTE] +> To maintain better performance, do not set the of a control in its constructor. The preferred method is to override the property. + +> [!NOTE] +> On Windows Server 2003 systems, the size of a is restricted by the maximum pixel width and height of the monitor. + + + +## Examples + The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: + ]]> @@ -18107,24 +18142,24 @@ The following code example selects the specified Occurs when the property value changes. - event to handle custom layouts. The event is raised in response to events, but also in other conditions when layout might need to be applied. - - This event is raised if the property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the event. An instance of a control has been provided that can be scaled both horizontally and vertically. A instance provides the horizontal and vertical scale value. The instance named **OK** is used to set the scale values for the control instance. Whenever the size of the control changes, the event handler associated with the event of the control is called. This event handler displays a message box indicating that the size of the control has changed. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Scale1/CPP/control_scale1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Scale1/CS/control_scale1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Scale1/VB/control_scale1.vb" id="Snippet2"::: - + event to handle custom layouts. The event is raised in response to events, but also in other conditions when layout might need to be applied. + + This event is raised if the property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the event. An instance of a control has been provided that can be scaled both horizontally and vertically. A instance provides the horizontal and vertical scale value. The instance named **OK** is used to set the scale values for the control instance. Whenever the size of the control changes, the event handler associated with the event of the control is called. This event handler displays a message box indicating that the size of the control has changed. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_Scale1/CPP/control_scale1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_Scale1/CS/control_scale1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_Scale1/VB/control_scale1.vb" id="Snippet2"::: + ]]> @@ -18188,25 +18223,25 @@ The following code example selects the specified Occurs when the control style changes. - event occurs when flags have been added or changed. - - This event is raised if the control style is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet68"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet68"::: - + event occurs when flags have been added or changed. + + This event is raised if the control style is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet68"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet68"::: + ]]> @@ -18237,27 +18272,27 @@ The following code example selects the specified Temporarily suspends the layout logic for the control. - method is called. - - The and methods are used in tandem to suppress multiple events while you adjust multiple attributes of the control. For example, you would typically call the method, then set the , , , or properties of the control, and then call the method to enable the changes to take effect. - - There must be no pending calls to for to be successfully called. - -> [!NOTE] -> When adding several controls to a parent control, it is recommended that you call the method before initializing the controls to be added. After adding the controls to the parent control, call the method. This will increase the performance of applications with many controls. - - - -## Examples - The following code example adds two buttons to a form. The example transactions the addition of the buttons by using the and methods. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet2"::: - + method is called. + + The and methods are used in tandem to suppress multiple events while you adjust multiple attributes of the control. For example, you would typically call the method, then set the , , , or properties of the control, and then call the method to enable the changes to take effect. + + There must be no pending calls to for to be successfully called. + +> [!NOTE] +> When adding several controls to a parent control, it is recommended that you call the method before initializing the controls to be added. After adding the controls to the parent control, call the method. This will increase the performance of applications with many controls. + + + +## Examples + The following code example adds two buttons to a form. The example transactions the addition of the buttons by using the and methods. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet2"::: + ]]> @@ -18434,23 +18469,23 @@ The following code example selects the specified Occurs when the system colors change. - is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet69"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet69"::: - + is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet69"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet69"::: + ]]> @@ -18490,22 +18525,22 @@ The following code example selects the specified Gets or sets the tab order of the control within its container. The index value of the control within the set of controls within its container. The controls in the container are included in the tab order. - property must be set to `true`. - - - -## Examples - The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: - + property must be set to `true`. + + + +## Examples + The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: + ]]> @@ -18534,23 +18569,23 @@ The following code example selects the specified Occurs when the property value changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet25"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet25"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet25"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet25"::: + ]]> @@ -18593,22 +18628,22 @@ The following code example selects the specified Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. - if the user can give the focus to the control using the TAB key; otherwise, . The default is . - + if the user can give the focus to the control using the TAB key; otherwise, . The default is . + Note: This property will always return for an instance of the class. - property value of `false` are not included in the collection of controls in the tab order. The tab order can be manipulated by setting the control's property value. - -## Examples - The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: - + property value of `false` are not included in the collection of controls in the tab order. The tab order can be manipulated by setting the control's property value. + +## Examples + The following code example adds a to a form and sets some of its common properties. The example anchors the button to the bottom-right corner of the form so it keeps its relative position as the form is resized. Next it sets the and resizes the button to the same size as the . The example then sets the to `true` and sets the property. Lastly, it adds an event handler to handle the event of the button. This example requires that you have an named `imageList1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet3"::: + ]]> @@ -18636,23 +18671,23 @@ Note: This property will always return for an instance o Occurs when the property value changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet26"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet26"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of a type that inherits from , such as a or . Then name the instance `Control1` and ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet26"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet26"::: + ]]> @@ -18700,22 +18735,22 @@ Note: This property will always return for an instance o Gets or sets the object that contains data about the control. An that contains data about the control. The default is . - class can be assigned to this property. If the property is set through the Windows Forms designer, only text can be assigned. - - A common use for the property is to store data that is closely associated with the control. For example, if you have a control that displays information about a customer, you might store a that contains the customer's order history in that control's property so the data can be accessed quickly. - - - -## Examples - The following code example displays a form and stores a `Customer` in its property. This example requires that you have defined a class that derives from named `CustomerForm` and that you have defined a `Customer`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet3"::: - + class can be assigned to this property. If the property is set through the Windows Forms designer, only text can be assigned. + + A common use for the property is to store data that is closely associated with the control. For example, if you have a control that displays information about a customer, you might store a that contains the customer's order history in that control's property so the data can be accessed quickly. + + + +## Examples + The following code example displays a form and stores a `Customer` in its property. This example requires that you have defined a class that derives from named `CustomerForm` and that you have defined a `Customer`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CPP/controlmembers2.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Members2/CS/controlmembers2.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Members2/VB/controlmembers2.vb" id="Snippet3"::: + ]]> @@ -18758,20 +18793,20 @@ Note: This property will always return for an instance o Gets or sets the text associated with this control. The text associated with this control. - property of the control is used differently by each derived class. For example the property of a is displayed in the title bar at the top of the form, is fairly small in character count, and usually displays the application or document name. However, the property of a can be large and can include numerous nonvisual characters used to format the text. For example, the text displayed in a can be formatted by adjusting the properties, or by the addition of spaces or tab characters to align the text. - - - -## Examples - The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: - + property of the control is used differently by each derived class. For example the property of a is displayed in the title bar at the top of the form, is fairly small in character count, and usually displays the application or document name. However, the property of a can be large and can include numerous nonvisual characters used to format the text. For example, the text displayed in a can be formatted by adjusting the properties, or by the addition of spaces or tab characters to align the text. + + + +## Examples + The following code example creates a and sets some of its common properties. The example creates a and sets its within the group box. Next, it sets the property of the group box, and docks the group box to the top of the form. Lastly, it disables the group box by setting the property to `false`, which causes all controls contained within the group box to be disabled. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CPP/controlproperties.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control Properties/CS/controlproperties.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control Properties/VB/controlproperties.vb" id="Snippet2"::: + ]]> @@ -18802,22 +18837,22 @@ Note: This property will always return for an instance o Occurs when the property value changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example changes the of a displaying currency data. The example converts the text to a decimal number and changes the to if the number is negative and to if the number is positive. This example requires that you have a that contains a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CPP/propertychangedevents.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/CS/propertychangedevents.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control_PropertyChangedEvents/VB/propertychangedevents.vb" id="Snippet1"::: + ]]> @@ -18865,22 +18900,22 @@ Note: This property will always return for an instance o Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. An representing the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. - property value is equivalent to the property of the property value of the control. - - Changes made to the and property values cause the property value of the control to change. - - - -## Examples - The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: - + property value is equivalent to the property of the property value of the control. + + Changes made to the and property values cause the property value of the control to change. + + + +## Examples + The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: + ]]> @@ -18925,11 +18960,11 @@ Note: This property will always return for an instance o Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost that the control is contained in. The that represents the top-level control that contains the current control. - that the control is contained in. For example, if the control is contained on an MDI child , then the top-level control is the Multiple Document Interface (MDI) parent . If the control is not parented on a , this property will return `null`. - + that the control is contained in. For example, if the control is contained on an MDI child , then the top-level control is the Multiple Document Interface (MDI) parent . If the control is not parented on a , this property will return `null`. + ]]> @@ -18958,21 +18993,21 @@ Note: This property will always return for an instance o Causes the control to redraw the invalidated regions within its client area. - method with the method. - -- You can call the method, which forces the control to redraw itself and all its children. This is equivalent to setting the method to `true` and using it with . - - The method governs what gets painted or repainted. The method governs when the painting or repainting occurs. If you use the and methods together rather than calling , what gets repainted depends on which overload of you use. The method just forces the control to be painted immediately, but the method governs what gets painted when you call the method. - - For more information, see the [WM_PAINT](/windows/win32/gdi/wm-paint) topic. - + method with the method. + +- You can call the method, which forces the control to redraw itself and all its children. This is equivalent to setting the method to `true` and using it with . + + The method governs what gets painted or repainted. The method governs when the painting or repainting occurs. If you use the and methods together rather than calling , what gets repainted depends on which overload of you use. The method just forces the control to be painted immediately, but the method governs what gets painted when you call the method. + + For more information, see the [WM_PAINT](/windows/win32/gdi/wm-paint) topic. + ]]> @@ -19022,11 +19057,11 @@ Note: This property will always return for an instance o Updates the bounds of the control with the current size and location. - of the control is different from the previous , the event is raised. Likewise, if the of the control changes, the event is raised. - + of the control is different from the previous , the event is raised. Likewise, if the of the control changes, the event is raised. + ]]> @@ -19071,11 +19106,11 @@ Note: This property will always return for an instance o The of the control. Updates the bounds of the control with the specified size and location. - of the control if different from the previous , the event is raised. Likewise, is the of the control changes, the event is raised. - + of the control if different from the previous , the event is raised. Likewise, is the of the control changes, the event is raised. + ]]> @@ -19124,11 +19159,11 @@ Note: This property will always return for an instance o The client of the control. Updates the bounds of the control with the specified size, location, and client size. - of the control is different from the previous , the event is raised. Likewise, if the of the control changes, the event is raised. - + of the control is different from the previous , the event is raised. Likewise, if the of the control changes, the event is raised. + ]]> @@ -19165,22 +19200,22 @@ Note: This property will always return for an instance o Forces the assigned styles to be reapplied to the control. - method to get the styles to apply. The styles assigned to the and properties of the assigned to the control's property are reapplied. The control is repainted to reflect the style changes if necessary. - - The method has no effect if the property value is `false`. - - - -## Examples - The following code example enables double-buffering on a and updates the styles to reflect the changes. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet3"::: - + method to get the styles to apply. The styles assigned to the and properties of the assigned to the control's property are reapplied. The control is repainted to reflect the style changes if necessary. + + The method has no effect if the property value is `false`. + + + +## Examples + The following code example enables double-buffering on a and updates the styles to reflect the changes. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CPP/controlmembers6.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/CS/controlmembers6.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.ControlMembers6/VB/controlmembers6.vb" id="Snippet3"::: + ]]> @@ -19215,11 +19250,11 @@ Note: This property will always return for an instance o Updates the control in its parent's z-order. - method updates the position of the control in its parent control's z-order. For example, if this control is a newly created control that was added to a , the z-order is updated with the new control added to the back. - + method updates the position of the control in its parent control's z-order. For example, if this control is a newly created control that was added to a , the z-order is updated with the new control added to the back. + ]]> @@ -19266,11 +19301,11 @@ Note: This property will always return for an instance o to use the wait cursor for the current control and all child controls; otherwise, . The default is . - property. - + property. + ]]> @@ -19297,55 +19332,55 @@ Note: This property will always return for an instance o Occurs when the control is finished validating. - or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - - If the property of the is set to `true` in the event delegate, all events that would usually occur after the event are suppressed. - -> [!CAUTION] -> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/winmsg/wm-activateapp) topic, and the "Message Deadlocks" section of the [About Messages and Message Queues](/windows/win32/winmsg/about-messages-and-message-queues) topic. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the derived class and validates an email address that the user enters. If the email address is not in the standard format (containing "@" and "."), the validation fails, an icon is displayed, and the event is canceled. This example requires that a and control have been created on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Validating/CPP/validating.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Validating/CS/validating.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Validating/VB/validating.vb" id="Snippet1"::: - + or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + + If the property of the is set to `true` in the event delegate, all events that would usually occur after the event are suppressed. + +> [!CAUTION] +> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the [WM_KILLFOCUS](/windows/win32/winmsg/wm-activateapp) topic, and the "Message Deadlocks" section of the [About Messages and Message Queues](/windows/win32/winmsg/about-messages-and-message-queues) topic. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the derived class and validates an email address that the user enters. If the email address is not in the standard format (containing "@" and "."), the validation fails, an icon is displayed, and the event is canceled. This example requires that a and control have been created on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Validating/CPP/validating.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Validating/CS/validating.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Validating/VB/validating.vb" id="Snippet1"::: + ]]> @@ -19375,55 +19410,55 @@ Note: This property will always return for an instance o Occurs when the control is validating. - or methods, or by setting the property to the current form, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: - -1. - -2. - -3. - -4. - -5. - -6. - - If the property is set to `false`, the and events are suppressed. - - If the property of the is set to `true` in the event delegate, all events that would usually occur after the event are suppressed. - -> [!CAUTION] -> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the `WM_KILLFOCUS` topic in the "Keyboard Input Reference" section, and the "Message Deadlocks" section of the [About Messages and Message Queues](/windows/win32/winmsg/about-messages-and-message-queues) article. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example uses the derived class and validates an email address that the user enters. If the email address is not in the standard format (containing "@" and "."), the validation fails, an icon is displayed, and the event is canceled. This example requires that a and control have been created on a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Validating/CPP/validating.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Validating/CS/validating.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Validating/VB/validating.vb" id="Snippet1"::: - + or methods, or by setting the property to the current form, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + +1. + +2. + +3. + +4. + +5. + +6. + + If the property is set to `false`, the and events are suppressed. + + If the property of the is set to `true` in the event delegate, all events that would usually occur after the event are suppressed. + +> [!CAUTION] +> Do not attempt to set focus from within the , , , , , or event handlers. Doing so can cause your application or the operating system to stop responding. For more information, see the `WM_KILLFOCUS` topic in the "Keyboard Input Reference" section, and the "Message Deadlocks" section of the [About Messages and Message Queues](/windows/win32/winmsg/about-messages-and-message-queues) article. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example uses the derived class and validates an email address that the user enters. If the email address is not in the standard format (containing "@" and "."), the validation fails, an icon is displayed, and the event is canceled. This example requires that a and control have been created on a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control.Validating/CPP/validating.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control.Validating/CS/validating.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control.Validating/VB/validating.vb" id="Snippet1"::: + ]]> @@ -19469,20 +19504,20 @@ Note: This property will always return for an instance o if the control and all its child controls are displayed; otherwise, . The default is . - and and sets their property values, based on the size of an being displayed in a control. This example requires that a has been created on a form and that and controls have been created on the . This code should be called when the image is loaded into the picture box and by the event of the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Control.Visible Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Control.Visible Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Control.Visible Example/VB/source.vb" id="Snippet1"::: - + and and sets their property values, based on the size of an being displayed in a control. This example requires that a has been created on a form and that and controls have been created on the . This code should be called when the image is loaded into the picture box and by the event of the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Control.Visible Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Control.Visible Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Control.Visible Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -19514,22 +19549,22 @@ Note: This property will always return for an instance o Occurs when the property value changes. - property is changed by either a programmatic modification or user interaction. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following code example raises the event when the property value of the control has changed. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_VisibleChanged/CPP/control_visiblechanged.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_VisibleChanged/CS/control_visiblechanged.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_VisibleChanged/VB/control_visiblechanged.vb" id="Snippet1"::: - + property is changed by either a programmatic modification or user interaction. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following code example raises the event when the property value of the control has changed. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Control_VisibleChanged/CPP/control_visiblechanged.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Control_VisibleChanged/CS/control_visiblechanged.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Control_VisibleChanged/VB/control_visiblechanged.vb" id="Snippet1"::: + ]]> @@ -19577,20 +19612,20 @@ Note: This property will always return for an instance o Gets or sets the width of the control. The width of the control in pixels. - and property values cause the property value of the control to change. - - - -## Examples - The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: - + and property values cause the property value of the control to change. + + + +## Examples + The following code example creates three controls on a form and sets their size and location by using the various size-related and location-related properties. This example requires that you have a that has a width and height of at least 300 pixels. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CPP/controlsizelocation.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/CS/controlsizelocation.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Windows.Forms.Control SizeLocation/VB/controlsizelocation.vb" id="Snippet1"::: + ]]> @@ -19636,11 +19671,11 @@ Note: This property will always return for an instance o This property is not relevant for this class. The NativeWindow contained within the control. - @@ -19671,22 +19706,22 @@ Note: This property will always return for an instance o The Windows to process. Processes Windows messages. - method after getting filtered through the method. - - The method corresponds exactly to the Windows `WindowProc` function. For more information about processing Windows messages, see the [WindowProc function](https://go.microsoft.com/fwlink/?LinkId=181565). - - - -## Examples - The following code example demonstrates overriding the method to handle operating system messages identified in the structure. The [WM_ACTIVATEAPP](/windows/win32/winmsg/wm-activateapp) operating system message is handled in this example to know when another application is becoming active. See the following topics to understand the available , , and values. Actual constant values can be found in the Windows.h header file. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.WndProc/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.WndProc/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.WndProc/VB/form1.vb" id="Snippet1"::: - + method after getting filtered through the method. + + The method corresponds exactly to the Windows `WindowProc` function. For more information about processing Windows messages, see the [WindowProc function](https://go.microsoft.com/fwlink/?LinkId=181565). + + + +## Examples + The following code example demonstrates overriding the method to handle operating system messages identified in the structure. The [WM_ACTIVATEAPP](/windows/win32/winmsg/wm-activateapp) operating system message is handled in this example to know when another application is becoming active. See the following topics to understand the available , , and values. Actual constant values can be found in the Windows.h header file. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Control.WndProc/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.Control.WndProc/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Control.WndProc/VB/form1.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Windows.Forms/DataGridViewColumnDividerDoubleClickEventArgs.xml b/xml/System.Windows.Forms/DataGridViewColumnDividerDoubleClickEventArgs.xml index 27cc32aa698..a3fd5de4954 100644 --- a/xml/System.Windows.Forms/DataGridViewColumnDividerDoubleClickEventArgs.xml +++ b/xml/System.Windows.Forms/DataGridViewColumnDividerDoubleClickEventArgs.xml @@ -42,12 +42,13 @@ - + + Constructor System.Windows.Forms diff --git a/xml/System.Windows.Forms/DialogResult.xml b/xml/System.Windows.Forms/DialogResult.xml index 921a389492e..255ec174cc0 100644 --- a/xml/System.Windows.Forms/DialogResult.xml +++ b/xml/System.Windows.Forms/DialogResult.xml @@ -25,20 +25,20 @@ Specifies identifiers to indicate the return value of a dialog box. - property and the method use this enumeration. - - - -## Examples - The following code example demonstrates how to display a with the options supported by this overload of . After verifying that a string variable, `ServerName`, is empty, the example displays a , offering the user the option to cancel the operation. If the method's return value evaluates to Yes, the form that displayed the is closed. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/MessageBox.Show Variations/CPP/form1.cpp" id="Snippet5"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/MessageBox.Show Variations/CS/form1.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/MessageBox.Show Variations/VB/form1.vb" id="Snippet5"::: - + property and the method use this enumeration. + + + +## Examples + The following code example demonstrates how to display a with the options supported by this overload of . After verifying that a string variable, `ServerName`, is empty, the example displays a , offering the user the option to cancel the operation. If the method's return value evaluates to Yes, the form that displayed the is closed. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/MessageBox.Show Variations/CPP/form1.cpp" id="Snippet5"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/MessageBox.Show Variations/CS/form1.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/MessageBox.Show Variations/VB/form1.vb" id="Snippet5"::: + ]]> @@ -110,7 +110,7 @@ 11 - To be added. + The dialog box return value is Continue (usually sent from a button labeled Continue). @@ -251,7 +251,7 @@ 10 - To be added. + The dialog box return value is Try Again (usually sent from a button labeled Try Again). diff --git a/xml/System.Windows.Forms/FolderBrowserDialog.xml b/xml/System.Windows.Forms/FolderBrowserDialog.xml index dc1ecfa6b6c..50ff8ede728 100644 --- a/xml/System.Windows.Forms/FolderBrowserDialog.xml +++ b/xml/System.Windows.Forms/FolderBrowserDialog.xml @@ -42,26 +42,26 @@ Prompts the user to select a folder. This class cannot be inherited. - , you set the to the location from which to start browsing. Optionally, you can set the to an absolute path of a subfolder of that will initially be selected. You can also optionally set the property to provide additional instructions to the user. Finally, call the method to display the dialog box to the user. When the dialog box is closed and the dialog box result from is , the will be a string containing the path to the selected folder. - - You can use the property to control if the user is able to create new folders with the **New Folder** button. - - is a modal dialog box; therefore, when shown, it blocks the rest of the application until the user has chosen a folder. When a dialog box is displayed modally, no input (keyboard or mouse click) can occur except to objects on the dialog box. The program must hide or close the dialog box (usually in response to some user action) before input to the calling program can occur. - - - -## Examples - The following code example creates an application that enables the user to open rich text (.rtf) files within the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: - + , you set the to the location from which to start browsing. Optionally, you can set the to an absolute path of a subfolder of that will initially be selected. You can also optionally set the property to provide additional instructions to the user. Finally, call the method to display the dialog box to the user. When the dialog box is closed and the dialog box result from is , the will be a string containing the path to the selected folder. + + You can use the property to control if the user is able to create new folders with the **New Folder** button. + + is a modal dialog box; therefore, when shown, it blocks the rest of the application until the user has chosen a folder. When a dialog box is displayed modally, no input (keyboard or mouse click) can occur except to objects on the dialog box. The program must hide or close the dialog box (usually in response to some user action) before input to the calling program can occur. + + + +## Examples + The following code example creates an application that enables the user to open rich text (.rtf) files within the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: + ]]> @@ -88,26 +88,26 @@ Initializes a new instance of the class. - is created, the property is set to , the property is set to an empty string (""), the property is set to an empty string, and the property is set to `true`. - - Typically, after creating a new , you set the to the location from which to start browsing. Optionally, you can set the to the path of a subfolder of that will initially be selected. You can also optionally set the property to provide additional instructions to the user. Finally, call the method to display the dialog box to the user. When the dialog box is closed and the dialog result from is , the will be a string containing the path to the selected folder. - - is a modal dialog box; therefore, when shown, it blocks the rest of the application until the user has chosen a folder. When a dialog box is displayed modally, no input (keyboard or mouse click) can occur except to objects on the dialog box. The program must hide or close the dialog box (usually in response to some user action) before input to the calling program can occur. - - - -## Examples - The following code example creates an application that enables the user to open rich text (.rtf) files within the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: - + is created, the property is set to , the property is set to an empty string (""), the property is set to an empty string, and the property is set to `true`. + + Typically, after creating a new , you set the to the location from which to start browsing. Optionally, you can set the to the path of a subfolder of that will initially be selected. You can also optionally set the property to provide additional instructions to the user. Finally, call the method to display the dialog box to the user. When the dialog box is closed and the dialog result from is , the will be a string containing the path to the selected folder. + + is a modal dialog box; therefore, when shown, it blocks the rest of the application until the user has chosen a folder. When a dialog box is displayed modally, no input (keyboard or mouse click) can occur except to objects on the dialog box. The program must hide or close the dialog box (usually in response to some user action) before input to the calling program can occur. + + + +## Examples + The following code example creates an application that enables the user to open rich text (.rtf) files within the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: + ]]> @@ -172,7 +172,12 @@ System.Nullable<System.Guid> - To be added. + + Gets or sets the GUID to associate with this dialog state. Typically, state such as the last visited folder and the position and size of the dialog is persisted based on the name of the executable file. By specifying a GUID, an application can have different persisted states for different versions of the dialog within the same application (for example, an import dialog and an open dialog). + + This functionality is not available if an application is not using visual styles or if is set to . + + To be added. To be added. @@ -218,20 +223,20 @@ Gets or sets the descriptive text displayed above the tree view control in the dialog box. The description to display. The default is an empty string (""). - property can be used to specify additional information to the user, like instructions. - - - -## Examples - The following code example creates an application that enables the user to open rich text (.rtf) files within the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: - + property can be used to specify additional information to the user, like instructions. + + + +## Examples + The following code example creates an application that enables the user to open rich text (.rtf) files within the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: + ]]> @@ -296,7 +301,7 @@ System.String - To be added. + Gets or sets the initial directory displayed by the folder browser dialog. To be added. To be added. @@ -324,11 +329,11 @@ Resets properties to their default values. - , , and properties to their default values. For a list of default values, see the constructor. - + , , and properties to their default values. For a list of default values, see the constructor. + ]]> @@ -378,20 +383,20 @@ Gets or sets the root folder where the browsing starts from. One of the values. The default is . - property, along with , determines what the selected folder will be when the dialog box is displayed, as long as is an absolute path that is a subfolder of (or more accurately, points to a subfolder of the shell namespace represented by ). - - - -## Examples - The following code example creates an application that enables the user to open rich text (.rtf) files within the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: - + property, along with , determines what the selected folder will be when the dialog box is displayed, as long as is an absolute path that is a subfolder of (or more accurately, points to a subfolder of the shell namespace represented by ). + + + +## Examples + The following code example creates an application that enables the user to open rich text (.rtf) files within the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: + ]]> The value assigned is not one of the values. @@ -476,22 +481,22 @@ Gets or sets the path selected by the user. The path of the folder first selected in the dialog box or the last folder selected by the user. The default is an empty string (""). - property is set before showing the dialog box, the folder with this path will be the selected folder, as long as is set to an absolute path that is a subfolder of (or more accurately, points to a subfolder of the shell namespace represented by ). - - If the returns , meaning the user clicked the **OK** button, the property will return a string containing the path to the selected folder. If returns , meaning the user canceled out of the dialog box, this property will have the same value that it had prior to displaying the dialog box. If the user selects a folder that does not have a physical path (for example, My Computer), the **OK** button on the dialog box will be disabled. - - - -## Examples - The following code example creates an application that enables the user to open rich text (.rtf) files within the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: - + property is set before showing the dialog box, the folder with this path will be the selected folder, as long as is set to an absolute path that is a subfolder of (or more accurately, points to a subfolder of the shell namespace represented by ). + + If the returns , meaning the user clicked the **OK** button, the property will return a string containing the path to the selected folder. If returns , meaning the user canceled out of the dialog box, this property will have the same value that it had prior to displaying the dialog box. If the user selects a folder that does not have a physical path (for example, My Computer), the **OK** button on the dialog box will be disabled. + + + +## Examples + The following code example creates an application that enables the user to open rich text (.rtf) files within the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: + ]]> @@ -543,23 +548,23 @@ if the **New Folder** button is shown in the dialog box; otherwise, . The default is . - is `true`, the **New Folder** button is visible, giving the user a chance to create a folder. When the user clicks the **New Folder** button, a new folder is created and the user is prompted to specify the folder name. The selected node in the tree becomes the parent of the new folder. The actual caption of the **New Folder** button can vary depending upon the operating system - -> [!IMPORTANT] -> Setting to `false` does not work on Windows 2000. - - - -## Examples - The following code example creates an application that enables the user to open rich text (.rtf) files within the control. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: - + is `true`, the **New Folder** button is visible, giving the user a chance to create a folder. When the user clicks the **New Folder** button, a new folder is created and the user is prompted to specify the folder name. The selected node in the tree becomes the parent of the new folder. The actual caption of the **New Folder** button can vary depending upon the operating system + +> [!IMPORTANT] +> Setting to `false` does not work on Windows 2000. + + + +## Examples + The following code example creates an application that enables the user to open rich text (.rtf) files within the control. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FolderBrowserDialog/VB/form1.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Windows.Forms/Form.xml b/xml/System.Windows.Forms/Form.xml index 67116871ac9..daed9c8233f 100644 --- a/xml/System.Windows.Forms/Form.xml +++ b/xml/System.Windows.Forms/Form.xml @@ -66,30 +66,30 @@ Represents a window or dialog box that makes up an application's user interface. - is a representation of any window displayed in your application. The class can be used to create standard, tool, borderless, and floating windows. You can also use the class to create modal windows such as a dialog box. A special kind of form, the multiple-document interface (MDI) form, can contain other forms called MDI child forms. An MDI form is created by setting the property to `true`. MDI child forms are created by setting the property to the MDI parent form that will contain the child form. - - Using the properties available in the class, you can determine the appearance, size, color, and window management features of the window or dialog box you are creating. The property allows you to specify the caption of the window in the title bar. The and properties allow you to define the size and position of the window when it is displayed. You can use the color property to change the default foreground color of all controls placed on the form. The , , and properties allow you to control whether the form can be minimized, maximized, or resized at run time. - - In addition to properties, you can use the methods of the class to manipulate a form. For example, you can use the method to show a form as a modal dialog box. You can use the method to position the form on the desktop. - - The events of the class allow you to respond to actions performed on the form. You can use the event to perform operations such as updating the data displayed in the controls of the form when the form is activated. - - You can use a form as the starting class in your application by placing a method called `Main` in the class. In the `Main` method add code to create and show the form. You will also need to add the `STAThread` attribute to the `Main` method in order for the form to run. When the starting form is closed, the application is also closed. - - If you set the property to `false` before the is visible (for example, setting to false in the Microsoft Visual Studio designer), the minimize, maximize, close, and system buttons remain enabled. If you set to `false` after the is visible (for example, when the Load event occurs), the buttons are disabled. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + is a representation of any window displayed in your application. The class can be used to create standard, tool, borderless, and floating windows. You can also use the class to create modal windows such as a dialog box. A special kind of form, the multiple-document interface (MDI) form, can contain other forms called MDI child forms. An MDI form is created by setting the property to `true`. MDI child forms are created by setting the property to the MDI parent form that will contain the child form. + + Using the properties available in the class, you can determine the appearance, size, color, and window management features of the window or dialog box you are creating. The property allows you to specify the caption of the window in the title bar. The and properties allow you to define the size and position of the window when it is displayed. You can use the color property to change the default foreground color of all controls placed on the form. The , , and properties allow you to control whether the form can be minimized, maximized, or resized at run time. + + In addition to properties, you can use the methods of the class to manipulate a form. For example, you can use the method to show a form as a modal dialog box. You can use the method to position the form on the desktop. + + The events of the class allow you to respond to actions performed on the form. You can use the event to perform operations such as updating the data displayed in the controls of the form when the form is activated. + + You can use a form as the starting class in your application by placing a method called `Main` in the class. In the `Main` method add code to create and show the form. You will also need to add the `STAThread` attribute to the `Main` method in order for the form to run. When the starting form is closed, the application is also closed. + + If you set the property to `false` before the is visible (for example, setting to false in the Microsoft Visual Studio designer), the minimize, maximize, close, and system buttons remain enabled. If you set to `false` after the is visible (for example, when the Load event occurs), the buttons are disabled. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> Multiple-Document Interface (MDI) Applications @@ -114,20 +114,20 @@ Initializes a new instance of the class. - and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also sets uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also sets uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -161,24 +161,24 @@ Gets or sets the button on the form that is clicked when the user presses the ENTER key. An that represents the button to use as the accept button for the form. - that is on the current form or located within a container on the current form. - - You can use this property to allow the user to quickly navigate a simple form by allowing them to simply press the ENTER key when they are finished instead of manually clicking the accept button with their mouse. - - The accept button might not be activated if the currently selected control on the form intercepts the ENTER key and processes it. For example, a multiline text box control allows the ENTER key to be pressed when it is selected to insert a new line character in the control. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + that is on the current form or located within a container on the current form. + + You can use this property to allow the user to quickly navigate a simple form by allowing them to simply press the ENTER key when they are finished instead of manually clicking the accept button with their mouse. + + The accept button might not be activated if the currently selected control on the form intercepts the ENTER key and processes it. For example, a multiline text box control allows the ENTER key to be pressed when it is selected to insert a new line character in the control. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -208,20 +208,20 @@ Activates the form and gives it focus. - property or the property if your forms are in a Multiple-document interface (MDI) application. - - - -## Examples - The following example demonstrates how to use the , and members. To run the example, paste the following code in a form called `Form1` containing a button called `Button1` and two `Label` controls called `Label1` and `Label2`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: - + property or the property if your forms are in a Multiple-document interface (MDI) application. + + + +## Examples + The following example demonstrates how to use the , and members. To run the example, paste the following code in a form called `Form1` containing a button called `Button1` and two `Label` controls called `Label1` and `Label2`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: + ]]> @@ -250,26 +250,26 @@ Occurs when the form is activated in code or by the user. - [!NOTE] -> When the application is active and has multiple forms, the active form is the form with the input focus. A form that is not visible cannot be the active form. The simplest way to activate a visible form is to click it or use an appropriate keyboard combination. - - To activate a form at run time using code, call the method. You can use this event for tasks such as updating the contents of the form based on changes made to the form's data when the form was not activated. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates how to use the , , , , and members. To run the example, paste the following code in a form called Form1 containing a called `Button1` and two controls called `Label1` and `Label2`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: - + [!NOTE] +> When the application is active and has multiple forms, the active form is the form with the input focus. A form that is not visible cannot be the active form. The simplest way to activate a visible form is to click it or use an appropriate keyboard combination. + + To activate a form at run time using code, call the method. You can use this event for tasks such as updating the contents of the form based on changes made to the form's data when the form was not activated. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates how to use the , , , , and members. To run the example, paste the following code in a form called Form1 containing a called `Button1` and two controls called `Label1` and `Label2`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: + ]]> @@ -301,13 +301,13 @@ The child form to activate. Activates the MDI child of a form. - method simply returns. If `form` is not `null`, then it is set to be the active MDI child form. - - Whether the `form` parameter is `null` or not, raises the event. - + method simply returns. If `form` is not `null`, then it is set to be the active MDI child form. + + Whether the `form` parameter is `null` or not, raises the event. + ]]> @@ -338,22 +338,22 @@ Gets the currently active form for this application. A that represents the currently active form, or if there is no active form. - property to obtain the currently active MDI child form. - - - -## Examples - The following example gets the active form and disables all the controls on the form. The example uses the collection of the form to iterate through each control on the form and disable the controls. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ActiveForm Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ActiveForm Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ActiveForm Example/VB/source.vb" id="Snippet1"::: - + property to obtain the currently active MDI child form. + + + +## Examples + The following example gets the active form and disables all the controls on the form. The example uses the collection of the form to iterate through each control on the form and disable the controls. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ActiveForm Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ActiveForm Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ActiveForm Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -392,22 +392,22 @@ Gets the currently active multiple-document interface (MDI) child window. Returns a that represents the currently active MDI child window, or if there are currently no child windows present. - property to obtain a reference to it. - - - -## Examples - The following example obtains a reference to the active MDI child form and loops through all controls on the form, resetting their properties. This example requires that an MDI parent form has been created and that this method call is being made from the MDI parent form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ActiveMdiChild Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ActiveMdiChild Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ActiveMdiChild Example/VB/source.vb" id="Snippet1"::: - + property to obtain a reference to it. + + + +## Examples + The following example obtains a reference to the active MDI child form and loops through all controls on the form, resetting their properties. This example requires that an MDI parent form has been created and that this method call is being made from the MDI parent form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ActiveMdiChild Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ActiveMdiChild Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ActiveMdiChild Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -439,25 +439,25 @@ The that this form will own. Adds an owned form to this form. - method is called. You can also make a form owned by another by setting the property with a reference to its owner form. - - When a form is owned by another form, it is closed or hidden with the owner form. For example, consider a form named `Form2` that is owned by a form named `Form1`. If `Form1` is closed or minimized, `Form2` is also closed or hidden. Owned forms are also never displayed behind their owner form. You can use owned forms for windows such as find and replace windows, which should not be displayed behind the owner form when the owner form is selected. - -> [!NOTE] -> If the form is a multiple-document interface (MDI) parent form, this property returns all forms that are displayed with the exception of any MDI child forms that are currently open. To obtain the MDI child forms opened in an MDI parent form, use the property. - - - -## Examples - The following example demonstrates how to use the method to display a form as an owned form of another form. Once the owned form is shown, you can minimize its owner form and the owned form will minimize with it. The example requires that the code in the example is called from another event or method of a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.AddOwnedForm/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AddOwnedForm/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AddOwnedForm/VB/form1.vb" id="Snippet1"::: - + method is called. You can also make a form owned by another by setting the property with a reference to its owner form. + + When a form is owned by another form, it is closed or hidden with the owner form. For example, consider a form named `Form2` that is owned by a form named `Form1`. If `Form1` is closed or minimized, `Form2` is also closed or hidden. Owned forms are also never displayed behind their owner form. You can use owned forms for windows such as find and replace windows, which should not be displayed behind the owner form when the owner form is selected. + +> [!NOTE] +> If the form is a multiple-document interface (MDI) parent form, this property returns all forms that are displayed with the exception of any MDI child forms that are currently open. To obtain the MDI child forms opened in an MDI parent form, use the property. + + + +## Examples + The following example demonstrates how to use the method to display a form as an owned form of another form. Once the owned form is shown, you can minimize its owner form and the owned form will minimize with it. The example requires that the code in the example is called from another event or method of a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.AddOwnedForm/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AddOwnedForm/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AddOwnedForm/VB/form1.vb" id="Snippet1"::: + ]]> @@ -534,11 +534,11 @@ if the opacity of the form can be changed; otherwise, . - property to `false` the form will not be in layered mode which will improve the display performance of the form. - + property to `false` the form will not be in layered mode which will improve the display performance of the form. + ]]> @@ -584,11 +584,11 @@ Resizes the form according to the current value of the property and the size of the current font. - property and the value returned by the method. - + property and the value returned by the method. + ]]> @@ -643,17 +643,17 @@ if the form will automatically scale itself and its controls based on the current font assigned to the form; otherwise, . The default is . - [!IMPORTANT] -> The is obsolete and has been retained for backward compatibility. The non-obsolete alternative is . For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/framework/winforms/automatic-scaling-in-windows-forms). - - You can use this property to allow your form and its controls to automatically adjust based on changes in the font. This can be useful in applications where the font might increase or decrease based on the language specified for use by Windows. - - To obtain the size the form will auto scale to, use the property. If you want to determine the size the form will auto scale to based on a specific font, use the method. - + [!IMPORTANT] +> The is obsolete and has been retained for backward compatibility. The non-obsolete alternative is . For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/framework/winforms/automatic-scaling-in-windows-forms). + + You can use this property to allow your form and its controls to automatically adjust based on changes in the font. This can be useful in applications where the font might increase or decrease based on the language specified for use by Windows. + + To obtain the size the form will auto scale to, use the property. If you want to determine the size the form will auto scale to based on a specific font, use the method. + ]]> @@ -707,18 +707,18 @@ Gets or sets the base size used for autoscaling of the form. A that represents the base size that this form uses for autoscaling. - [!IMPORTANT] -> This member has been retained for backward compatibility. For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/framework/winforms/automatic-scaling-in-windows-forms). - - The value of the property is used at form-display time to compute the scaling factor for the form. The autoscaling base size is used by the form as a baseline for comparison to the system's font size to determine how much to scale the form when autoscaling is used. If you want to determine the size a form will auto scale to based on a specific font, use the method. - -> [!NOTE] -> The value of this property is used when the form is initially created. Once the property is set, it cannot be changed. - + [!IMPORTANT] +> This member has been retained for backward compatibility. For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/framework/winforms/automatic-scaling-in-windows-forms). + + The value of the property is used at form-display time to compute the scaling factor for the form. The autoscaling base size is used by the form as a baseline for comparison to the system's font size to determine how much to scale the form when autoscaling is used. If you want to determine the size a form will auto scale to based on a specific font, use the method. + +> [!NOTE] +> The value of this property is used when the form is initially created. Once the property is set, it cannot be changed. + ]]> @@ -755,22 +755,22 @@ to enable autoscrolling on the form; otherwise, . The default is . - property to enable the display of controls that are outsize the client area of a form. The example creates a new form and adds a control to the form. The control is positioned outsize the client area of the new form. The property is set to true to display scroll bars on the form to enable the user to scroll to the control. This example requires that the method defined in this example is called from another form in an event handler or other method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.AutoScroll/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AutoScroll/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AutoScroll/VB/form1.vb" id="Snippet1"::: - + property to enable the display of controls that are outsize the client area of a form. The example creates a new form and adds a control to the form. The control is positioned outsize the client area of the new form. The property is set to true to display scroll bars on the form to enable the user to scroll to the control. This example requires that the method defined in this example is called from another form in an event handler or other method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.AutoScroll/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AutoScroll/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AutoScroll/VB/form1.vb" id="Snippet1"::: + ]]> @@ -812,25 +812,25 @@ if the form will automatically resize; if it must be manually resized. - to force a form to resize to fit its contents. - - A form does not automatically resize in the Visual Studio forms designer, regardless of the values of the and properties. The form correctly resizes itself at run time according to the values of these two properties. By contrast, a custom automatically resizes itself both at design time and at run time. - - When using , the and properties are respected, but the current value of the property is ignored. Using and also renders the property superfluous, as there is no way to shrink the form to hide its contained controls from view. - - See the enumeration for information on how a form behaves when is `true`. - - - -## Examples - The following example shows a form created using code that automatically resizes to fit its contents. When run, the form displays a , a for entering a URL, and a for displaying that URL inside of the user's default Web browser. The example uses a to lay out the contained controls one after the other. It also sets the and to grow and shrink to fit the contents of its form. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AutoSize/CS/Form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AutoSize/VB/Form1.vb" id="Snippet1"::: - + to force a form to resize to fit its contents. + + A form does not automatically resize in the Visual Studio forms designer, regardless of the values of the and properties. The form correctly resizes itself at run time according to the values of these two properties. By contrast, a custom automatically resizes itself both at design time and at run time. + + When using , the and properties are respected, but the current value of the property is ignored. Using and also renders the property superfluous, as there is no way to shrink the form to hide its contained controls from view. + + See the enumeration for information on how a form behaves when is `true`. + + + +## Examples + The following example shows a form created using code that automatically resizes to fit its contents. When run, the form displays a , a for entering a URL, and a for displaying that URL inside of the user's default Web browser. The example uses a to lay out the contained controls one after the other. It also sets the and to grow and shrink to fit the contents of its form. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AutoSize/CS/Form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AutoSize/VB/Form1.vb" id="Snippet1"::: + ]]> @@ -904,21 +904,21 @@ Gets or sets the mode by which the form automatically resizes itself. An enumerated value. The default is . - property to a new value causes the form to be laid out again. - - A form does not automatically resize in the Visual Studio forms designer, regardless of the values of the and properties. The form correctly resizes itself at run time according to the values of these two properties. By contrast, a custom automatically resizes itself both at design time and at run time. - - - -## Examples - The following example shows a form created using code that automatically resizes to fit its contents. When run, the form displays a , a for entering a URL, and a for displaying that URL inside of the user's default Web browser. The example uses a to lay out the contained controls one after the other. It also sets the and to grow and shrink to fit the contents of its form. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AutoSize/CS/Form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AutoSize/VB/Form1.vb" id="Snippet1"::: - + property to a new value causes the form to be laid out again. + + A form does not automatically resize in the Visual Studio forms designer, regardless of the values of the and properties. The form correctly resizes itself at run time according to the values of these two properties. By contrast, a custom automatically resizes itself both at design time and at run time. + + + +## Examples + The following example shows a form created using code that automatically resizes to fit its contents. When run, the form displays a , a for entering a URL, and a for displaying that URL inside of the user's default Web browser. The example uses a to lay out the contained controls one after the other. It also sets the and to grow and shrink to fit the contents of its form. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.AutoSize/CS/Form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.AutoSize/VB/Form1.vb" id="Snippet1"::: + ]]> The value is not a valid value. @@ -1050,26 +1050,26 @@ Gets or sets the button control that is clicked when the user presses the ESC key. An that represents the cancel button for the form. - that is on the current form or located within a container on the current form. - - This property allows you to designate a default action to occur when the user presses the ESC key in your application. You can use this property to allow the user to quickly navigate a simple form by allowing them to simply press the ESC key to close a window without committing changes instead of manually clicking the cancel button with their mouse. - - may not work if another control on the form intercepts the ESC key. For example, if you have a open on your form, ESC will close the instead of closing the Form. - - The object assigned to must be visible on the form, or else pressing the ESC key will have no effect. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + that is on the current form or located within a container on the current form. + + This property allows you to designate a default action to occur when the user presses the ESC key in your application. You can use this property to allow the user to quickly navigate a simple form by allowing them to simply press the ESC key to close a window without committing changes instead of manually clicking the cancel button with their mouse. + + may not work if another control on the form intercepts the ESC key. For example, if you have a open on your form, ESC will close the instead of closing the Form. + + The object assigned to must be visible on the form, or else pressing the ESC key will have no effect. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1099,13 +1099,13 @@ Centers the position of the form within the bounds of the parent form. - method directly from your code. Instead, set the property to . - - If the form or dialog is top-level, then centers the form with respect to the screen or desktop. - + method directly from your code. Instead, set the property to . + + If the form or dialog is top-level, then centers the form with respect to the screen or desktop. + ]]> @@ -1135,19 +1135,19 @@ Centers the form on the current screen. - property to . - - The method uses the following priority list to determine the screen used to center the form: - -1. The property of the form. - -2. The HWND owner of the form. - -3. The screen that currently has the mouse cursor. - + property to . + + The method uses the following priority list to determine the screen used to center the form: + +1. The property of the form. + +2. The HWND owner of the form. + +3. The screen that currently has the mouse cursor. + ]]> @@ -1187,23 +1187,23 @@ Gets or sets the size of the client area of the form. A that represents the size of the form's client area. - property or use the individual properties and . - -> [!NOTE] -> You cannot currently bind to this property using application settings. For more information on application settings, see [Application Settings Overview](/dotnet/framework/winforms/advanced/application-settings-overview). - - - -## Examples - The following example creates an event handler for the event of a form. The event handler uses the property of the form to make a control named `button1` fill the entire client area of the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ClientSize Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ClientSize Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ClientSize Example/VB/source.vb" id="Snippet1"::: - + property or use the individual properties and . + +> [!NOTE] +> You cannot currently bind to this property using application settings. For more information on application settings, see [Application Settings Overview](/dotnet/framework/winforms/advanced/application-settings-overview). + + + +## Examples + The following example creates an event handler for the event of a form. The event handler uses the property of the form to make a control named `button1` fill the entire client area of the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ClientSize Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ClientSize Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ClientSize Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1234,19 +1234,19 @@ Closes the form. - event and setting the property of the passed as a parameter to your event handler. If the form you are closing is the startup form of your application, your application ends. - - The two conditions when a form is not disposed on `Close` is when (1) it is part of a multiple-document interface (MDI) application, and the form is not visible; and (2) you have displayed the form using . In these cases, you will need to call manually to mark all of the form's controls for garbage collection. - -> [!NOTE] -> When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. - -> [!CAUTION] -> Prior to the .NET Framework 2.0, the and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. - + event and setting the property of the passed as a parameter to your event handler. If the form you are closing is the startup form of your application, your application ends. + + The two conditions when a form is not disposed on `Close` is when (1) it is part of a multiple-document interface (MDI) application, and the form is not visible; and (2) you have displayed the form using . In these cases, you will need to call manually to mark all of the form's controls for garbage collection. + +> [!NOTE] +> When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. + +> [!CAUTION] +> Prior to the .NET Framework 2.0, the and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. + ]]> The form was closed while a handle was being created. @@ -1288,33 +1288,33 @@ Occurs when the form is closed. - [!CAUTION] -> The event is obsolete in the .NET Framework version 2.0; use the event instead. - - This event occurs after the form has been closed by the user or by the method of the form. To prevent a form from closing, handle the event and set the property of the passed to your event handler to `true`. - - You can use this event to perform tasks such as freeing resources used by the form and to save information entered in the form or to update its parent form. - -> [!CAUTION] -> The and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. - - If the form is an MDI parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. In addition, the events of all MDI child forms are raised before the event of the MDI parent form is raised. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates how to use the , , , , and members. To run the example, paste the following code in a form called `Form1` containing a called `Button1` and two controls called `Label1` and `Label2`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: - + [!CAUTION] +> The event is obsolete in the .NET Framework version 2.0; use the event instead. + + This event occurs after the form has been closed by the user or by the method of the form. To prevent a form from closing, handle the event and set the property of the passed to your event handler to `true`. + + You can use this event to perform tasks such as freeing resources used by the form and to save information entered in the form or to update its parent form. + +> [!CAUTION] +> The and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. + + If the form is an MDI parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. In addition, the events of all MDI child forms are raised before the event of the MDI parent form is raised. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates how to use the , , , , and members. To run the example, paste the following code in a form called `Form1` containing a called `Button1` and two controls called `Label1` and `Label2`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1354,36 +1354,36 @@ Occurs when the form is closing. - [!CAUTION] -> The event is obsolete starting with the .NET Framework 2.0; use the event instead. - - The event occurs as the form is being closed. When a form is closed, all resources created within the object are released and the form is disposed. If you cancel this event, the form remains opened. To cancel the closure of a form, set the property of the passed to your event handler to `true`. - - When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. You can override the value assigned to the property when the user clicks the **Close** button by setting the property in an event handler for the event of the form. - -> [!NOTE] -> When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. - -> [!CAUTION] -> The and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. - - If the form is an MDI parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. In addition, the events of all MDI child forms are raised before the event of the MDI parent form is raised. Canceling the event of an MDI child form does not prevent the event of the MDI parent form from being raised. However, canceling the event will set to `true` the property of the that is passed as a parameter to the parent form. To force all MDI parent and child forms to close, set the property to `false` in the MDI parent form. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example uses to test if the text in a has changed. If it has, the user is asked whether to save the changes to a file. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Closing/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Closing/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Closing/VB/form1.vb" id="Snippet1"::: - + [!CAUTION] +> The event is obsolete starting with the .NET Framework 2.0; use the event instead. + + The event occurs as the form is being closed. When a form is closed, all resources created within the object are released and the form is disposed. If you cancel this event, the form remains opened. To cancel the closure of a form, set the property of the passed to your event handler to `true`. + + When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. You can override the value assigned to the property when the user clicks the **Close** button by setting the property in an event handler for the event of the form. + +> [!NOTE] +> When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. + +> [!CAUTION] +> The and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. + + If the form is an MDI parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. In addition, the events of all MDI child forms are raised before the event of the MDI parent form is raised. Canceling the event of an MDI child form does not prevent the event of the MDI parent form from being raised. However, canceling the event will set to `true` the property of the that is passed as a parameter to the parent form. To force all MDI parent and child forms to close, set the property to `false` in the MDI parent form. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example uses to test if the text in a has changed. If it has, the user is asked whether to save the changes to a file. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Closing/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Closing/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Closing/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1420,25 +1420,25 @@ if the form displays a control box in the upper-right corner of the form; otherwise, . The default is . - property is set to `true`, the control box is displayed in the upper-right corner of the caption bar. The control box can include minimize, maximize, and help buttons in addition to a close button. For the `ControlBox` property to have any effect, you must also set the form's property to , , , or . - - If you set to `false` and also set the property, the property of the form is not updated to reflect that the non-client area of the form has been hidden. To fix this problem, put the code that alters the property in the event handler. - -> [!NOTE] -> When set to `false`, the property has no effect on a Multiple-document interface (MDI) child form that is displayed maximized at time of creation. - - - -## Examples - The following example uses the , , , , and properties to create a form that does not have any border or caption box. The form created in this example could be used to create a splash screen for an application. The example requires that the example's method is defined in a form class and called when the form is being initialized. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ControlBox Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ControlBox Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ControlBox Example/VB/source.vb" id="Snippet1"::: - + property is set to `true`, the control box is displayed in the upper-right corner of the caption bar. The control box can include minimize, maximize, and help buttons in addition to a close button. For the `ControlBox` property to have any effect, you must also set the form's property to , , , or . + + If you set to `false` and also set the property, the property of the form is not updated to reflect that the non-client area of the form has been hidden. To fix this problem, put the code that alters the property in the event handler. + +> [!NOTE] +> When set to `false`, the property has no effect on a Multiple-document interface (MDI) child form that is displayed maximized at time of creation. + + + +## Examples + The following example uses the , , , , and properties to create a form that does not have any border or caption box. The form created in this example could be used to create a splash screen for an application. The example requires that the example's method is defined in a form class and called when the form is being initialized. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ControlBox Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ControlBox Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ControlBox Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1586,23 +1586,23 @@ Occurs when the form loses focus and is no longer the active form. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet393"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet393"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet393"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet393"::: + ]]> @@ -1633,13 +1633,13 @@ Gets the default Input Method Editor (IME) mode supported by the control. One of the values. - class, this property always returns the value. The value of this property is assigned to the property. - + class, this property always returns the value. The value of this property is assigned to the property. + ]]> @@ -1739,22 +1739,22 @@ Gets or sets the size and location of the form on the Windows desktop. A that represents the bounds of the form on the Windows desktop using desktop coordinates. - @@ -1793,26 +1793,26 @@ Gets or sets the location of the form on the Windows desktop. A that represents the location of the form on the desktop. - method before calling the method, your form will be positioned at its default location, which is determined by the operating system. For more information about window positioning, see the [Window Size and Position](/windows/win32/winmsg/window-features#window-size-and-position) section of the "Window Features" article. - - If you call after calling , your form will be positioned at the location you specified. - - - -## Examples - The following example sets the position of a form so that the form is positioned 100 pixels from the left border of the desktop and 100 pixels from the top of the desktop. This example requires that method has been defined within a form class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.DesktopLocation Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.DesktopLocation Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.DesktopLocation Example/VB/source.vb" id="Snippet1"::: - + method before calling the method, your form will be positioned at its default location, which is determined by the operating system. For more information about window positioning, see the [Window Size and Position](/windows/win32/winmsg/window-features#window-size-and-position) section of the "Window Features" article. + + If you call after calling , your form will be positioned at the location you specified. + + + +## Examples + The following example sets the position of a form so that the form is positioned 100 pixels from the left border of the desktop and 100 pixels from the top of the desktop. This example requires that method has been defined within a form class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.DesktopLocation Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.DesktopLocation Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.DesktopLocation Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1855,30 +1855,30 @@ Gets or sets the dialog result for the form. A that represents the result of the form when used as a dialog box. - enumeration sets the value of the dialog box result for the form, hides the modal dialog box, and returns control to the calling form. This property is typically set by the property of a control on the form. When the user clicks the control, the value assigned to the property of the is assigned to the property of the form. - - When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X in the top-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. The method is not automatically called when the user clicks the **Close** button of a dialog box or sets the value of the property. Instead, the form is hidden and can be shown again without creating a new instance of the dialog box. Because of this behavior, you must call the method of the form when the form is no longer needed by your application. - - You can use this property to determine how a dialog box is closed in order to properly process the actions performed in the dialog box. - -> [!NOTE] -> You can override the value assigned to the property when the user clicks the **Close** button by setting the property in an event handler for the event of the form. - -> [!NOTE] -> If a is displayed as a modeless window, the value returned by the property might not return a value assigned to the form because the form's resources are automatically released when the form is closed. - - - -## Examples - The following example displays a form as a dialog box and displays a message box indicating whether the OK or Cancel button of the form was clicked by referencing the property of the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.DialogResult Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.DialogResult Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.DialogResult Example/VB/source.vb" id="Snippet1"::: - + enumeration sets the value of the dialog box result for the form, hides the modal dialog box, and returns control to the calling form. This property is typically set by the property of a control on the form. When the user clicks the control, the value assigned to the property of the is assigned to the property of the form. + + When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X in the top-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. The method is not automatically called when the user clicks the **Close** button of a dialog box or sets the value of the property. Instead, the form is hidden and can be shown again without creating a new instance of the dialog box. Because of this behavior, you must call the method of the form when the form is no longer needed by your application. + + You can use this property to determine how a dialog box is closed in order to properly process the actions performed in the dialog box. + +> [!NOTE] +> You can override the value assigned to the property when the user clicks the **Close** button by setting the property in an event handler for the event of the form. + +> [!NOTE] +> If a is displayed as a modeless window, the value returned by the property might not return a value assigned to the form because the form's resources are automatically released when the form is closed. + + + +## Examples + The following example displays a form as a dialog box and displays a message box indicating whether the OK or Cancel button of the form was clicked by referencing the property of the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.DialogResult Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.DialogResult Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.DialogResult Example/VB/source.vb" id="Snippet1"::: + ]]> The value specified is outside the range of valid values. @@ -1913,21 +1913,21 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Disposes of the resources (other than memory) used by the . - method. `Dispose` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. invokes `Dispose` with `disposing` set to `false`. - - When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose` method of each referenced object. - - will be called automatically if the form is shown using the method. If another method such as is used, or the form is never shown at all, you must call yourself within your application. - + method. `Dispose` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. invokes `Dispose` with `disposing` set to `false`. + + When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose` method of each referenced object. + + will be called automatically if the form is shown using the method. If another method such as is used, or the form is never shown at all, you must call yourself within your application. + ]]> - can be called multiple times by other objects. When overriding , be careful not to reference objects that have been previously disposed of in an earlier call to . For more information about how to implement , see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - + can be called multiple times by other objects. When overriding , be careful not to reference objects that have been previously disposed of in an earlier call to . For more information about how to implement , see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + For more information about and , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Overriding the Finalize Method](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)). @@ -1987,23 +1987,23 @@ Gets or sets the border style of the form. A that represents the style of border to display for the form. The default is . - [!NOTE] -> With the style, it is impossible to resize the window below a certain minimum value, even if you have set to `false` and assigned a zero-length string to . Consider working around this by using the style instead. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + [!NOTE] +> With the style, it is impossible to resize the window below a certain minimum value, even if you have set to `false` and assigned a zero-length string to . Consider working around this by using the style instead. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> The value specified is outside the range of valid values. @@ -2031,27 +2031,27 @@ Occurs after the form is closed. - event occurs after the form has been closed by the user or by the method or the method of the class. To prevent a form from closing, handle the event and set the property of the passed to your event handler to `true`. - - You can use this event to perform tasks such as freeing resources used by the form and to save information entered in the form or to update its parent form. - - If the form is a multiple-document interface (MDI) parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. Likewise, the events of all MDI child forms are raised before the event of the MDI parent form is raised. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet395"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet395"::: - + event occurs after the form has been closed by the user or by the method or the method of the class. To prevent a form from closing, handle the event and set the property of the passed to your event handler to `true`. + + You can use this event to perform tasks such as freeing resources used by the form and to save information entered in the form or to update its parent form. + + If the form is a multiple-document interface (MDI) parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. Likewise, the events of all MDI child forms are raised before the event of the MDI parent form is raised. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet395"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet395"::: + ]]> @@ -2086,30 +2086,30 @@ Occurs before the form is closed. - event occurs as the form is being closed. When a form is closed, it is disposed, releasing all resources associated with the form. If you cancel this event, the form remains opened. To cancel the closure of a form, set the property of the passed to your event handler to `true`. - - When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. You can override the value assigned to the property when the user clicks the **Close** button by setting the property in an event handler for the event of the form. - -> [!NOTE] -> When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. - - If the form is a multiple-document interface (MDI) parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. Likewise, the events of all MDI child forms are raised before the event of the MDI parent form is raised. Canceling the event of an MDI child form does not prevent the event of the MDI parent form from being raised. However, canceling the event will set to `true` the property of the class that is passed as a parameter to the parent form. To force all MDI parent and child forms to close, set the property to `false` in the MDI parent form. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet394"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet394"::: - + event occurs as the form is being closed. When a form is closed, it is disposed, releasing all resources associated with the form. If you cancel this event, the form remains opened. To cancel the closure of a form, set the property of the passed to your event handler to `true`. + + When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. You can override the value assigned to the property when the user clicks the **Close** button by setting the property in an event handler for the event of the form. + +> [!NOTE] +> When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. + + If the form is a multiple-document interface (MDI) parent form, the events of all MDI child forms are raised before the MDI parent form's event is raised. Likewise, the events of all MDI child forms are raised before the event of the MDI parent form is raised. Canceling the event of an MDI child form does not prevent the event of the MDI parent form from being raised. However, canceling the event will set to `true` the property of the class that is passed as a parameter to the parent form. To force all MDI parent and child forms to close, set the property to `false` in the MDI parent form. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet394"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet394"::: + ]]> @@ -2167,15 +2167,15 @@ Gets the size when autoscaling the form based on a specified font. A representing the autoscaled size of the form. - [!IMPORTANT] -> The method is obsolete starting with the .NET Framework 2.0. This member has been retained for backward compatibility. For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/framework/winforms/automatic-scaling-in-windows-forms). - - You can use this method to determine the size a form would autoscale to for a specific font before applying the font to the form. If you want to determine the size a form is autoscaled to based on the font currently assigned to the form, use the property. - + [!IMPORTANT] +> The method is obsolete starting with the .NET Framework 2.0. This member has been retained for backward compatibility. For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/framework/winforms/automatic-scaling-in-windows-forms). + + You can use this method to determine the size a form would autoscale to for a specific font before applying the font to the form. If you want to determine the size a form is autoscaled to based on the font currently assigned to the form, use the property. + ]]> @@ -2250,26 +2250,26 @@ to display a Help button in the form's caption bar; otherwise, . The default is . - event to display Help information to the user when the Help button of the form is clicked. - -To display a Help button, the value of the form's property must be `true`, its default value. The property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. In addition, you must also set the form's property to , , , or . - - -> [!IMPORTANT] -> The value of the property is ignored if the **Maximize** or **Minimize** buttons are shown. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a Help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + event to display Help information to the user when the Help button of the form is clicked. + +To display a Help button, the value of the form's property must be `true`, its default value. The property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. In addition, you must also set the form's property to , , , or . + + +> [!IMPORTANT] +> The value of the property is ignored if the **Maximize** or **Minimize** buttons are shown. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a Help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -2309,23 +2309,23 @@ To display a Help button, the value of the form's Occurs when the **Help** button is clicked. - event occurs when the **Help** button in the form's caption bar is clicked. The **Help** button is displayed when the property is set to `true`. can be canceled. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet388"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet388"::: - + event occurs when the **Help** button in the form's caption bar is clicked. The **Help** button is displayed when the property is set to `true`. can be canceled. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet388"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet388"::: + ]]> @@ -2367,13 +2367,13 @@ To display a Help button, the value of the form's Gets or sets the icon for the form. An that represents the icon for the form. - is set to . In that case, the form will not display an icon. - + is set to . In that case, the form will not display an icon. + ]]> @@ -2401,23 +2401,23 @@ To display a Help button, the value of the form's Occurs after the input language of the form has changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet400"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet400"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet400"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet400"::: + ]]> @@ -2446,23 +2446,23 @@ To display a Help button, the value of the form's Occurs when the user attempts to change the input language for the form. - property of the passed to your event handler to `false`. If the event is canceled, the input language is not changed. You can use this event to determine whether the requested input language change is appropriate for your application. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet401"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet401"::: - + property of the passed to your event handler to `false`. If the event is canceled, the input language is not changed. You can use this event to determine whether the requested input language change is appropriate for your application. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet401"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet401"::: + ]]> @@ -2503,16 +2503,16 @@ To display a Help button, the value of the form's if the form is an MDI child form; otherwise, . - that will be the MDI parent form to the property of the child form. You can use the property to determine whether a form is an MDI parent form. - - You can use the property to determine whether a form returned by a method or property is an MDI child form or a standard form in your application such as a dialog box. - -> [!NOTE] -> All MDI child forms have sizable borders, a control-menu box, and Minimize and **Maximize** buttons, regardless of the settings of the , , , and properties. - + that will be the MDI parent form to the property of the child form. You can use the property to determine whether a form is an MDI parent form. + + You can use the property to determine whether a form returned by a method or property is an MDI child form or a standard form in your application such as a dialog box. + +> [!NOTE] +> All MDI child forms have sizable borders, a control-menu box, and Minimize and **Maximize** buttons, regardless of the settings of the , , , and properties. + ]]> @@ -2550,24 +2550,24 @@ To display a Help button, the value of the form's if the form is a container for MDI child forms; otherwise, . The default is . - events of all MDI child forms are raised before the MDI parent form's event is raised. In addition, the events of all MDI child forms are raised before the event of the MDI parent form is raised. - -> [!NOTE] -> If there are two controls on an MDI child form, setting to `true` for the parent form merges the contents of only one of the controls. Use to merge the contents of additional child controls on the MDI parent form. - - - -## Examples - The following example demonstrates using the property as well as changing the `BackColor` property of an MDI Form. To run this example, paste the following code in a new form. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MdiClientExample/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MdiClientExample/VB/form1.vb" id="Snippet1"::: - + events of all MDI child forms are raised before the MDI parent form's event is raised. In addition, the events of all MDI child forms are raised before the event of the MDI parent form is raised. + +> [!NOTE] +> If there are two controls on an MDI child form, setting to `true` for the parent form merges the contents of only one of the controls. Use to merge the contents of additional child controls on the MDI parent form. + + + +## Examples + The following example demonstrates using the property as well as changing the `BackColor` property of an MDI Form. To run this example, paste the following code in a new form. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.MdiClientExample/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.MdiClientExample/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2609,11 +2609,11 @@ To display a Help button, the value of the form's if the form has restrictions; otherwise, . The default is . - property determines whether the permission is granted. This property is set at run time in the form's constructor, and is cached for the lifetime of the form. Windows Forms applications running in partial trust cannot circumvent this check, as the common language runtime ensures that the parent constructor is always called in partial trust. - + property determines whether the permission is granted. This property is set at run time in the form's constructor, and is cached for the lifetime of the form. Windows Forms applications running in partial trust cannot circumvent this check, as the common language runtime ensures that the parent constructor is always called in partial trust. + ]]> @@ -2648,28 +2648,28 @@ To display a Help button, the value of the form's if the form will receive all key events; if the currently selected control on the form receives key events. The default is . - , , and events. After the form's event handlers have completed processing the keystroke, the keystroke is then assigned to the control with focus. For example, if the property is set to `true` and the currently selected control is a , after the keystroke is handled by the event handlers of the form the control will receive the key that was pressed. To handle keyboard events only at the form level and not allow controls to receive keyboard events, set the property in your form's event handler to `true`. - - You can use this property to process most keystrokes in your application and either handle the keystroke or call the appropriate control to handle the keystroke. For example, when an application uses function keys, you might want to process the keystrokes at the form level rather than writing code for each control that might receive keystroke events. - -> [!NOTE] -> If a form has no visible or enabled controls, it automatically receives all keyboard events. - -> [!NOTE] -> A control on a form may be programmed to cancel any keystrokes it receives. Since the control never sends these keystrokes to the form, the form will never see them regardless of the setting of . - - - -## Examples - The following example demonstrates setting a form's property to true and handling the key events at the form level. To run the example, paste the following code in a blank form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/VB/form1.vb" id="Snippet2"::: - + , , and events. After the form's event handlers have completed processing the keystroke, the keystroke is then assigned to the control with focus. For example, if the property is set to `true` and the currently selected control is a , after the keystroke is handled by the event handlers of the form the control will receive the key that was pressed. To handle keyboard events only at the form level and not allow controls to receive keyboard events, set the property in your form's event handler to `true`. + + You can use this property to process most keystrokes in your application and either handle the keystroke or call the appropriate control to handle the keystroke. For example, when an application uses function keys, you might want to process the keystrokes at the form level rather than writing code for each control that might receive keystroke events. + +> [!NOTE] +> If a form has no visible or enabled controls, it automatically receives all keyboard events. + +> [!NOTE] +> A control on a form may be programmed to cancel any keystrokes it receives. Since the control never sends these keystrokes to the form, the form will never see them regardless of the setting of . + + + +## Examples + The following example demonstrates setting a form's property to true and handling the key events at the form level. To run the example, paste the following code in a blank form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ProcessMnemonic/VB/form1.vb" id="Snippet2"::: + ]]> @@ -2703,20 +2703,20 @@ To display a Help button, the value of the form's One of the values that defines the layout of MDI child forms. Arranges the multiple-document interface (MDI) child forms within the MDI parent form. - method to arrange any child forms that are currently open in the application. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.LayoutMdi Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.LayoutMdi Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.LayoutMdi Example/VB/source.vb" id="Snippet1"::: - + method to arrange any child forms that are currently open in the application. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.LayoutMdi Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.LayoutMdi Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.LayoutMdi Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -2744,22 +2744,22 @@ To display a Help button, the value of the form's Occurs before a form is displayed for the first time. - , , , and members. To run the example, paste the following code in a form called `Form1` containing a called `Button1` and two controls called `Label1` and `Label2`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: - + , , , and members. To run the example, paste the following code in a form called `Form1` containing a called `Button1` and two controls called `Label1` and `Label2`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: + ]]> @@ -2794,13 +2794,13 @@ To display a Help button, the value of the form's Gets or sets the that represents the upper-left corner of the in screen coordinates. The that represents the upper-left corner of the in screen coordinates. - is a structure, which means that it is a value type. If you access a property in , a copy of the property is returned. Therefore, changing the or properties of the returned from the property will not affect the , , , or property values of the . To adjust these properties, set each property value individually, or set the property with a new . - - The property gets or sets the property of the base class, and sets the property to `true`. - + is a structure, which means that it is a value type. If you access a property in , a copy of the property is returned. Therefore, changing the or properties of the returned from the property will not affect the , , , or property values of the . To adjust these properties, set each property value individually, or set the property with a new . + + The property gets or sets the property of the base class, and sets the property to `true`. + ]]> @@ -2840,13 +2840,13 @@ To display a Help button, the value of the form's Gets or sets the primary menu container for the form. A that represents the container for the menu structure of the form. The default is . - property, you must the control to the collection of the form. - - The class supersedes the class in previous versions of the .NET Framework. - + property, you must the control to the collection of the form. + + The class supersedes the class in previous versions of the .NET Framework. + ]]> @@ -2950,26 +2950,26 @@ To display a Help button, the value of the form's to display a **Maximize** button for the form; otherwise, . The default is . - property must be `true`, its default value. The property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. In addition, you must also set the form's property to , , , or . - - A **Maximize** button automatically becomes a restore button when a window is maximized. Minimizing or restoring a window automatically changes the restore button back to a **Maximize** button. - -> [!NOTE] -> Maximizing a form at run time generates a event. The property reflects the current state of the window. If you set the property to `FormWindowState.Maximized`, the form is maximized independently of whatever settings are in effect for the and properties. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + property must be `true`, its default value. The property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. In addition, you must also set the form's property to , , , or . + + A **Maximize** button automatically becomes a restore button when a window is maximized. Minimizing or restoring a window automatically changes the restore button back to a **Maximize** button. + +> [!NOTE] +> Maximizing a form at run time generates a event. The property reflects the current state of the window. If you set the property to `FormWindowState.Maximized`, the form is maximized independently of whatever settings are in effect for the and properties. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -2999,10 +2999,10 @@ To display a Help button, the value of the form's Gets or sets the size of the form when it is maximized. A that represents the bounds of the form when it is maximized. To be added. - The value of the property is greater than the height of the form. - - -or- - + The value of the property is greater than the height of the form. + + -or- + The value of the property is greater than the width of the form. Classes that inherit from can override this method to provide new bounds for the form when it is maximized. The class sets this property internally when the form's **Maximize** button is clicked. @@ -3033,21 +3033,21 @@ To display a Help button, the value of the form's Occurs when the value of the property has changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet389"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet389"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet389"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet389"::: + ]]> @@ -3094,20 +3094,20 @@ To display a Help button, the value of the form's Gets the maximum size the form can be resized to. A that represents the maximum size for the form. - object that is 0 in height and 0 in width, the form will have no maximum size beyond the limits set by Windows. - - - -## Examples - The following example demonstrates setting the property. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CPP/form1.cpp" id="Snippet3"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CS/form1.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormExample/VB/form1.vb" id="Snippet3"::: - + object that is 0 in height and 0 in width, the form will have no maximum size beyond the limits set by Windows. + + + +## Examples + The following example demonstrates setting the property. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CPP/form1.cpp" id="Snippet3"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CS/form1.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormExample/VB/form1.vb" id="Snippet3"::: + ]]> The values of the height or width within the object are less than zero. @@ -3138,21 +3138,21 @@ To display a Help button, the value of the form's Occurs when the value of the property has changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet390"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet390"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet390"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet390"::: + ]]> @@ -3181,23 +3181,23 @@ To display a Help button, the value of the form's Occurs when a multiple-document interface (MDI) child form is activated or closed within an MDI application. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet397"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet397"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet397"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet397"::: + ]]> @@ -3236,22 +3236,22 @@ To display a Help button, the value of the form's Gets an array of forms that represent the multiple-document interface (MDI) child forms that are parented to this form. An array of objects, each of which identifies one of this form's MDI child forms. - that will be the MDI parent form to the property of the child form. - - You can use this property to loop through all the MDI child forms to perform operations such as saving data to a database when the MDI parent form closes or to update fields on the child forms based on actions performed in your application. - - - -## Examples - The following example demonstrates how to use the property to iterate through the list of MDI child forms and add a control to each. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.MDIChildren/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.MDIChildren/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.MDIChildren/VB/form1.vb" id="Snippet1"::: - + that will be the MDI parent form to the property of the child form. + + You can use this property to loop through all the MDI child forms to perform operations such as saving data to a database when the MDI parent form closes or to update fields on the child forms based on actions performed in your application. + + + +## Examples + The following example demonstrates how to use the property to iterate through the list of MDI child forms and add a control to each. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.MDIChildren/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.MDIChildren/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.MDIChildren/VB/form1.vb" id="Snippet1"::: + ]]> @@ -3259,6 +3259,42 @@ To display a Help button, the value of the form's + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets the anchoring for minimized MDI children. + + to anchor minimized MDI children to the bottom left of the parent form; to anchor to the top left of the parent form. + + + + + @@ -3296,33 +3332,33 @@ To display a Help button, the value of the form's Gets or sets the current multiple-document interface (MDI) parent form of this form. A that represents the MDI parent form. - that will be the MDI parent form to the property of the child form. You can use this property from an MDI child form to obtain global information that all child forms need or to invoke methods that perform actions to all child forms. - -> [!NOTE] -> If there are two controls on an MDI child form, setting to `true` for the parent form merges the contents of only one of the controls. Use to merge the contents of additional child controls on the MDI parent form. - - - -## Examples - The following example demonstrates how to create child forms in an MDI application. The example code creates a form with unique text to identify the child form. The example uses the property to specify that a form is a child form. This example requires that the code in the example is called from a form that has its property set to `true` and that the form has a private class level integer variable named `childCount`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.MDIParent/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.MDIParent/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.MDIParent/VB/form1.vb" id="Snippet1"::: - + that will be the MDI parent form to the property of the child form. You can use this property from an MDI child form to obtain global information that all child forms need or to invoke methods that perform actions to all child forms. + +> [!NOTE] +> If there are two controls on an MDI child form, setting to `true` for the parent form merges the contents of only one of the controls. Use to merge the contents of additional child controls on the MDI parent form. + + + +## Examples + The following example demonstrates how to create child forms in an MDI application. The example code creates a form with unique text to identify the child form. The example uses the property to specify that a form is a child form. This example requires that the code in the example is called from a form that has its property set to `true` and that the form has a private class level integer variable named `childCount`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.MDIParent/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.MDIParent/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.MDIParent/VB/form1.vb" id="Snippet1"::: + ]]> - The assigned to this property is not marked as an MDI container. - - -or- - - The assigned to this property is both a child and an MDI container form. - - -or- - + The assigned to this property is not marked as an MDI container. + + -or- + + The assigned to this property is both a child and an MDI container form. + + -or- + The assigned to this property is located on a different thread. @@ -3364,20 +3400,20 @@ To display a Help button, the value of the form's Gets or sets the that is displayed in the form. A that represents the menu to display in the form. - to be displayed when your multiple-document interface (MDI) form has no active MDI child forms and another to display when a child window is displayed. You can also use a different when specific conditions exist in your application that require displaying a different menu set. - - - -## Examples - The following example creates a , assigns two objects to the and binds it to a form. This example requires that you have a created that is named `Form1`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic MainMenu.MainMenu Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic MainMenu.MainMenu Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic MainMenu.MainMenu Example/VB/source.vb" id="Snippet1"::: - + to be displayed when your multiple-document interface (MDI) form has no active MDI child forms and another to display when a child window is displayed. You can also use a different when specific conditions exist in your application that require displaying a different menu set. + + + +## Examples + The following example creates a , assigns two objects to the and binds it to a form. This example requires that you have a created that is named `Form1`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic MainMenu.MainMenu Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic MainMenu.MainMenu Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic MainMenu.MainMenu Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -3413,23 +3449,23 @@ To display a Help button, the value of the form's Occurs when the menu of a form loses focus. - control or enabling and disabling buttons on a . - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet398"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet398"::: - + control or enabling and disabling buttons on a . + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet398"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet398"::: + ]]> @@ -3463,23 +3499,23 @@ To display a Help button, the value of the form's Occurs when the menu of a form receives focus. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet399"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet399"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet399"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet399"::: + ]]> @@ -3524,11 +3560,11 @@ To display a Help button, the value of the form's Gets the merged menu for the form. A that represents the merged menu of the form. - assigned to a form, use the property. - + assigned to a form, use the property. + ]]> @@ -3566,23 +3602,23 @@ To display a Help button, the value of the form's to display a **Minimize** button for the form; otherwise, . The default is . - property must be `true`, its default value. The property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. In addition, you must also set the form's property to , , , or . - -> [!NOTE] -> Minimizing a form at run time generates a event. The property reflects the current state of the window. If you set the property to `FormWindowState.Minimized`, the form is minimized independently of whatever settings are in effect for the and properties. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: - + property must be `true`, its default value. The property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. In addition, you must also set the form's property to , , , or . + +> [!NOTE] +> Minimizing a form at run time generates a event. The property reflects the current state of the window. If you set the property to `FormWindowState.Minimized`, the form is minimized independently of whatever settings are in effect for the and properties. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.AcceptButton Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.AcceptButton Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -3629,11 +3665,11 @@ To display a Help button, the value of the form's Gets or sets the minimum size the form can be resized to. A that represents the minimum size for the form. - object that is 0 in height and 0 in width, the form will have no minimum size beyond the limits set by Windows. - + object that is 0 in height and 0 in width, the form will have no minimum size beyond the limits set by Windows. + ]]> The values of the height or width within the object are less than zero. @@ -3661,21 +3697,21 @@ To display a Help button, the value of the form's Occurs when the value of the property has changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet391"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet391"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet391"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet391"::: + ]]> @@ -3716,24 +3752,24 @@ To display a Help button, the value of the form's if the form is displayed modally; otherwise, . - method. - - - -## Examples - The following example uses the property to determine if a form is displayed as a modal form. If it is not the and properties are changed to make the form a non-top-level form with a tool window border. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Modal/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Modal/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Modal/VB/form1.vb" id="Snippet1"::: - + method. + + + +## Examples + The following example uses the property to determine if a form is displayed as a modal form. If it is not the and properties are changed to make the form a non-top-level form with a tool window border. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Modal/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Modal/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Modal/VB/form1.vb" id="Snippet1"::: + ]]> @@ -3771,13 +3807,13 @@ To display a Help button, the value of the form's An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. + ]]> @@ -3812,13 +3848,13 @@ To display a Help button, the value of the form's An that contains the data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -3851,13 +3887,13 @@ To display a Help button, the value of the form's An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -3897,29 +3933,29 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - [!CAUTION] -> The method is obsolete starting with the .NET Framework 2.0; use the method instead. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. - -> [!CAUTION] -> The and methods are not called when the method is called to exit your application. If you have validation code in either of these methods that must be executed, you should call the method for each open form individually before calling the method. - - - -## Examples - The following example demonstrates how to override the method in a class derived from . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet6"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CS/form1.cs" id="Snippet6"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet6"::: - + [!CAUTION] +> The method is obsolete starting with the .NET Framework 2.0; use the method instead. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. + +> [!CAUTION] +> The and methods are not called when the method is called to exit your application. If you have validation code in either of these methods that must be executed, you should call the method for each open form individually before calling the method. + + + +## Examples + The following example demonstrates how to override the method in a class derived from . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CPP/form1.cpp" id="Snippet6"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/CS/form1.cs" id="Snippet6"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.PointsAndSizes/VB/form1.vb" id="Snippet6"::: + ]]> @@ -3961,29 +3997,29 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - [!CAUTION] -> The method is obsolete starting with the .NET Framework 2.0; use the method instead. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. - -> [!CAUTION] -> The and methods are not called when the method is called to exit your application. If you have validation code in either of these methods that must be executed, you should call the method for each open form individually before calling the method. - - - -## Examples - The following example uses to test if the text in a has changed. If it has, the user is asked whether to save the changes to a file. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Closing/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Closing/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Closing/VB/form1.vb" id="Snippet1"::: - + [!CAUTION] +> The method is obsolete starting with the .NET Framework 2.0; use the method instead. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. + +> [!CAUTION] +> The and methods are not called when the method is called to exit your application. If you have validation code in either of these methods that must be executed, you should call the method for each open form individually before calling the method. + + + +## Examples + The following example uses to test if the text in a has changed. If it has, the user is asked whether to save the changes to a file. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Closing/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Closing/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Closing/VB/form1.vb" id="Snippet1"::: + ]]> @@ -4022,11 +4058,11 @@ To display a Help button, the value of the form's Raises the event. - @@ -4066,13 +4102,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4187,13 +4223,13 @@ To display a Help button, the value of the form's An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4267,15 +4303,15 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - method removes the current form from the collection of the associated . - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. - + method removes the current form from the collection of the associated . + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. Overriding this method is the preferred technique for handling the event in a derived class. + ]]> @@ -4319,13 +4355,13 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4481,13 +4517,13 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4530,13 +4566,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4578,13 +4614,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4653,13 +4689,13 @@ To display a Help button, the value of the form's An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4701,13 +4737,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4750,13 +4786,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4799,13 +4835,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4847,13 +4883,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4895,13 +4931,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -4943,13 +4979,13 @@ To display a Help button, the value of the form's An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -5060,15 +5096,15 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - event will only be raised if the form's property is set to `true`. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + event will only be raised if the form's property is set to `true`. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -5111,15 +5147,15 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - event will only be raised if the form's property is set to `true`. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + event will only be raised if the form's property is set to `true`. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -5162,15 +5198,15 @@ To display a Help button, the value of the form's An that contains the event data. Raises the event. - method will return without performing any action. If the property of the form has a value of , then the handles of the form and its child controls will be recreated through calls to the method. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method will return without performing any action. If the property of the form has a value of , then the handles of the form and its child controls will be recreated through calls to the method. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -5214,15 +5250,15 @@ To display a Help button, the value of the form's A that contains the event data. Raises the event. - event occurs whenever the form is first shown. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + event occurs whenever the form is first shown. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -5338,13 +5374,13 @@ To display a Help button, the value of the form's The that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -5388,27 +5424,27 @@ To display a Help button, the value of the form's Gets or sets the opacity level of the form. The level of opacity for the form. The default is 1.00. - property enables you to specify a level of transparency for the form and its controls. When this property is set to a value less than 100 percent (1.00), the entire form, including borders, is made more transparent. Setting this property to a value of 0 percent (0.00) makes the form completely invisible. You can use this property to provide different levels of transparency or to provide effects such as phasing a form in or out of view. For example, you can phase a form into view by setting the property to a value of 0 percent (0.00) and gradually increasing the value until it reaches 100 percent (1.00). - - differs from the transparency provided by , which only makes a form and its controls completely transparent if they are the same color as the value specified in the property. - -This property is not supported when is `true`. - -The property depends on the Layered Windows API. For more information, see [Layered Windows](/windows/win32/winmsg/window-features#layered-windows). - -## Examples - -The following example demonstrates how to create a form that is displayed with an opacity level of 75 percent. It creates a new form that is positioned in the center of the screen with an property set to change the opacity level of the form. The example also sets the property to provide a larger sized form than the default size of the form. - -This example assumes that the `CreateMyOpaqueForm` method is called from another form in an event handler or other method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Opacity/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Opacity/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Opacity/VB/form1.vb" id="Snippet1"::: - + property enables you to specify a level of transparency for the form and its controls. When this property is set to a value less than 100 percent (1.00), the entire form, including borders, is made more transparent. Setting this property to a value of 0 percent (0.00) makes the form completely invisible. You can use this property to provide different levels of transparency or to provide effects such as phasing a form in or out of view. For example, you can phase a form into view by setting the property to a value of 0 percent (0.00) and gradually increasing the value until it reaches 100 percent (1.00). + + differs from the transparency provided by , which only makes a form and its controls completely transparent if they are the same color as the value specified in the property. + +This property is not supported when is `true`. + +The property depends on the Layered Windows API. For more information, see [Layered Windows](/windows/win32/winmsg/window-features#layered-windows). + +## Examples + +The following example demonstrates how to create a form that is displayed with an opacity level of 75 percent. It creates a new form that is positioned in the center of the screen with an property set to change the opacity level of the form. The example also sets the property to provide a larger sized form than the default size of the form. + +This example assumes that the `CreateMyOpaqueForm` method is called from another form in an event handler or other method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Opacity/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Opacity/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Opacity/VB/form1.vb" id="Snippet1"::: + ]]> @@ -5448,25 +5484,25 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets an array of objects that represent all forms that are owned by this form. A array that represents the owned forms for this form. - method. The form assigned to the owner form will remain owned until the method is called. You can also make a form owned by another by setting the property with a reference to its owner form. - - When a form is owned by another form, it is closed or hidden with the owner form. For example, consider a form named `Form2` that is owned by a form named `Form1`. If `Form1` is closed or minimized, `Form2` is also closed or hidden. Owned forms are also never displayed behind their owner form. You can use owned forms for windows such as find and replace windows, which should not be displayed behind the owner form when the owner form is selected. - -> [!NOTE] -> If the form is a multiple-document interface (MDI) parent form, this property will return all forms that are displayed with the exception of any MDI child forms that are currently open. To obtain the MDI child forms opened in an MDI parent form, use the property. - - - -## Examples - The following example demonstrates how to use the property to modify all forms owned by the owner form. The first method in the example adds forms to the array of owned forms associated with the owned form. The second method loops through all owned forms and changes the caption. This example requires that both methods are called by an event or other method of a form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.OwnedForms/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.OwnedForms/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.OwnedForms/VB/form1.vb" id="Snippet1"::: - + method. The form assigned to the owner form will remain owned until the method is called. You can also make a form owned by another by setting the property with a reference to its owner form. + + When a form is owned by another form, it is closed or hidden with the owner form. For example, consider a form named `Form2` that is owned by a form named `Form1`. If `Form1` is closed or minimized, `Form2` is also closed or hidden. Owned forms are also never displayed behind their owner form. You can use owned forms for windows such as find and replace windows, which should not be displayed behind the owner form when the owner form is selected. + +> [!NOTE] +> If the form is a multiple-document interface (MDI) parent form, this property will return all forms that are displayed with the exception of any MDI child forms that are currently open. To obtain the MDI child forms opened in an MDI parent form, use the property. + + + +## Examples + The following example demonstrates how to use the property to modify all forms owned by the owner form. The first method in the example adds forms to the array of owned forms associated with the owned form. The second method loops through all owned forms and changes the caption. This example requires that both methods are called by an event or other method of a form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.OwnedForms/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.OwnedForms/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.OwnedForms/VB/form1.vb" id="Snippet1"::: + ]]> @@ -5507,13 +5543,13 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets the form that owns this form. A that represents the form that is the owner of this form. - property a reference to the form that will be the owner. - - When a form is owned by another form, it is closed or hidden with the owner form. For example, consider a form named `Form2` that is owned by a form named `Form1`. If `Form1` is closed or minimized, `Form2` is also closed or hidden.Owned forms are also never displayed behind their owner form. You can use owned forms for windows such as find and replace windows, which should not disappear when the owner form is selected. To determine the forms that are owned by a parent form, use the property. - + property a reference to the form that will be the owner. + + When a form is owned by another form, it is closed or hidden with the owner form. For example, consider a form named `Form2` that is owned by a form named `Form1`. If `Form1` is closed or minimized, `Form2` is also closed or hidden.Owned forms are also never displayed behind their owner form. You can use owned forms for windows such as find and replace windows, which should not disappear when the owner form is selected. To determine the forms that are owned by a parent form, use the property. + ]]> A top-level window cannot have an owner. @@ -5552,13 +5588,13 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another if the keystroke was processed and consumed by the control; otherwise, to allow further processing. - method overrides the base implementation to provide additional handling of main menu command keys and MDI accelerators. - - For information about keyboard input, see [Keyboard Input in a Windows Forms Application](/dotnet/framework/winforms/keyboard-input-in-a-windows-forms-application). - + method overrides the base implementation to provide additional handling of main menu command keys and MDI accelerators. + + For information about keyboard input, see [Keyboard Input in a Windows Forms Application](/dotnet/framework/winforms/keyboard-input-in-a-windows-forms-application). + ]]> @@ -5632,11 +5668,11 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another if the keystroke was processed and consumed by the control; otherwise, to allow further processing. - method overrides the base implementation to provide additional handling of the RETURN and ESCAPE keys in dialog boxes. The method performs no processing on keystrokes that include the ALT or CONTROL modifiers. - + method overrides the base implementation to provide additional handling of the RETURN and ESCAPE keys in dialog boxes. The method performs no processing on keystrokes that include the ALT or CONTROL modifiers. + ]]> @@ -5763,11 +5799,11 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another A representing the form to remove from the list of owned forms for this form. Removes an owned form from this form. - method is called. In addition to removing the owned form from the list of owned form, this method also sets the owner form to `null`. - + method is called. In addition to removing the owned form from the list of owned form, this method also sets the owner form to `null`. + ]]> @@ -5796,34 +5832,34 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Occurs when a form enters resizing mode. - event is raised when the user begins to resize a form, typically by clicking and dragging one of the borders or the sizing grip located on the lower-right corner of the form. This action puts the form into a modal sizing loop until the resize operation is completed. Typically, the following set of events occurs during a resize operation: - -1. A single event occurs as the form enters resizing mode. - -2. Zero or more pairs of and events occur as the form's is modified. - -3. A single event occurs as the form exits resizing mode. - -> [!NOTE] -> Just clicking without dragging on a border or resizing grip will generate the and events without any intermediate and event pairs. - - The and pair of events is also raised when the user moves the form, typically by clicking and dragging on the caption bar. These events are not generated by programmatic manipulation of the form, for example by changing the or properties. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet404"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet404"::: - + event is raised when the user begins to resize a form, typically by clicking and dragging one of the borders or the sizing grip located on the lower-right corner of the form. This action puts the form into a modal sizing loop until the resize operation is completed. Typically, the following set of events occurs during a resize operation: + +1. A single event occurs as the form enters resizing mode. + +2. Zero or more pairs of and events occur as the form's is modified. + +3. A single event occurs as the form exits resizing mode. + +> [!NOTE] +> Just clicking without dragging on a border or resizing grip will generate the and events without any intermediate and event pairs. + + The and pair of events is also raised when the user moves the form, typically by clicking and dragging on the caption bar. These events are not generated by programmatic manipulation of the form, for example by changing the or properties. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet404"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet404"::: + ]]> @@ -5863,25 +5899,25 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Occurs when a form exits resizing mode. - event is raised when the user finishes resizing a form, typically by dragging one of the borders or the sizing grip located on the lower-right corner of the form, and then releasing it. For more information about the resizing operation, see the event. - - The event is also generated after the user moves a form, typically by clicking and dragging on the caption bar. This event is not generated by programmatic manipulation of the form, for example by changing the or properties. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet405"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet405"::: - + event is raised when the user finishes resizing a form, typically by dragging one of the borders or the sizing grip located on the lower-right corner of the form, and then releasing it. For more information about the resizing operation, see the event. + + The event is also generated after the user moves a form, typically by clicking and dragging on the caption bar. This event is not generated by programmatic manipulation of the form, for example by changing the or properties. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet405"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet405"::: + ]]> @@ -5932,14 +5968,14 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets the location and size of the form in its normal window state. A that contains the location and size of the form in the normal window state. - property to track the user's window size and position preferences for the form in its normal window state. You should track both the value of the and properties when tracking the user's window preferences. - -> [!NOTE] -> The value of the property is valid only when the property of the class is not equal to . - + property to track the user's window size and position preferences for the form in its normal window state. You should track both the value of the and properties when tracking the user's window preferences. + +> [!NOTE] +> The value of the property is valid only when the property of the class is not equal to . + ]]> @@ -5981,25 +6017,25 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another if right-to-left mirror placement is turned on; otherwise, for standard child control placement. The default is . - property is primarily useful for developing world-ready forms for worldwide audiences. Many forms are designed so that controls are laid out on a form in a left-to-right fashion. These forms are compatible with languages that follow this writing direction. However, when you display the same forms to users of right-to-left languages, it is often preferable to reverse the order of the controls on the form. If both the and properties are `true`, mirroring will be turned on for the form, and control placement and text flow will be right-to-left. - - Unlike , does not inherit. If you want it to take effect for child controls, you must set it on each child control that you want mirrored. - - Owner draw is not supported when is set to `Yes`. The owner draw events will still occur, but the behavior of any code you author in these events is not defined. Additionally, , , , and the painting events are not supported. - - The and properties cause the following Windows API window styles to be set: - -- When is set to `Yes` and is set to `true`, Windows Forms sets the `WS_EX_LAYOUTRTL` window style, and removes the `WS_EX_RIGHT` and `WS_EX_RTLREADING` styles. - -- When is set to `Yes` but is set to `No`, Windows Forms sets the `WS_EX_RIGHT` and `WS_EX_RTLREADING` window styles. - - Changing the value of this property raises the event. - - For more information about globalization issues, see [Best Practices for Developing World-Ready Applications](/dotnet/standard/globalization-localization/best-practices-for-developing-world-ready-apps). - + property is primarily useful for developing world-ready forms for worldwide audiences. Many forms are designed so that controls are laid out on a form in a left-to-right fashion. These forms are compatible with languages that follow this writing direction. However, when you display the same forms to users of right-to-left languages, it is often preferable to reverse the order of the controls on the form. If both the and properties are `true`, mirroring will be turned on for the form, and control placement and text flow will be right-to-left. + + Unlike , does not inherit. If you want it to take effect for child controls, you must set it on each child control that you want mirrored. + + Owner draw is not supported when is set to `Yes`. The owner draw events will still occur, but the behavior of any code you author in these events is not defined. Additionally, , , , and the painting events are not supported. + + The and properties cause the following Windows API window styles to be set: + +- When is set to `Yes` and is set to `true`, Windows Forms sets the `WS_EX_LAYOUTRTL` window style, and removes the `WS_EX_RIGHT` and `WS_EX_RTLREADING` styles. + +- When is set to `Yes` but is set to `No`, Windows Forms sets the `WS_EX_RIGHT` and `WS_EX_RTLREADING` window styles. + + Changing the value of this property raises the event. + + For more information about globalization issues, see [Best Practices for Developing World-Ready Applications](/dotnet/standard/globalization-localization/best-practices-for-developing-world-ready-apps). + ]]> @@ -6028,21 +6064,21 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Occurs after the value of the property changes. - and properties are typically used in developing World-Ready applications. - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet402"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet402"::: - + and properties are typically used in developing World-Ready applications. + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet402"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet402"::: + ]]> @@ -6267,20 +6303,20 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another The height of the form. Sets the bounds of the form in desktop coordinates. - method. To run this example, paste the following code in a form that contains a button named `Button2`. Ensure all events are associated with their event handlers. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormExample/VB/form1.vb" id="Snippet2"::: - + method. To run this example, paste the following code in a form that contains a button named `Button2`. Ensure all events are associated with their event handlers. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormExample/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormExample/VB/form1.vb" id="Snippet2"::: + ]]> @@ -6314,20 +6350,20 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another The y-coordinate of the form's location. Sets the location of the form in desktop coordinates. - method to position multiple-document interface (MDI) child forms. - - - -## Examples - The following example demonstrates how to use the , and members. To run the example, paste the following code in a form called `Form1` containing a button called `Button1` and two `Label` controls called `Label1` and `Label2`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: - + method to position multiple-document interface (MDI) child forms. + + + +## Examples + The following example demonstrates how to use the , and members. To run the example, paste the following code in a form called `Form1` containing a button called `Button1` and two `Label` controls called `Label1` and `Label2`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.FormsActivate/VB/form1.vb" id="Snippet1"::: + ]]> @@ -6395,35 +6431,35 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Any object that implements and represents the top-level window that will own this form. Shows the form with the specified owner to the user. - property of the form is set to `owner`. The non-modal form can use the property to get information about the owning form. Calling this method is identical to setting the property of the non-modal and then calling the method. - - Showing the form is equivalent to setting the property to `true`. After the method is called, the property returns a value of `true` until the method is called. - + property of the form is set to `owner`. The non-modal form can use the property to get information about the owning form. Calling this method is identical to setting the property of the non-modal and then calling the method. + + Showing the form is equivalent to setting the property to `true`. After the method is called, the property returns a value of `true` until the method is called. + ]]> - The form being shown is already visible. - - -or- - - The form specified in the parameter is the same as the form being shown. - - -or- - - The form being shown is disabled. - - -or- - - The form being shown is not a top-level window. - - -or- - - The form being shown as a dialog box is already a modal form. - - -or- - + The form being shown is already visible. + + -or- + + The form specified in the parameter is the same as the form being shown. + + -or- + + The form being shown is disabled. + + -or- + + The form being shown is not a top-level window. + + -or- + + The form being shown as a dialog box is already a modal form. + + -or- + The current process is not running in user interactive mode (for more information, see ). @@ -6472,42 +6508,42 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Shows the form as a modal dialog box. One of the values. - enumeration by assigning it to the property of a on the form or by setting the property of the form in code. This value is then returned by this method. You can use this return value to determine how to process the actions that occurred in the dialog box. For example, if the dialog box was closed and returned the `DialogResult.Cancel` value through this method, you could prevent code following the call to from executing. - - When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. Unlike non-modal forms, the method is not called by the .NET Framework when the user clicks the close form button of a dialog box or sets the value of the property. Instead the form is hidden and can be shown again without creating a new instance of the dialog box. Because a form displayed as a dialog box is hidden instead of closed, you must call the method of the form when the form is no longer needed by your application. - - This version of the method does not specify a form or control as its owner. When this version is called, the currently active window is made the owner of the dialog box. If you want to specify a specific owner, use the other version of this method. - - - -## Examples - The following example displays a form as a modal dialog box and evaluates the return value of the dialog box before determining whether to read the value of a control on the dialog box form. This example requires that a named `testDialog` is created and that it contains a control named `TextBox1`. Furthermore, the example requires that code in this example is contained and called from a different in order to display `testDialog` as a modal dialog box. The example uses the version of that specifies an owner for the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ShowDialog Example/VB/source.vb" id="Snippet1"::: - + enumeration by assigning it to the property of a on the form or by setting the property of the form in code. This value is then returned by this method. You can use this return value to determine how to process the actions that occurred in the dialog box. For example, if the dialog box was closed and returned the `DialogResult.Cancel` value through this method, you could prevent code following the call to from executing. + + When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. Unlike non-modal forms, the method is not called by the .NET Framework when the user clicks the close form button of a dialog box or sets the value of the property. Instead the form is hidden and can be shown again without creating a new instance of the dialog box. Because a form displayed as a dialog box is hidden instead of closed, you must call the method of the form when the form is no longer needed by your application. + + This version of the method does not specify a form or control as its owner. When this version is called, the currently active window is made the owner of the dialog box. If you want to specify a specific owner, use the other version of this method. + + + +## Examples + The following example displays a form as a modal dialog box and evaluates the return value of the dialog box before determining whether to read the value of a control on the dialog box form. This example requires that a named `testDialog` is created and that it contains a control named `TextBox1`. Furthermore, the example requires that code in this example is contained and called from a different in order to display `testDialog` as a modal dialog box. The example uses the version of that specifies an owner for the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ShowDialog Example/VB/source.vb" id="Snippet1"::: + ]]> - The form being shown is already visible. - - -or- - - The form being shown is disabled. - - -or- - - The form being shown is not a top-level window. - - -or- - - The form being shown as a dialog box is already a modal form. - - -or- - + The form being shown is already visible. + + -or- + + The form being shown is disabled. + + -or- + + The form being shown is not a top-level window. + + -or- + + The form being shown as a dialog box is already a modal form. + + -or- + The current process is not running in user interactive mode (for more information, see ). @@ -6539,43 +6575,43 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Shows the form as a modal dialog box with the specified owner. One of the values. - by assigning it to the property of a on the form or by setting the property of the form in code. This value is then returned by this method. You can use this return value to determine how to process the actions that occurred in the dialog box. For example, if the dialog box was closed and returned the `DialogResult.Cancel` value through this method, you could prevent code following the call to from executing. - - When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. Unlike modeless forms, the method is not called by the .NET Framework when the user clicks the close form button of a dialog box or sets the value of the property. Instead the form is hidden and can be shown again without creating a new instance of the dialog box. Because a form displayed as a dialog box is hidden instead of closed, you must call the method of the form when the form is no longer needed by your application. - - This version of the method allows you to specify a specific form that will own the dialog box that is shown. - - - -## Examples - The following example displays a form as a modal dialog box and evaluates the return value of the dialog box before determining whether to read the value of a control on the dialog box form. This example requires that a named `Form2` is created and that it contains a control named `TextBox1`. The example uses the version of that specifies an owner for the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ShowDialog Example/VB/source.vb" id="Snippet1"::: - + by assigning it to the property of a on the form or by setting the property of the form in code. This value is then returned by this method. You can use this return value to determine how to process the actions that occurred in the dialog box. For example, if the dialog box was closed and returned the `DialogResult.Cancel` value through this method, you could prevent code following the call to from executing. + + When a form is displayed as a modal dialog box, clicking the **Close** button (the button with an X at the upper-right corner of the form) causes the form to be hidden and the property to be set to `DialogResult.Cancel`. Unlike modeless forms, the method is not called by the .NET Framework when the user clicks the close form button of a dialog box or sets the value of the property. Instead the form is hidden and can be shown again without creating a new instance of the dialog box. Because a form displayed as a dialog box is hidden instead of closed, you must call the method of the form when the form is no longer needed by your application. + + This version of the method allows you to specify a specific form that will own the dialog box that is shown. + + + +## Examples + The following example displays a form as a modal dialog box and evaluates the return value of the dialog box before determining whether to read the value of a control on the dialog box form. This example requires that a named `Form2` is created and that it contains a control named `TextBox1`. The example uses the version of that specifies an owner for the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.ShowDialog Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.ShowDialog Example/VB/source.vb" id="Snippet1"::: + ]]> The form specified in the parameter is the same as the form being shown. - The form being shown is already visible. - - -or- - - The form being shown is disabled. - - -or- - - The form being shown is not a top-level window. - - -or- - - The form being shown as a dialog box is already a modal form. - - -or- - + The form being shown is already visible. + + -or- + + The form being shown is disabled. + + -or- + + The form being shown is not a top-level window. + + -or- + + The form being shown as a dialog box is already a modal form. + + -or- + The current process is not running in user interactive mode (for more information, see ). @@ -6609,15 +6645,15 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another if the form displays an icon in the caption bar; otherwise, . The default is . - property contains a value that indicates whether the form's is displayed in the caption bar of the form. If the property is `false`, both the icon and control box will be suppressed. - - If is `false` when the primary form is shown, a generic icon will be displayed in the taskbar button for the application. - - This property has no effect if is set to . In that case, the form does not display an icon. - + property contains a value that indicates whether the form's is displayed in the caption bar of the form. If the property is `false`, both the icon and control box will be suppressed. + + If is `false` when the primary form is shown, a generic icon will be displayed in the taskbar button for the application. + + This property has no effect if is set to . In that case, the form does not display an icon. + ]]> @@ -6656,24 +6692,24 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another to display the form in the Windows taskbar at run time; otherwise, . The default is . - style. Setting the style does not alone guarantee that a window will not appear in the taskbar. - - - -## Examples - The following example demonstrates how to use the property to make a dialog box that is not displayed in the Windows taskbar. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.ShowInTaskbar/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.ShowInTaskbar/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.ShowInTaskbar/VB/form1.vb" id="Snippet1"::: - + style. Setting the style does not alone guarantee that a window will not appear in the taskbar. + + + +## Examples + The following example demonstrates how to use the property to make a dialog box that is not displayed in the Windows taskbar. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.ShowInTaskbar/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.ShowInTaskbar/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.ShowInTaskbar/VB/form1.vb" id="Snippet1"::: + ]]> @@ -6699,23 +6735,23 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Occurs whenever the form is first displayed. - event is only raised the first time a form is displayed; subsequently minimizing, maximizing, restoring, hiding, showing, or invalidating and repainting will not raise this event. For more information about the order of events of a form, see [Order of Events in Windows Forms](/dotnet/framework/winforms/order-of-events-in-windows-forms). - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet403"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet403"::: - + event is only raised the first time a form is displayed; subsequently minimizing, maximizing, restoring, hiding, showing, or invalidating and repainting will not raise this event. For more information about the order of events of a form, see [Order of Events in Windows Forms](/dotnet/framework/winforms/order-of-events-in-windows-forms). + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `Form1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet403"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet403"::: + ]]> @@ -6760,15 +6796,15 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another if the window will not be activated when it is shown; otherwise, . The default is . - in your own form, and programming it to return `true`. - - If your non-activated window needs to use UI controls, you should consider using the controls, such as . These controls are windowless, and will not cause a window to activate when they are selected. - + in your own form, and programming it to return `true`. + + If your non-activated window needs to use UI controls, you should consider using the controls, such as . These controls are windowless, and will not cause a window to activate when they are selected. + ]]> @@ -6807,26 +6843,26 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets the size of the form. A that represents the size of the form. - and properties individually. If you want to set the size and location of a form, you can use the property to size and locate the form based on desktop coordinates or use the property of the class to set the size and location of the form based on screen coordinates. - -> [!NOTE] -> The maximum value of this property is limited by the resolution of the screen on which the form runs. The value cannot be greater than 12 pixels over each screen dimension (horizontal + 12 and vertical + 12). - -> [!NOTE] -> On Pocket PC devices, you can create a resizable window by setting to `None` and removing any control. On SmartPhone devices, you can never resize a - it will always fill the entire screen. - - - -## Examples - The following example demonstrates how to create a form that is displayed with an opacity level of 75 percent. The example code creates a new form that is positioned in the center of the screen with an property set to change the opacity level of the form. The example code also sets the property to provide a larger sized form than the default size of the form. This example requires that the method defined in this example is called from another form in an event handler or other method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Opacity/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Opacity/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Opacity/VB/form1.vb" id="Snippet1"::: - + and properties individually. If you want to set the size and location of a form, you can use the property to size and locate the form based on desktop coordinates or use the property of the class to set the size and location of the form based on screen coordinates. + +> [!NOTE] +> The maximum value of this property is limited by the resolution of the screen on which the form runs. The value cannot be greater than 12 pixels over each screen dimension (horizontal + 12 and vertical + 12). + +> [!NOTE] +> On Pocket PC devices, you can create a resizable window by setting to `None` and removing any control. On SmartPhone devices, you can never resize a - it will always fill the entire screen. + + + +## Examples + The following example demonstrates how to create a form that is displayed with an opacity level of 75 percent. The example code creates a new form that is positioned in the center of the screen with an property set to change the opacity level of the form. The example code also sets the property to provide a larger sized form than the default size of the form. This example requires that the method defined in this example is called from another form in an event handler or other method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Opacity/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Opacity/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Opacity/VB/form1.vb" id="Snippet1"::: + ]]> @@ -6864,20 +6900,20 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets the style of the size grip to display in the lower-right corner of the form. A that represents the style of the size grip to display. The default is - property. - - - -## Examples - The following example demonstrates how to hide the size grip for a when the is not resizable. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.SizeGripStyle/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.SizeGripStyle/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.SizeGripStyle/VB/form1.vb" id="Snippet1"::: - + property. + + + +## Examples + The following example demonstrates how to hide the size grip for a when the is not resizable. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.SizeGripStyle/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.SizeGripStyle/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.SizeGripStyle/VB/form1.vb" id="Snippet1"::: + ]]> The value specified is outside the range of valid values. @@ -6918,22 +6954,22 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets the starting position of the form at run time. A that represents the starting position of the form. - property or use the default location specified by Windows. You can also position the form to display in the center of the screen or in the center of its parent form for forms such as multiple-document interface (MDI) child forms. - - This property should be set before the form is shown. You can set this property before you call the or method or in your form's constructor. - - - -## Examples - The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.StartPosition Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.StartPosition Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.StartPosition Example/VB/source.vb" id="Snippet1"::: - + property or use the default location specified by Windows. You can also position the form to display in the center of the screen or in the center of its parent form for forms such as multiple-document interface (MDI) child forms. + + This property should be set before the form is shown. You can set this property before you call the or method or in your form's constructor. + + + +## Examples + The following example creates a new instance of a and calls the method to display the form as a dialog box. The example sets the , , , and properties to change the appearance and functionality of the form to a dialog box. The example also uses the method of the form's collection to add two controls. The example uses the property to display a help button in the caption bar of the dialog box. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.StartPosition Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.StartPosition Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.StartPosition Example/VB/source.vb" id="Snippet1"::: + ]]> The value specified is outside the range of valid values. @@ -6977,11 +7013,11 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets the tab order of the control within its container. An containing the index of the control within the set of controls within its container that is included in the tab order. - property does nothing. - + property does nothing. + ]]> @@ -7165,20 +7201,20 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another to display the form as a top-level window; otherwise, . The default is . - property to determine if a form is displayed as a modal form. If it is not the and properties are changed to make the form non-top-level form with a tool window border. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Modal/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Modal/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Modal/VB/form1.vb" id="Snippet1"::: - + property to determine if a form is displayed as a modal form. If it is not the and properties are changed to make the form non-top-level form with a tool window border. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.Modal/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.Modal/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.Modal/VB/form1.vb" id="Snippet1"::: + ]]> A Multiple-document interface (MDI) parent form must be a top-level window. @@ -7215,20 +7251,20 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another to display the form as a topmost form; otherwise, . The default is . - property, to better demonstrate the abilities of the topmost form. The second form, named `topMostForm`, sets the property to `true` to display the form as a topmost form. When this code is run, clicking on the maximized form will not cause the topmost form to be displayed below the maximized form. The example requires that the method defined in the example is called from another form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.TopMost/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.TopMost/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.TopMost/VB/form1.vb" id="Snippet1"::: - + property, to better demonstrate the abilities of the topmost form. The second form, named `topMostForm`, sets the property to `true` to display the form as a topmost form. When this code is run, clicking on the maximized form will not cause the topmost form to be displayed below the maximized form. The example requires that the method defined in the example is called from another form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Form.TopMost/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Form.TopMost/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Form.TopMost/VB/form1.vb" id="Snippet1"::: + ]]> @@ -7283,22 +7319,22 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets the color that will represent transparent areas of the form. A that represents the color to display transparently on the form. - property is assigned a , the areas of the form that have the same will be displayed transparently. Any mouse actions, such as the click of the mouse, that are performed on the transparent areas of the form will be transferred to the windows below the transparent area. For example, if the client region of a form is made transparent, clicking the mouse on that area would send the event notification of the click to any window that is below it. If the color assigned to the property is the same as any controls on the form, they also will be displayed transparently. For example, if you have a control on a form that has its property set to `SystemColors.Control`, the control will be displayed transparently unless the property of the control is changed to a different color. - - This property is not supported when is `true`. - - - -## Examples - The following example creates a window that has a transparent client region regardless of background color of the form. This example requires that the example method is defined within a form class. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.TransparencyKey Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.TransparencyKey Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.TransparencyKey Example/VB/source.vb" id="Snippet1"::: - + property is assigned a , the areas of the form that have the same will be displayed transparently. Any mouse actions, such as the click of the mouse, that are performed on the transparent areas of the form will be transferred to the windows below the transparent area. For example, if the client region of a form is made transparent, clicking the mouse on that area would send the event notification of the click to any window that is below it. If the color assigned to the property is the same as any controls on the form, they also will be displayed transparently. For example, if you have a control on a form that has its property set to `SystemColors.Control`, the control will be displayed transparently unless the property of the control is changed to a different color. + + This property is not supported when is `true`. + + + +## Examples + The following example creates a window that has a transparent client region regardless of background color of the form. This example requires that the example method is defined within a form class. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic Form.TransparencyKey Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic Form.TransparencyKey Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic Form.TransparencyKey Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -7326,15 +7362,15 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Updates which button is the default button. - method determines which button on the form raises its Click event when the user presses ENTER, according to the following priority: - -1. If the property implements the interface, that control is the default button. - -2. The property is the default button. - + method determines which button on the form raises its Click event when the user presses ENTER, according to the following priority: + +1. If the property implements the interface, that control is the default button. + +2. The property is the default button. + ]]> @@ -7456,29 +7492,29 @@ This example assumes that the `CreateMyOpaqueForm` method is called from another Gets or sets a value that indicates whether form is minimized, maximized, or normal. A that represents whether form is minimized, maximized, or normal. The default is . - property is always set to `FormWindowState.Normal`, regardless of its initial setting. This is reflected in the , , , and property settings. If a form is hidden after it has been shown, these properties reflect the previous state until the form is shown again, regardless of any changes made to the property. - - - -## Examples - The following example demonstrates how to set the to maximized. The code is called from the event handler after the form has been created. - -```csharp -private void Form1_Shown(object sender, EventArgs e) -        { -            this.WindowState = System.Windows.Forms.FormWindowState.Maximized; -        } -``` - -```vb -Private Sub Form1_Shown(ByVal sender As Object, ByVal e As EventArgs) - Me.WindowState = System.Windows.Forms.FormWindowState.Maximized -End Sub -``` - + property is always set to `FormWindowState.Normal`, regardless of its initial setting. This is reflected in the , , , and property settings. If a form is hidden after it has been shown, these properties reflect the previous state until the form is shown again, regardless of any changes made to the property. + + + +## Examples + The following example demonstrates how to set the to maximized. The code is called from the event handler after the form has been created. + +```csharp +private void Form1_Shown(object sender, EventArgs e) +        { +            this.WindowState = System.Windows.Forms.FormWindowState.Maximized; +        } +``` + +```vb +Private Sub Form1_Shown(ByVal sender As Object, ByVal e As EventArgs) + Me.WindowState = System.Windows.Forms.FormWindowState.Maximized +End Sub +``` + ]]> The value specified is outside the range of valid values. diff --git a/xml/System.Windows.Forms/LinkClickedEventArgs.xml b/xml/System.Windows.Forms/LinkClickedEventArgs.xml index 2d11b61e44e..c654a3cbbf5 100644 --- a/xml/System.Windows.Forms/LinkClickedEventArgs.xml +++ b/xml/System.Windows.Forms/LinkClickedEventArgs.xml @@ -26,21 +26,21 @@ Provides data for the event. - specifies the text of the link that is clicked in the . - - - -## Examples - The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `RichTextBox1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet541"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet541"::: - + specifies the text of the link that is clicked in the . + + + +## Examples + The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `RichTextBox1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet541"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet541"::: + ]]> @@ -77,11 +77,11 @@ The text of the link that is clicked in the control. Initializes a new instance of the class. - @@ -104,11 +104,16 @@ - To be added. - To be added. - To be added. - To be added. + The text of the link being clicked. + The start of the link span being clicked. + The length of the link span being clicked. + Initializes a new instance of the class. To be added. + The value for or is negative. + +-or- + +The values for and would overflow addition. @@ -127,7 +132,7 @@ System.Int32 - To be added. + Gets the length of the link span being clicked. To be added. To be added. @@ -148,7 +153,7 @@ System.Int32 - To be added. + Gets the start of the link span being clicked. To be added. To be added. @@ -183,21 +188,21 @@ Gets the text of the link being clicked. The text of the link that is clicked in the control. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `RichTextBox1`. Then ensure that the event handler is associated with the event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet541"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet541"::: - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `RichTextBox1`. Then ensure that the event handler is associated with the event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs" id="Snippet541"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet541"::: + ]]> diff --git a/xml/System.Windows.Forms/ListBox+ObjectCollection.xml b/xml/System.Windows.Forms/ListBox+ObjectCollection.xml index 3704c2f4355..427d1baa6ab 100644 --- a/xml/System.Windows.Forms/ListBox+ObjectCollection.xml +++ b/xml/System.Windows.Forms/ListBox+ObjectCollection.xml @@ -1,1140 +1,1140 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.Collections.ICollection - - - System.Collections.IEnumerable - - - System.Collections.IList - - - - - [System.ComponentModel.ListBindable(false)] - [<System.ComponentModel.ListBindable(false)>] - - - - Represents the collection of items in a . - - class stores the items displayed in the . There are two other collections defined within the class that enable you to determine what items are selected within this collection. The class provides properties and methods for determining what items are selected within the , while the class enables you to determine what indexes within the are selected. - - There are a number of ways to add items to the collection. The method provides the ability to add a single object to the collection. To add a number of objects to the collection, you create an array of items and assign it to the method. If you want to insert an object at a specific location within the collection, you can use the method. To remove items, you can use either the method or the method if you know where the item is located within the collection. The method enables you to remove all items from the collection instead of using the method to remove a single item at a time. - - You can also manipulate the items of a by using the property. If you use the property to add items to a , you can view the items in the using the property but you cannot add or remove items from the list using the methods of the . - - In addition to methods and properties for adding and removing items, the also provides methods to find items within the collection. The method enables you to determine whether an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. - - - -## Examples - The following code example demonstrates an owner-drawn by setting the property to the `OwnerDrawVariable` value and handling the and events. It also demonstrates setting the and properties and using the method. - - To run this example, paste it into an empty form that imports the namespace and the namespace. Call `InitializeOwnerDrawnListBox` from the form's constructor or `Load` method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/VB/form1.vb" id="Snippet1"::: - - ]]> - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Initializes a new instance of . - - - - - - - - - - Constructor - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - - - - The that owns the collection. - Initializes a new instance of . - - control. - - ]]> - - .NET 5.0 and later: is . - - - - - - - - - - Constructor - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The that owns the collection. - An array of objects to add to the collection. - Initializes a new instance of containing an array of objects. - - control. - - ]]> - - .NET 5.0 and later: Either or is . - - - - - - - - - - Constructor - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The that owns the collection. - A from which the contents are copied to this collection. - Initializes a new instance of based on another . - - control. This version of the constructor enables you to use the items specified in an existing instance of the class to add items to the collection when it is created. You can use this constructor to use the items specified in another control with this collection. - - ]]> - - .NET 5.0 and later: Either or is . - - - - - - - - - - Method - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - An object representing the item to add to the collection. - Adds an item to the list of items for a . - The zero-based index of the item in the collection, or -1 if has been called. - - property of the is set to `true`, the item is inserted into the list alphabetically. Otherwise, the item is inserted at the end of the list. To insert an item into the list box at a specific position, use the method. To add a set of items to the list box in a single operation, use the method. If you want to use the method to add a large number of items to the list, use the and methods to prevent the from repainting each time an item is added to the list until all items are added to the list. When adding items to a , it is more efficient to sort the items first and then add new items. - - When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. - -## Examples - The following code example demonstrates how to create a control that displays multiple items in columns and can have more than one item selected in the control's list. The code for the example adds 50 items to the using the method of the class and then selects three items from the list using the method. The code then displays values from the collection (through the property) and the (through the property). This example requires that the code is located in and called from a . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic ListBox Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic ListBox Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic ListBox Example/VB/source.vb" id="Snippet1"::: - - ]]> - - There is insufficient space available to add the new item to the list. - - is . - - - - - System.Windows.Forms - 4.0.0.0 - - - Adds a group of items to the list of items for a . - - - - - - - - - - Method - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An array of objects to add to the list. - Adds an array of items to the list of items for a . - - property of the is set to `true`, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order that they occur within the array. This method is typically passed an array of objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. When using this method to add items to the , you do not need to call the and methods to optimize performance. When adding items to a , it is more efficient to sort the items first and then add new items. You can use this method to add a group of items to the list or to reuse the items stored in a different . - -## Examples - The following code example demonstrates an owner-drawn by setting the property to the `OwnerDrawVariable` value and handling the and events. It also demonstrates setting the and properties and using the method. - - To run this example, paste it into an empty form that imports the namespace and the namespace. Call `InitializeOwnerDrawnListBox` from the form's constructor or `Load` method. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/VB/form1.vb" id="Snippet1"::: - - ]]> - - .NET 5.0 and later: is . - - - - - - - - - - - Method - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A to load into this collection. - Adds the items of an existing to the list of items in a . - - property of the is set to `true`, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order that they occur within the array. This method is typically passed an array of objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. - - When using this method to add items to the , you do not need to call the and methods to optimize performance. When adding items to a , it is more efficient to sort the items first and then add new items. You can use this method to reuse the items stored in a different . - - ]]> - - .NET 5.0 and later: is . - - - - - - - - - - - Method - - M:System.Collections.IList.Clear - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Removes all items from the collection. - - , use the or method. - - ]]> - - - - - - - - - - - - - - Method - - M:System.Collections.IList.Contains(System.Object) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - An object representing the item to locate in the collection. - Determines whether the specified item is located within the collection. - - if the item is located within the collection; otherwise, . - - method enables you to determine whether an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. - - ]]> - - - is . - - - - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - - The object array to which the items from the collection are copied. - The object array to which the items from the collection are copied. - The location within the destination array to copy the items from the collection to. - Copies the entire collection into an existing array of objects at a specified location within the array. - - control using the method of the class. - - ]]> - - .NET 5.0 and later: is . - - - - - - - - - - Property - - P:System.Collections.ICollection.Count - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - Gets the number of items in the collection. - The number of items in the collection. - - . You can then use this value when you are looping through the values of the collection and you need to provide a number of iterations to perform the loop. - - ]]> - - - - - - - - - - - Method - - M:System.Collections.IEnumerable.GetEnumerator - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.IEnumerator - - - - Returns an enumerator to use to iterate through the item collection. - An that represents the item collection. - To be added. - - - - - - - - - - - - - Method - - M:System.Collections.IList.IndexOf(System.Object) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - An object representing the item to locate in the collection. - Returns the index within the collection of the specified item. - The zero-based index where the item is located within the collection; otherwise, negative one (-1). - - method enables you to determine where an item is located within the collection. To determine whether an item is located within the collection before calling this method, use the method. - - ]]> - - The parameter is null. - - - - - - - - - - - - - - Method - - M:System.Collections.IList.Insert(System.Int32,System.Object) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The zero-based index location where the item is inserted. - An object representing the item to insert. - Inserts an item into the list box at the specified index. - - . If the property of the is set to true, the item is added in the correct position within the sorted list regardless of the values specified in the `index` parameter. When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. - - ]]> - - The parameter is less than zero or greater than value of the property of the class. - - is . - - - - - - - - - - Property - - P:System.Collections.IList.IsReadOnly - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the collection is read-only. - - if this collection is read-only; otherwise, . - - - - - - - - - - - - - Property - - P:System.Collections.IList.Item(System.Int32) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] - - - - System.Object - - - - - - The index of the item in the collection to get or set. - Gets or sets the item at the specified index within the collection. - An object representing the item located at the specified index within the collection. - - item stored at a specific location within the collection. To determine the index of a specific item within the collection, use the method. - - ]]> - - The parameter is less than zero or greater than or equal to the value of the property of the class. - - - - - - - - - - - - - Method - - M:System.Collections.IList.Remove(System.Object) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An object representing the item to remove from the collection. - Removes the specified object from the collection. - - method. To remove all items from the list, use the method. - - ]]> - - - - - - - - - - - - - Method - - M:System.Collections.IList.RemoveAt(System.Int32) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The zero-based index of the item to remove. - Removes the item at the specified index within the collection. - - method. To remove all items from the list, use the method. - - - -## Examples - The following code example demonstrates how to use the property with the property to move the currently selected item to the top of the list of items in the display area of the . The example further demonstrates how to remove items using the method of the class, and how to clear all item selection using the method. The code first moves the currently selected item in the to the top of the list. The code then removes all items before the currently selected item and clears all selections in the . This example requires that a containing items is added to a form and that an item is currently selected in the . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/ListBox.SelectedIndex/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/ListBox.SelectedIndex/CS/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/ListBox.SelectedIndex/VB/form1.vb" id="Snippet1"::: - - ]]> - - The parameter is less than zero or greater than or equal to the value of the property of the class. - - - - - - - - - - - - - - - - - Method - - M:System.Collections.ICollection.CopyTo(System.Array,System.Int32) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - - The one-dimensional array that is the destination of the elements copied from . The array must have zero-based indexing. - The one-dimensional array that is the destination of the elements copied from . The array must have zero-based indexing. - The zero-based index in the array at which copying begins. - Copies the elements of the collection to an array, starting at a particular array index. - - instance is cast to an interface. - - ]]> - - - The array type is not compatible with the items in the . - .NET 5.0 and later: is . - - - - - - - - - - Property - - P:System.Collections.ICollection.IsSynchronized - - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - For a description of this member, see . - - in all cases. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Property - - P:System.Collections.ICollection.SyncRoot - - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - For a description of this member, see . - An object that can be used to synchronize access to the . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - - Method - - M:System.Collections.IList.Add(System.Object) - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Int32 - - - - - - The object to be added to the . - Adds an object to the class. - The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. - - instance is cast to an interface. - - ]]> - - - - is . - The current has a data source. - There is insufficient space available to store the new item. - - - - - - - - - - Method - - M:System.Collections.IList.Contains(System.Object) - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The object to locate in the . - Determines whether the contains a specific value. - - if the is found in the ; otherwise, . - To be added. - - - - - - - - - - Method - - M:System.Collections.IList.IndexOf(System.Object) - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - The object to locate in the . - Determines the index of a specific item in the . - The index of if found in the list; otherwise, -1. - To be added. - - - - - - - - - - Method - - M:System.Collections.IList.Insert(System.Int32,System.Object) - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The zero-based index at which should be inserted. - To be added. - Inserts an item to the at the specified index. - To be added. - - - - - - - - - - Property - - P:System.Collections.IList.IsFixedSize - - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - For a description of this member, see . - - in all cases. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Property - - P:System.Collections.IList.Item(System.Int32) - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - The zero-based index of the element to get or set. - Gets or sets the element at the specified index. - To be added. - To be added. - - - - - - - - - - Method - - M:System.Collections.IList.Remove(System.Object) - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The object to remove from the . - Removes the first occurrence of a specific object from the . - To be added. - - - - + + + + + + + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.Collections.ICollection + + + System.Collections.IEnumerable + + + System.Collections.IList + + + + + [System.ComponentModel.ListBindable(false)] + [<System.ComponentModel.ListBindable(false)>] + + + + Represents the collection of items in a . + + class stores the items displayed in the . There are two other collections defined within the class that enable you to determine what items are selected within this collection. The class provides properties and methods for determining what items are selected within the , while the class enables you to determine what indexes within the are selected. + + There are a number of ways to add items to the collection. The method provides the ability to add a single object to the collection. To add a number of objects to the collection, you create an array of items and assign it to the method. If you want to insert an object at a specific location within the collection, you can use the method. To remove items, you can use either the method or the method if you know where the item is located within the collection. The method enables you to remove all items from the collection instead of using the method to remove a single item at a time. + + You can also manipulate the items of a by using the property. If you use the property to add items to a , you can view the items in the using the property but you cannot add or remove items from the list using the methods of the . + + In addition to methods and properties for adding and removing items, the also provides methods to find items within the collection. The method enables you to determine whether an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. + + + +## Examples + The following code example demonstrates an owner-drawn by setting the property to the `OwnerDrawVariable` value and handling the and events. It also demonstrates setting the and properties and using the method. + + To run this example, paste it into an empty form that imports the namespace and the namespace. Call `InitializeOwnerDrawnListBox` from the form's constructor or `Load` method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/VB/form1.vb" id="Snippet1"::: + + ]]> + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Initializes a new instance of . + + + + + + + + + + Constructor + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + + + + The that owns the collection. + Initializes a new instance of . + + control. + + ]]> + + .NET 5.0 and later: is . + + + + + + + + + + Constructor + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The that owns the collection. + An array of objects to add to the collection. + Initializes a new instance of containing an array of objects. + + control. + + ]]> + + .NET 5.0 and later: Either or is . + + + + + + + + + + Constructor + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The that owns the collection. + A from which the contents are copied to this collection. + Initializes a new instance of based on another . + + control. This version of the constructor enables you to use the items specified in an existing instance of the class to add items to the collection when it is created. You can use this constructor to use the items specified in another control with this collection. + + ]]> + + .NET 5.0 and later: Either or is . + + + + + + + + + + Method + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + An object representing the item to add to the collection. + Adds an item to the list of items for a . + The zero-based index of the item in the collection, or -1 if has been called. + + property of the is set to `true`, the item is inserted into the list alphabetically. Otherwise, the item is inserted at the end of the list. To insert an item into the list box at a specific position, use the method. To add a set of items to the list box in a single operation, use the method. If you want to use the method to add a large number of items to the list, use the and methods to prevent the from repainting each time an item is added to the list until all items are added to the list. When adding items to a , it is more efficient to sort the items first and then add new items. + + When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. + +## Examples + The following code example demonstrates how to create a control that displays multiple items in columns and can have more than one item selected in the control's list. The code for the example adds 50 items to the using the method of the class and then selects three items from the list using the method. The code then displays values from the collection (through the property) and the (through the property). This example requires that the code is located in and called from a . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic ListBox Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic ListBox Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic ListBox Example/VB/source.vb" id="Snippet1"::: + + ]]> + + There is insufficient space available to add the new item to the list. + + is . + + + + + System.Windows.Forms + 4.0.0.0 + + + Adds a group of items to the list of items for a . + + + + + + + + + + Method + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An array of objects to add to the list. + Adds an array of items to the list of items for a . + + property of the is set to `true`, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order that they occur within the array. This method is typically passed an array of objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. When using this method to add items to the , you do not need to call the and methods to optimize performance. When adding items to a , it is more efficient to sort the items first and then add new items. You can use this method to add a group of items to the list or to reuse the items stored in a different . + +## Examples + The following code example demonstrates an owner-drawn by setting the property to the `OwnerDrawVariable` value and handling the and events. It also demonstrates setting the and properties and using the method. + + To run this example, paste it into an empty form that imports the namespace and the namespace. Call `InitializeOwnerDrawnListBox` from the form's constructor or `Load` method. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ListBoxExample/VB/form1.vb" id="Snippet1"::: + + ]]> + + .NET 5.0 and later: is . + + + + + + + + + + + Method + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A to load into this collection. + Adds the items of an existing to the list of items in a . + + property of the is set to `true`, the items are inserted into the list alphabetically. Otherwise, the items are inserted in the order that they occur within the array. This method is typically passed an array of objects, but an array of any type of object can be passed to this method. When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. + + When using this method to add items to the , you do not need to call the and methods to optimize performance. When adding items to a , it is more efficient to sort the items first and then add new items. You can use this method to reuse the items stored in a different . + + ]]> + + .NET 5.0 and later: is . + + + + + + + + + + + Method + + M:System.Collections.IList.Clear + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Removes all items from the collection. + + , use the or method. + + ]]> + + + + + + + + + + + + + + Method + + M:System.Collections.IList.Contains(System.Object) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + An object representing the item to locate in the collection. + Determines whether the specified item is located within the collection. + + if the item is located within the collection; otherwise, . + + method enables you to determine whether an object is a member of the collection. Once you know that the item is located within the collection, you can use the method to determine where the item is located within the collection. + + ]]> + + + is . + + + + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + + The object array to which the items from the collection are copied. + The object array to which the items from the collection are copied. + The location within the destination array to copy the items from the collection to. + Copies the entire collection into an existing array of objects at a specified location within the array. + + control using the method of the class. + + ]]> + + .NET 5.0 and later: is . + + + + + + + + + + Property + + P:System.Collections.ICollection.Count + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + Gets the number of items in the collection. + The number of items in the collection. + + . You can then use this value when you are looping through the values of the collection and you need to provide a number of iterations to perform the loop. + + ]]> + + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.IEnumerator + + + + Returns an enumerator to use to iterate through the item collection. + An that represents the item collection. + To be added. + + + + + + + + + + + + + Method + + M:System.Collections.IList.IndexOf(System.Object) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + An object representing the item to locate in the collection. + Returns the index within the collection of the specified item. + The zero-based index where the item is located within the collection; otherwise, negative one (-1). + + method enables you to determine where an item is located within the collection. To determine whether an item is located within the collection before calling this method, use the method. + + ]]> + + The parameter is null. + + + + + + + + + + + + + + Method + + M:System.Collections.IList.Insert(System.Int32,System.Object) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The zero-based index location where the item is inserted. + An object representing the item to insert. + Inserts an item into the list box at the specified index. + + . If the property of the is set to true, the item is added in the correct position within the sorted list regardless of the values specified in the `index` parameter. When an object is added to the collection, the first checks to see if the property of the class has the name of a member from the object specified to reference when obtaining the item text. If the property does not have a member specified, the then calls the method of the object to obtain the text to display in the list. + + ]]> + + The parameter is less than zero or greater than value of the property of the class. + + is . + + + + + + + + + + Property + + P:System.Collections.IList.IsReadOnly + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the collection is read-only. + + if this collection is read-only; otherwise, . + + + + + + + + + + + + + Property + + P:System.Collections.IList.Item(System.Int32) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] + + + + System.Object + + + + + + The index of the item in the collection to get or set. + Gets or sets the item at the specified index within the collection. + An object representing the item located at the specified index within the collection. + + item stored at a specific location within the collection. To determine the index of a specific item within the collection, use the method. + + ]]> + + The parameter is less than zero or greater than or equal to the value of the property of the class. + + + + + + + + + + + + + Method + + M:System.Collections.IList.Remove(System.Object) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An object representing the item to remove from the collection. + Removes the specified object from the collection. + + method. To remove all items from the list, use the method. + + ]]> + + + + + + + + + + + + + Method + + M:System.Collections.IList.RemoveAt(System.Int32) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The zero-based index of the item to remove. + Removes the item at the specified index within the collection. + + method. To remove all items from the list, use the method. + + + +## Examples + The following code example demonstrates how to use the property with the property to move the currently selected item to the top of the list of items in the display area of the . The example further demonstrates how to remove items using the method of the class, and how to clear all item selection using the method. The code first moves the currently selected item in the to the top of the list. The code then removes all items before the currently selected item and clears all selections in the . This example requires that a containing items is added to a form and that an item is currently selected in the . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/ListBox.SelectedIndex/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/ListBox.SelectedIndex/CS/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/ListBox.SelectedIndex/VB/form1.vb" id="Snippet1"::: + + ]]> + + The parameter is less than zero or greater than or equal to the value of the property of the class. + + + + + + + + + + + + + + + + + Method + + M:System.Collections.ICollection.CopyTo(System.Array,System.Int32) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + + The one-dimensional array that is the destination of the elements copied from . The array must have zero-based indexing. + The one-dimensional array that is the destination of the elements copied from . The array must have zero-based indexing. + The zero-based index in the array at which copying begins. + Copies the elements of the collection to an array, starting at a particular array index. + + instance is cast to an interface. + + ]]> + + + The array type is not compatible with the items in the . + .NET 5.0 and later: is . + + + + + + + + + + Property + + P:System.Collections.ICollection.IsSynchronized + + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + For a description of this member, see . + + in all cases. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + P:System.Collections.ICollection.SyncRoot + + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + For a description of this member, see . + An object that can be used to synchronize access to the . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + + Method + + M:System.Collections.IList.Add(System.Object) + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Int32 + + + + + + The object to be added to the . + Adds an object to the class. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + + instance is cast to an interface. + + ]]> + + + + is . + The current has a data source. + There is insufficient space available to store the new item. + + + + + + + + + + Method + + M:System.Collections.IList.Contains(System.Object) + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The object to locate in the . + Determines whether the contains a specific value. + + if the is found in the ; otherwise, . + To be added. + + + + + + + + + + Method + + M:System.Collections.IList.IndexOf(System.Object) + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + The object to locate in the . + Determines the index of a specific item in the . + The index of if found in the list; otherwise, -1. + To be added. + + + + + + + + + + Method + + M:System.Collections.IList.Insert(System.Int32,System.Object) + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The zero-based index at which should be inserted. + To be added. + Inserts an item to the at the specified index. + To be added. + + + + + + + + + + Property + + P:System.Collections.IList.IsFixedSize + + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + For a description of this member, see . + + in all cases. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + P:System.Collections.IList.Item(System.Int32) + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + The zero-based index of the element to get or set. + Gets or sets the element at the specified index. + The element at the specified index. + To be added. + + + + + + + + + + Method + + M:System.Collections.IList.Remove(System.Object) + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The object to remove from the . + Removes the first occurrence of a specific object from the . + To be added. + + + + diff --git a/xml/System.Windows.Forms/MessageBoxButtons.xml b/xml/System.Windows.Forms/MessageBoxButtons.xml index 6e47e88b904..b8a5754bed5 100644 --- a/xml/System.Windows.Forms/MessageBoxButtons.xml +++ b/xml/System.Windows.Forms/MessageBoxButtons.xml @@ -19,20 +19,20 @@ Specifies constants defining which buttons to display on a . - class. - - - -## Examples - The following code example shows how to use a to give the user an opportunity to prevent a form from closing. This example requires that the method is called from the event of the form. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic MessageBox Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic MessageBox Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic MessageBox Example/VB/source.vb" id="Snippet1"::: - + class. + + + +## Examples + The following code example shows how to use a to give the user an opportunity to prevent a form from closing. This example requires that the method is called from the event of the form. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/Classic MessageBox Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/Classic MessageBox Example/CS/source.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/Classic MessageBox Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -79,7 +79,7 @@ 6 - To be added. + Specifies that the message box contains Cancel, Try Again, and Continue buttons. diff --git a/xml/System.Windows.Forms/MessageBoxDefaultButton.xml b/xml/System.Windows.Forms/MessageBoxDefaultButton.xml index 579be08091e..208353c5236 100644 --- a/xml/System.Windows.Forms/MessageBoxDefaultButton.xml +++ b/xml/System.Windows.Forms/MessageBoxDefaultButton.xml @@ -19,20 +19,20 @@ Specifies constants defining the default button on a . - class. - - - -## Examples - The following code example demonstrates how to display a with the options supported by this overload of . After verifying that a string variable, `ServerName`, is empty, the example displays a with a question box icon, offering the user the option to cancel the operation. The example uses the member of the enumeration to align the text to the right edge of the dialog box. If the method's return value evaluates to , the form that displayed the is closed. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/MessageBox.Show Variations/CPP/form1.cpp" id="Snippet2"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/MessageBox.Show Variations/CS/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/MessageBox.Show Variations/VB/form1.vb" id="Snippet2"::: - + class. + + + +## Examples + The following code example demonstrates how to display a with the options supported by this overload of . After verifying that a string variable, `ServerName`, is empty, the example displays a with a question box icon, offering the user the option to cancel the operation. The example uses the member of the enumeration to align the text to the right edge of the dialog box. If the method's return value evaluates to , the form that displayed the is closed. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/MessageBox.Show Variations/CPP/form1.cpp" id="Snippet2"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/MessageBox.Show Variations/CS/form1.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/MessageBox.Show Variations/VB/form1.vb" id="Snippet2"::: + ]]> @@ -126,7 +126,7 @@ 768 - To be added. + Specifies that the Help button on the message box should be the default button. diff --git a/xml/System.Windows.Forms/ProfessionalColorTable.xml b/xml/System.Windows.Forms/ProfessionalColorTable.xml index efc6da27d63..63218c2d81a 100644 --- a/xml/System.Windows.Forms/ProfessionalColorTable.xml +++ b/xml/System.Windows.Forms/ProfessionalColorTable.xml @@ -1424,6 +1424,27 @@ To be added. + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + System.Drawing.Color + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Windows.Forms/ProfessionalColors.xml b/xml/System.Windows.Forms/ProfessionalColors.xml index 112853b792e..0bb0460e146 100644 --- a/xml/System.Windows.Forms/ProfessionalColors.xml +++ b/xml/System.Windows.Forms/ProfessionalColors.xml @@ -1149,6 +1149,27 @@ To be added. + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + System.Drawing.Color + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Windows.Forms/TaskDialog.xml b/xml/System.Windows.Forms/TaskDialog.xml index 2ef2724ee13..d3672787d65 100644 --- a/xml/System.Windows.Forms/TaskDialog.xml +++ b/xml/System.Windows.Forms/TaskDialog.xml @@ -1,214 +1,214 @@ - - - - - - - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.Windows.Forms.IWin32Window - - - - A task dialog allows to display information and get simple input from the user. It is similar to a (in that it is formatted by the operating system) but provides a lot more features. - - [!NOTE] -> In order to use the dialog, you need ensure has been called before showing the dialog, or the application needs to be compiled with a manifest that contains a dependency to Microsoft.Windows.Common-Controls (6.0.0.0). -> Additionally, the current thread should use the single-threaded apartment (STA) model. - - ]]> - - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Closes the shown task dialog with as resulting button. - - method of the that you want to set as a result. - - This method can be called while the dialog is waiting for navigation to complete, whereas would throw in that case. When calling this method, the event won't be raised. - - ]]> - - - - - - - - - - - Property - - P:System.Windows.Forms.IWin32Window.Handle - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.IntPtr - - - Gets the window handle of the task dialog window, or if the dialog is currently not being shown. - To be added. - To be added. - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - - - - - The page instance that contains the contents which this task dialog will display. - Gets or sets the position of the task dialog when it is shown. - Shows the task dialog. - The which was clicked by the user to close the dialog. - - - - - is . - The specified contains an invalid configuration. - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - - - - - - The handle of the owner window, or to show a modeless dialog. - The page instance that contains the contents which this task dialog will display. - Gets or sets the position of the task dialog when it is shown. - Shows the task dialog with the specified owner. - The which was clicked by the user to close the dialog. - - - - - is . - The specified contains an invalid configuration. - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - - - - - - The owner window, or to show a modeless dialog. - The page instance that contains the contents which this task dialog will display. - Gets or sets the position of the task dialog when it is shown. - Shows the task dialog with the specified owner. - The which was clicked by the user to close the dialog. - - - - - is - or - is . - The specified contains an invalid configuration. - - - - + + + + + + + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.Windows.Forms.IWin32Window + + + + A task dialog allows to display information and get simple input from the user. It is similar to a (in that it is formatted by the operating system) but provides a lot more features. + + [!NOTE] +> In order to use the dialog, you need ensure has been called before showing the dialog, or the application needs to be compiled with a manifest that contains a dependency to Microsoft.Windows.Common-Controls (6.0.0.0). +> Additionally, the current thread should use the single-threaded apartment (STA) model. + + ]]> + + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Closes the shown task dialog with as resulting button. + + method of the that you want to set as a result. + + This method can be called while the dialog is waiting for navigation to complete, whereas would throw in that case. When calling this method, the event won't be raised. + + ]]> + + + + + + + + + + + Property + + P:System.Windows.Forms.IWin32Window.Handle + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.IntPtr + + + Gets the window handle of the task dialog window, or if the dialog is currently not being shown. + A handle to the window represented by the implementer. + To be added. + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + + + + + The page instance that contains the contents which this task dialog will display. + Gets or sets the position of the task dialog when it is shown. + Shows the task dialog. + The which was clicked by the user to close the dialog. + + + + + is . + The specified contains an invalid configuration. + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + + + + + + The handle of the owner window, or to show a modeless dialog. + The page instance that contains the contents which this task dialog will display. + Gets or sets the position of the task dialog when it is shown. + Shows the task dialog with the specified owner. + The which was clicked by the user to close the dialog. + + + + + is . + The specified contains an invalid configuration. + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + + + + + + The owner window, or to show a modeless dialog. + The page instance that contains the contents which this task dialog will display. + Gets or sets the position of the task dialog when it is shown. + Shows the task dialog with the specified owner. + The which was clicked by the user to close the dialog. + + + + + is - or - is . + The specified contains an invalid configuration. + + + + diff --git a/xml/System.Windows.Forms/TaskDialogButton.xml b/xml/System.Windows.Forms/TaskDialogButton.xml index 7213ea03bc0..01e8c2a9826 100644 --- a/xml/System.Windows.Forms/TaskDialogButton.xml +++ b/xml/System.Windows.Forms/TaskDialogButton.xml @@ -17,19 +17,19 @@ Represents a button control of a task dialog. - instances retrieved by static getters like are standard buttons. Their property cannot be set as the OS will provide the localized text for the buttons when showing them in the dialog. - - Button instances created with one of the constructors are custom buttons, which allow you to provide your own text as button label. - -> [!NOTE] -> It's not possible to show both custom buttons and command links ( instances) at the same time - it's only one or the other. In either case, you can combine them with standard buttons. - + instances retrieved by static getters like are standard buttons. Their property cannot be set as the OS will provide the localized text for the buttons when showing them in the dialog. + + Button instances created with one of the constructors are custom buttons, which allow you to provide your own text as button label. + +> [!NOTE] +> It's not possible to show both custom buttons and command links ( instances) at the same time - it's only one or the other. In either case, you can combine them with standard buttons. + ]]> @@ -71,7 +71,7 @@ The text of the control. - To be added. + A value that indicates if the button should be enabled. A value that indicates whether the task dialog should close when this button is clicked. Initializes a new instance of the class using the given text and, optionally, a description text. To be added. @@ -142,12 +142,12 @@ Gets a standard instance representing the Cancel button. To be added. - ). - + ). + ]]> @@ -171,15 +171,15 @@ Occurs when the button is clicked. - button, which instead will raise the event afterwards). - - - To prevent the dialog from closing when this button is clicked, set the property to `false`. - + button, which instead will raise the event afterwards). + + + To prevent the dialog from closing when this button is clicked, set the property to `false`. + ]]> @@ -249,12 +249,12 @@ if the button can respond to user interaction; otherwise, . The default value is . - The property is set on a button that is currently bound to a task dialog, but the dialog has just started navigating to a different page. @@ -329,12 +329,12 @@ Gets a standard instance representing the Help button. To be added. - event. - + event. + ]]> @@ -481,8 +481,8 @@ Simulates a click on this button. To be added. - This button instance is not currently bound to a task dialog. - - or - The task dialog has started navigating to a new page containing this button instance, but the event has not been raised yet. + This button instance is not currently bound to a task dialog. + - or - The task dialog has started navigating to a new page containing this button instance, but the event has not been raised yet. - or - This button is currently bound to a task dialog, but the dialog has just started navigating to a different page. @@ -527,15 +527,15 @@ Gets or sets a value that indicates if the User Account Control (UAC) shield icon should be shown near the button; that is, whether the action invoked by the button requires elevation. - to show the UAC shield icon; otherwise, . + to show the UAC shield icon; otherwise, . The default value is . - The property is set on a button that is currently bound to a task dialog, but the dialog has just started navigating to a different page. @@ -561,17 +561,17 @@ Gets or sets the text associated with this control. The text associated with this control. The default value is . - - The property is set and this button instance is a standard button, for which the text is provided by the OS. + The property is set and this button instance is a standard button, for which the text is provided by the OS. - or - The property is set and this button instance is currently bound to a task dialog. @@ -640,12 +640,12 @@ Gets or sets a value that indicates if this should be shown when displaying the task dialog. To be added. - event (e.g. for the button when is set), or to call the method even if the button is not shown. - + event (e.g. for the button when is set), or to call the method even if the button is not shown. + ]]> The property is set and this button instance is currently bound to a task dialog. diff --git a/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml b/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml index e7f529322ca..c9fdce6c7d5 100644 --- a/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml +++ b/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml @@ -58,7 +58,7 @@ The text of the control. An additional description text that will be displayed in a separate line when the s of the task dialog are shown as command links (see ). - To be added. + A value that indicates if the button should be enabled. A value that indicates whether the task dialog should close when this button is clicked. Initializes a new instance of the class using the given text and, optionally, a description text. To be added. diff --git a/xml/System.Windows.Forms/TextRenderer.xml b/xml/System.Windows.Forms/TextRenderer.xml index 63712b7733c..6d150614237 100644 --- a/xml/System.Windows.Forms/TextRenderer.xml +++ b/xml/System.Windows.Forms/TextRenderer.xml @@ -963,7 +963,7 @@ The device context in which to measure the text. The text to measure. - To be added. + The to apply to the measured text. Provides the size, in pixels, of the specified text drawn with the specified font in the specified device context. The , in pixels, of drawn with the specified in the specified device context. To be added. diff --git a/xml/System.Xaml.Permissions/XamlLoadPermission.xml b/xml/System.Xaml.Permissions/XamlLoadPermission.xml index 7fb4a248050..b247be73b92 100644 --- a/xml/System.Xaml.Permissions/XamlLoadPermission.xml +++ b/xml/System.Xaml.Permissions/XamlLoadPermission.xml @@ -273,6 +273,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Runtime.InteropServices.ComVisible(false)] + [<System.Runtime.InteropServices.ComVisible(false)>] + + System.Boolean @@ -344,6 +350,12 @@ 5.0.0.0 6.0.0.0 + + + [System.Runtime.InteropServices.ComVisible(false)] + [<System.Runtime.InteropServices.ComVisible(false)>] + + System.Int32 diff --git a/xml/System.Xaml/XamlReader.xml b/xml/System.Xaml/XamlReader.xml index d4cb772ea41..4b7360173c1 100644 --- a/xml/System.Xaml/XamlReader.xml +++ b/xml/System.Xaml/XamlReader.xml @@ -1,524 +1,532 @@ - - - - - - - - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.IDisposable - - - - Provides base definitions for classes that consume XAML input and produce XAML node streams. - - is an abstract class and does not provide implementations or definitions that have a working result for all members. Members that do have an implementation in are noted in the remarks for that member. Specifically, has several abstract members that must be implemented, and several virtual members. - - Of the virtual members, and each provide a default implementation that is appropriate for most cases. However, the and default implementations rely on other expected behavior of the implementing XAML reader; in particular, they rely on the override. is also a virtual member that has a working default implementation. - - The following two classes are the most relevant and practical derived classes in .NET Framework XAML Services and the System.Xaml assembly: - -- , which reads an object graph, such as the active object graph of an application at run time. - -- , which reads XAML in the form of a XML text file by using a general that loads the file as an intermediary helper class. - - Other XAML readers from other frameworks include and . - - differs from XML Document Object Model (DOM) and design principles because does not have a `Create` method to return underlying default XAML reader implementations. You must instead instantiate specific derived XAML reader classes by calling their constructors or other class-specific helper APIs. - -## Subtree Readers - For the most part, you call API in the context of specific XAML reader classes that derive from . However, in one particular case, you access API on a practical XAML reader instance that is not public and not derived from or . This case is when you call , which returns a instance. In the default implementation, the that is returned by this API is an internal class. - - The obtained for subtree reading has valid actions for APIs such as and , and those actions are based on the parent reader class. This design enables the internal class to track the frame level where the subtree was entered. The acting subtree makes sure that if the current node position is moved beyond the bounds of the subtree, the specific subtree reader reports end-of-file or `null` at the current node. - - Notes about subtree reader usage are included on certain APIs. - - ]]> - - - - - Understanding XAML Node Stream Structures and Concepts - - - - - - - - - Constructor - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - - Initializes the class. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Closes the XAML node stream. - - calls with the `isDisposing` parameter as `true`. - - ]]> - - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - to release the managed resources; otherwise, . - Releases the unmanaged resources used by the , and optionally, releases the managed resources. - - = `true`. - - ]]> - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets whether has been called. - - if has been called; otherwise, . - To be added. - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - When implemented in a derived class, gets a value that reports whether the reader position is at end-of-file. - - if the position is at the conceptual end-of-file of the XAML node stream; otherwise, . - - , with behavior that correctly reflects the bounds of the entered subtree. For more information, see the "Subtree Readers" section in , or see . - - ]]> - - - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.XamlMember - - - When implemented in a derived class, gets the current member at the reader position, if the reader position is on a . - The current member; or , if the reader position is not on a member. - - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - - ]]> - - - - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.NamespaceDeclaration - - - When implemented in a derived class, gets the XAML namespace information from the current node. - The XAML namespace information, if it is available; otherwise, . - - of the current node is . The property does not report the XAML namespace that applies to objects or members in a general scoping sense, as interpreted under a XAML schema context. Your application must provide a means to cache information for the acting XAML namespace as it traverses XAML nodes, if you need that information in a manner other than how the XAML schema context reports it to a writer. See for notes on the reference implementation. - - ]]> - - - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.XamlNodeType - - - When implemented in a derived class, gets the type of the current node. - A value of the enumeration. - - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - - ]]> - - - - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When implemented in a derived class, provides the next XAML node from the source, if a node is available. - - if a node is available; otherwise, . - - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - - ]]> - - - - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.XamlReader - - - - Returns a that is based on the current , where the returned is used to iterate through a subtree of the XAML node structure. - A new XAML reader instance for the subtree. - - . The returned is an internal class that restricts certain actions. The restrictions are consistent with the purpose of reading only a dimensioned subtree of a larger source for a XAML node set, and of returning end-of-file or `null` at the current node when the subtree is exited. - - Generally, you should check the current node from the initial to determine whether you need a subtree reader. How you check this may be implementation-specific; however, avoid creating multiple subtree readers for every subtree. In addition, avoid invoking a subtree reader for certain node cases (for example, for ) that cannot contain a subtree of nodes. - - After you obtain a subtree reader, you must call on it to obtain a current node (or call to obtain a next node). You do not automatically obtain an initial node position from the subtree reader when you create it. - - The reader you obtain by calling from this default implementation is an internal class. The internal class bases its behavior on the implementation that is being used when is called. The purpose of the internal class is to wrap the and general traversal behavior. The traversal stays within the intended subtree by keeping track of / pairs or / pairs. It also correctly returns `false` for and `true` for when the reader is at the end of the subtree, as defined by its entry point. In general, you assume that any API you call from a subtree reader has the same implementation as the overall except for the traversal bounding behavior. - - However, is virtual. Therefore, a specific implementation can provide behavior that differs from the internal wrapper behavior; and a implementation can even disable subtree reader functionality by returning or other exceptions. - - ]]> - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.XamlSchemaContext - - - When implemented in a derived class, gets an object that provides XAML schema context information for the information set. - An object that provides XAML schema context information for the information set. - To be added. - - - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Skips the current node and advances the reader position to the next node. - - is called by the default implementation. You typically do not call and in sequence. - - In the default implementation, different actions are taken depending on which the reader position is currently on. If the reader position is currently on a or , that member or object is skipped. For other values, no action is taken other than calling from the current position. - - Subtree readers can call , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - - The node tree behavior of is based on the XML equivalent . Based on the behavior equivalence, skips the node and its subtree, not just the single entry node. - - ]]> - - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Releases all resources used by the current instance of the class. - To be added. - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.XamlType - - - When implemented in a derived class, gets the of the current node. - The of the current node; or , if the current reader position is not on an object. - - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - - ]]> - - - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - When implemented in a derived class, gets the value of the current node. - The value of the current node; or , if the current reader position is not on a node type. - To be added. - - - - - - + + + + + + + + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.IDisposable + + + + Provides base definitions for classes that consume XAML input and produce XAML node streams. + + is an abstract class and does not provide implementations or definitions that have a working result for all members. Members that do have an implementation in are noted in the remarks for that member. Specifically, has several abstract members that must be implemented, and several virtual members. + + Of the virtual members, and each provide a default implementation that is appropriate for most cases. However, the and default implementations rely on other expected behavior of the implementing XAML reader; in particular, they rely on the override. is also a virtual member that has a working default implementation. + + The following two classes are the most relevant and practical derived classes in .NET Framework XAML Services and the System.Xaml assembly: + +- , which reads an object graph, such as the active object graph of an application at run time. + +- , which reads XAML in the form of a XML text file by using a general that loads the file as an intermediary helper class. + + Other XAML readers from other frameworks include and . + + differs from XML Document Object Model (DOM) and design principles because does not have a `Create` method to return underlying default XAML reader implementations. You must instead instantiate specific derived XAML reader classes by calling their constructors or other class-specific helper APIs. + +## Subtree Readers + For the most part, you call API in the context of specific XAML reader classes that derive from . However, in one particular case, you access API on a practical XAML reader instance that is not public and not derived from or . This case is when you call , which returns a instance. In the default implementation, the that is returned by this API is an internal class. + + The obtained for subtree reading has valid actions for APIs such as and , and those actions are based on the parent reader class. This design enables the internal class to track the frame level where the subtree was entered. The acting subtree makes sure that if the current node position is moved beyond the bounds of the subtree, the specific subtree reader reports end-of-file or `null` at the current node. + + Notes about subtree reader usage are included on certain APIs. + + ]]> + + + + + Understanding XAML Node Stream Structures and Concepts + + + + + + + + + Constructor + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + + Initializes the class. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Closes the XAML node stream. + + calls with the `isDisposing` parameter as `true`. + + ]]> + + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + to release the managed resources; otherwise, . + Releases the unmanaged resources used by the , and optionally, releases the managed resources. + + = `true`. + + ]]> + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets whether has been called. + + if has been called; otherwise, . + To be added. + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + When implemented in a derived class, gets a value that reports whether the reader position is at end-of-file. + + if the position is at the conceptual end-of-file of the XAML node stream; otherwise, . + + , with behavior that correctly reflects the bounds of the entered subtree. For more information, see the "Subtree Readers" section in , or see . + + ]]> + + + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.XamlMember + + + When implemented in a derived class, gets the current member at the reader position, if the reader position is on a . + The current member; or , if the reader position is not on a member. + + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + + ]]> + + + + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.NamespaceDeclaration + + + When implemented in a derived class, gets the XAML namespace information from the current node. + The XAML namespace information, if it is available; otherwise, . + + of the current node is . The property does not report the XAML namespace that applies to objects or members in a general scoping sense, as interpreted under a XAML schema context. Your application must provide a means to cache information for the acting XAML namespace as it traverses XAML nodes, if you need that information in a manner other than how the XAML schema context reports it to a writer. See for notes on the reference implementation. + + ]]> + + + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.XamlNodeType + + + When implemented in a derived class, gets the type of the current node. + A value of the enumeration. + + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + + ]]> + + + + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When implemented in a derived class, provides the next XAML node from the source, if a node is available. + + if a node is available; otherwise, . + + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + + ]]> + + + + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.XamlReader + + + + Returns a that is based on the current , where the returned is used to iterate through a subtree of the XAML node structure. + A new XAML reader instance for the subtree. + + . The returned is an internal class that restricts certain actions. The restrictions are consistent with the purpose of reading only a dimensioned subtree of a larger source for a XAML node set, and of returning end-of-file or `null` at the current node when the subtree is exited. + + Generally, you should check the current node from the initial to determine whether you need a subtree reader. How you check this may be implementation-specific; however, avoid creating multiple subtree readers for every subtree. In addition, avoid invoking a subtree reader for certain node cases (for example, for ) that cannot contain a subtree of nodes. + + After you obtain a subtree reader, you must call on it to obtain a current node (or call to obtain a next node). You do not automatically obtain an initial node position from the subtree reader when you create it. + + The reader you obtain by calling from this default implementation is an internal class. The internal class bases its behavior on the implementation that is being used when is called. The purpose of the internal class is to wrap the and general traversal behavior. The traversal stays within the intended subtree by keeping track of / pairs or / pairs. It also correctly returns `false` for and `true` for when the reader is at the end of the subtree, as defined by its entry point. In general, you assume that any API you call from a subtree reader has the same implementation as the overall except for the traversal bounding behavior. + + However, is virtual. Therefore, a specific implementation can provide behavior that differs from the internal wrapper behavior; and a implementation can even disable subtree reader functionality by returning or other exceptions. + + ]]> + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.XamlSchemaContext + + + When implemented in a derived class, gets an object that provides XAML schema context information for the information set. + An object that provides XAML schema context information for the information set. + To be added. + + + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Skips the current node and advances the reader position to the next node. + + is called by the default implementation. You typically do not call and in sequence. + + In the default implementation, different actions are taken depending on which the reader position is currently on. If the reader position is currently on a or , that member or object is skipped. For other values, no action is taken other than calling from the current position. + + Subtree readers can call , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + + The node tree behavior of is based on the XML equivalent . Based on the behavior equivalence, skips the node and its subtree, not just the single entry node. + + ]]> + + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Releases all resources used by the current instance of the class. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.XamlType + + + When implemented in a derived class, gets the of the current node. + The of the current node; or , if the current reader position is not on an object. + + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + + ]]> + + + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + When implemented in a derived class, gets the value of the current node. + The value of the current node; or , if the current reader position is not on a node type. + To be added. + + + + + + diff --git a/xml/System.Xaml/XamlWriter.xml b/xml/System.Xaml/XamlWriter.xml index 61dcc13e393..a5cc631b927 100644 --- a/xml/System.Xaml/XamlWriter.xml +++ b/xml/System.Xaml/XamlWriter.xml @@ -1,422 +1,430 @@ - - - - - - - - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.IDisposable - - - - Provides default implementation and base class definitions for a XAML writer. This is not a working default XAML writer; you must either derive from and implement its abstract members, or use an existing derived class. - - are the and classes, as the following details explain: - -- processes a XAML node set and produces an XML text file. This class might be used for serialization or as part of the function of a tool that works with in-memory representation of XAML and produces XAML file output. - -- processes a XAML node set and produces an object graph. This class might be used as part of a full or partial customization of a technology's XAML parser. - - is a class for settings that are used by a ; however, by default, the class does not hold any specific settings. The base constructor does not use this settings class as an argument, nor does any other member. Instead, the and classes include their own settings classes as construction arguments. These settings classes are and . The settings classes define actual settings values and are based on , so that they can use the merge feature. - - ]]> - - - - - - - - - - Constructor - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Closes the XAML writer object. - - calls the method with the `isDisposing` parameter as `true`. - - ]]> - - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - to release the managed resources; otherwise, . - Releases the unmanaged resources used by the and optionally releases the managed resources. - - = `true`. - - ]]> - - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets whether has been called. - - if has been called; otherwise, . - To be added. - - - - - - - - - - Property - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Xaml.XamlSchemaContext - - - When implemented in a derived class, gets the active XAML schema context. - The active XAML schema context. - To be added. - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - See . - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - When implemented in a derived class, produces the representation of an end member node. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - When implemented in a derived class, produces the representation of an end object node. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - When implemented in a derived class, produces an object for cases where the object is a default or implicit value of the property being set, instead of being specified as a discrete object value in the input XAML node set. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The namespace declaration to write. - When implemented in a derived class, writes a XAML namespace declaration node. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The reader to use for node determination. - Performs switching based on node type from the XAML reader () and calls the relevant method for the writer implementation. - - method is not a virtual method because it has practical implementation for all existing values. Based on , calls into the `Write` virtual members that are dedicated to particular node types. - - If you have an advanced XAML writing scenario that expands the XAML type system and XAML node stream concept so that new node types are defined, do not use calls in your logic. You must instead provide your own alternative for node-type switching logic in the class or in virtual overrides. - - ]]> - - - is . - The default implementation encountered a that is not in the default enumeration. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The member node to write. - When implemented in a derived class, writes the representation of a start member node. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The XAML type of the object to write. - When implemented in a derived class, writes the representation of a start object node. - To be added. - - - - - - - - - - Method - - System.Xaml - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The value to write. - When implemented in a derived class, writes a value node. - To be added. - - - - + + + + + + + + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.IDisposable + + + + Provides default implementation and base class definitions for a XAML writer. This is not a working default XAML writer; you must either derive from and implement its abstract members, or use an existing derived class. + + are the and classes, as the following details explain: + +- processes a XAML node set and produces an XML text file. This class might be used for serialization or as part of the function of a tool that works with in-memory representation of XAML and produces XAML file output. + +- processes a XAML node set and produces an object graph. This class might be used as part of a full or partial customization of a technology's XAML parser. + + is a class for settings that are used by a ; however, by default, the class does not hold any specific settings. The base constructor does not use this settings class as an argument, nor does any other member. Instead, the and classes include their own settings classes as construction arguments. These settings classes are and . The settings classes define actual settings values and are based on , so that they can use the merge feature. + + ]]> + + + + + + + + + + Constructor + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Closes the XAML writer object. + + calls the method with the `isDisposing` parameter as `true`. + + ]]> + + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + to release the managed resources; otherwise, . + Releases the unmanaged resources used by the and optionally releases the managed resources. + + = `true`. + + ]]> + + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets whether has been called. + + if has been called; otherwise, . + To be added. + + + + + + + + + + Property + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Xaml.XamlSchemaContext + + + When implemented in a derived class, gets the active XAML schema context. + The active XAML schema context. + To be added. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + See . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + When implemented in a derived class, produces the representation of an end member node. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + When implemented in a derived class, produces the representation of an end object node. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + When implemented in a derived class, produces an object for cases where the object is a default or implicit value of the property being set, instead of being specified as a discrete object value in the input XAML node set. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The namespace declaration to write. + When implemented in a derived class, writes a XAML namespace declaration node. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The reader to use for node determination. + Performs switching based on node type from the XAML reader () and calls the relevant method for the writer implementation. + + method is not a virtual method because it has practical implementation for all existing values. Based on , calls into the `Write` virtual members that are dedicated to particular node types. + + If you have an advanced XAML writing scenario that expands the XAML type system and XAML node stream concept so that new node types are defined, do not use calls in your logic. You must instead provide your own alternative for node-type switching logic in the class or in virtual overrides. + + ]]> + + + is . + The default implementation encountered a that is not in the default enumeration. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The member node to write. + When implemented in a derived class, writes the representation of a start member node. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The XAML type of the object to write. + When implemented in a derived class, writes the representation of a start object node. + To be added. + + + + + + + + + + Method + + System.Xaml + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The value to write. + When implemented in a derived class, writes a value node. + To be added. + + + + diff --git a/xml/System.Xml.Schema/XmlSchema.xml b/xml/System.Xml.Schema/XmlSchema.xml index a1a7117a6e5..20a7ff4bd8d 100644 --- a/xml/System.Xml.Schema/XmlSchema.xml +++ b/xml/System.Xml.Schema/XmlSchema.xml @@ -398,10 +398,14 @@ 6.0.0.0 - + [System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("XmlSchema.Compile has been deprecated. Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation.")] + [<System.Obsolete("XmlSchema.Compile has been deprecated. Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation.")>] + [System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -458,10 +462,14 @@ 6.0.0.0 - + [System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("XmlSchema.Compile has been deprecated. Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation.")] + [<System.Obsolete("XmlSchema.Compile has been deprecated. Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation.")>] + [System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Xml.Schema/XmlSchemaAttribute.xml b/xml/System.Xml.Schema/XmlSchemaAttribute.xml index b52d09a375a..01203f35c96 100644 --- a/xml/System.Xml.Schema/XmlSchemaAttribute.xml +++ b/xml/System.Xml.Schema/XmlSchemaAttribute.xml @@ -175,7 +175,7 @@ 6.0.0.0 - + [System.Obsolete("This property has been deprecated. Please use AttributeSchemaType property that returns a strongly typed attribute type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use AttributeSchemaType property that returns a strongly typed attribute type. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -183,6 +183,10 @@ [System.Xml.Serialization.XmlIgnore] [<System.Xml.Serialization.XmlIgnore>] + + [System.Obsolete("XmlSchemaAttribute.AttributeType has been deprecated. Use the AttributeSchemaType property that returns a strongly typed attribute type instead.")] + [<System.Obsolete("XmlSchemaAttribute.AttributeType has been deprecated. Use the AttributeSchemaType property that returns a strongly typed attribute type instead.")>] + [System.Obsolete("This property has been deprecated. Please use AttributeSchemaType property that returns a strongly typed attribute type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use AttributeSchemaType property that returns a strongly typed attribute type. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Xml.Schema/XmlSchemaCollection.xml b/xml/System.Xml.Schema/XmlSchemaCollection.xml index ce8751f9c49..2a5c3c57c57 100644 --- a/xml/System.Xml.Schema/XmlSchemaCollection.xml +++ b/xml/System.Xml.Schema/XmlSchemaCollection.xml @@ -41,10 +41,14 @@ - + [System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("XmlSchemaCollection has been deprecated. Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation.")] + [<System.Obsolete("XmlSchemaCollection has been deprecated. Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation.")>] + [System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use System.Xml.Schema.XmlSchemaSet for schema compilation and validation. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Xml.Schema/XmlSchemaElement.xml b/xml/System.Xml.Schema/XmlSchemaElement.xml index 3ec89c74ba5..1e634624228 100644 --- a/xml/System.Xml.Schema/XmlSchemaElement.xml +++ b/xml/System.Xml.Schema/XmlSchemaElement.xml @@ -437,7 +437,7 @@ 6.0.0.0 - + [System.Obsolete("This property has been deprecated. Please use ElementSchemaType property that returns a strongly typed element type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use ElementSchemaType property that returns a strongly typed element type. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -445,6 +445,10 @@ [System.Xml.Serialization.XmlIgnore] [<System.Xml.Serialization.XmlIgnore>] + + [System.Obsolete("XmlSchemaElement.ElementType has been deprecated. Use the ElementSchemaType property that returns a strongly typed element type instead.")] + [<System.Obsolete("XmlSchemaElement.ElementType has been deprecated. Use the ElementSchemaType property that returns a strongly typed element type instead.")>] + [System.Obsolete("This property has been deprecated. Please use ElementSchemaType property that returns a strongly typed element type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use ElementSchemaType property that returns a strongly typed element type. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Xml.Schema/XmlSchemaType.xml b/xml/System.Xml.Schema/XmlSchemaType.xml index 0d6836f59f7..f897db8349d 100644 --- a/xml/System.Xml.Schema/XmlSchemaType.xml +++ b/xml/System.Xml.Schema/XmlSchemaType.xml @@ -108,7 +108,7 @@ 6.0.0.0 - + [System.Obsolete("This property has been deprecated. Please use BaseXmlSchemaType property that returns a strongly typed base schema type. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use BaseXmlSchemaType property that returns a strongly typed base schema type. https://go.microsoft.com/fwlink/?linkid=14202")>] @@ -116,6 +116,10 @@ [System.Xml.Serialization.XmlIgnore] [<System.Xml.Serialization.XmlIgnore>] + + [System.Obsolete("XmlSchemaType.BaseSchemaType has been deprecated. Use the BaseXmlSchemaType property that returns a strongly typed base schema type instead.")] + [<System.Obsolete("XmlSchemaType.BaseSchemaType has been deprecated. Use the BaseXmlSchemaType property that returns a strongly typed base schema type instead.")>] + [System.Obsolete("This property has been deprecated. Please use BaseXmlSchemaType property that returns a strongly typed base schema type. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This property has been deprecated. Please use BaseXmlSchemaType property that returns a strongly typed base schema type. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System.Xml/ValidationType.xml b/xml/System.Xml/ValidationType.xml index af7db586b33..34675600783 100644 --- a/xml/System.Xml/ValidationType.xml +++ b/xml/System.Xml/ValidationType.xml @@ -76,10 +76,14 @@ 6.0.0.0 - + [System.Obsolete("Validation type should be specified as DTD or Schema.")] [<System.Obsolete("Validation type should be specified as DTD or Schema.")>] + + [System.Obsolete("ValidationType.Auto has been deprecated. Use DTD or Schema instead.")] + [<System.Obsolete("ValidationType.Auto has been deprecated. Use DTD or Schema instead.")>] + System.Xml.ValidationType @@ -231,10 +235,14 @@ Calls to report default attr 6.0.0.0 - + [System.Obsolete("XDR Validation through XmlValidatingReader is obsoleted")] [<System.Obsolete("XDR Validation through XmlValidatingReader is obsoleted")>] + + [System.Obsolete("XDR Validation through XmlValidatingReader has been deprecated and is not supported.")] + [<System.Obsolete("XDR Validation through XmlValidatingReader has been deprecated and is not supported.")>] + System.Xml.ValidationType diff --git a/xml/System.Xml/XmlConvert.xml b/xml/System.Xml/XmlConvert.xml index 2efd2c142c4..f6ff1474324 100644 --- a/xml/System.Xml/XmlConvert.xml +++ b/xml/System.Xml/XmlConvert.xml @@ -854,10 +854,14 @@ writer.WriteElementString(XmlConvert.EncodeName("Order Detail"),"My order"); 6.0.0.0 - + [System.Obsolete("Use XmlConvert.ToDateTime() that takes in XmlDateTimeSerializationMode")] [<System.Obsolete("Use XmlConvert.ToDateTime() that takes in XmlDateTimeSerializationMode")>] + + [System.Obsolete("Use XmlConvert.ToDateTime() that accepts an XmlDateTimeSerializationMode instead.")] + [<System.Obsolete("Use XmlConvert.ToDateTime() that accepts an XmlDateTimeSerializationMode instead.")>] + System.DateTime @@ -1902,10 +1906,14 @@ writer.WriteElementString(XmlConvert.EncodeName("Order Detail"),"My order"); 6.0.0.0 - + [System.Obsolete("Use XmlConvert.ToString() that takes in XmlDateTimeSerializationMode")] [<System.Obsolete("Use XmlConvert.ToString() that takes in XmlDateTimeSerializationMode")>] + + [System.Obsolete("Use XmlConvert.ToString() that accepts an XmlDateTimeSerializationMode instead.")] + [<System.Obsolete("Use XmlConvert.ToString() that accepts an XmlDateTimeSerializationMode instead.")>] + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] diff --git a/xml/System.Xml/XmlDataDocument.xml b/xml/System.Xml/XmlDataDocument.xml index e288c03fa33..8969015e67f 100644 --- a/xml/System.Xml/XmlDataDocument.xml +++ b/xml/System.Xml/XmlDataDocument.xml @@ -24,10 +24,14 @@ - + [System.Obsolete("XmlDataDocument class will be removed in a future release.")] [<System.Obsolete("XmlDataDocument class will be removed in a future release.")>] + + [System.Obsolete("XmlDataDocument has been deprecated and is not supported.")] + [<System.Obsolete("XmlDataDocument has been deprecated and is not supported.")>] + Allows structured data to be stored, retrieved, and manipulated through a relational . diff --git a/xml/System.Xml/XmlReaderSettings.xml b/xml/System.Xml/XmlReaderSettings.xml index 4dfd4097c60..ca1b3f559be 100644 --- a/xml/System.Xml/XmlReaderSettings.xml +++ b/xml/System.Xml/XmlReaderSettings.xml @@ -299,16 +299,17 @@ if any characters are outside the range of legal XML characters. When character checking is enabled, you are ensured the following: +## Remarks + +This property instructs the XML reader to check characters in the XML data it's reading and throw an if any characters are outside the range of legal XML characters. When character checking is enabled, you are ensured the following: -- Characters are within the range of legal XML characters, as defined by the [2.2 Characters](https://www.w3.org/TR/2006/REC-xml-20060816/#charsets) section of the W3C XML 1.0 Recommendation. +- Characters are within the range of legal XML characters, as defined by the [2.2 Characters](https://www.w3.org/TR/2006/REC-xml-20060816/#charsets) section of the W3C XML 1.0 Recommendation. -- All XML names are valid, as defined by the [2.3 Common Syntactic Constructs](https://www.w3.org/TR/2006/REC-xml-20060816/#NT-Name) section of the W3C XML 1.0 Recommendation. +- All XML names are valid, as defined by the [2.3 Common Syntactic Constructs](https://www.w3.org/TR/2006/REC-xml-20060816/#NT-Name) section of the W3C XML 1.0 Recommendation. - When this property is set to `true`, which is the default setting, an exception is thrown if the XML file contains illegal characters or invalid XML names (for example, an element name starts with a number). +When this property is set to `true`, which is the default setting, an exception is thrown if the XML file contains illegal characters or invalid XML names (for example, an element name starts with a number). -If the is processing text data, it always checks that the XML names and text content are valid, regardless of the property setting. Setting to turns off character checking for character entity references. +If the is processing text data, it always checks that the XML names and text content are valid, regardless of the property setting. Setting to `false` turns off character checking for character entity references. ]]> @@ -1197,10 +1198,14 @@ There is an error in XML document (MaxCharactersInDocument, ). 6.0.0.0 - + [System.Obsolete("Use XmlReaderSettings.DtdProcessing property instead.")] [<System.Obsolete("Use XmlReaderSettings.DtdProcessing property instead.")>] + + [System.Obsolete("XmlReaderSettings.ProhibitDtd has been deprecated. Use DtdProcessing instead.")] + [<System.Obsolete("XmlReaderSettings.ProhibitDtd has been deprecated. Use DtdProcessing instead.")>] + System.Boolean diff --git a/xml/System.Xml/XmlTextReader.xml b/xml/System.Xml/XmlTextReader.xml index 5a205a70149..2da4a957062 100644 --- a/xml/System.Xml/XmlTextReader.xml +++ b/xml/System.Xml/XmlTextReader.xml @@ -3335,10 +3335,14 @@ abc 6.0.0.0 - + [System.Obsolete("Use DtdProcessing property instead.")] [<System.Obsolete("Use DtdProcessing property instead.")>] + + [System.Obsolete("XmlTextReader.ProhibitDtd has been deprecated. Use DtdProcessing instead.")] + [<System.Obsolete("XmlTextReader.ProhibitDtd has been deprecated. Use DtdProcessing instead.")>] + System.Boolean diff --git a/xml/System.Xml/XmlValidatingReader.xml b/xml/System.Xml/XmlValidatingReader.xml index 49d3cc635ed..ab231bce691 100644 --- a/xml/System.Xml/XmlValidatingReader.xml +++ b/xml/System.Xml/XmlValidatingReader.xml @@ -46,10 +46,14 @@ - + [System.Obsolete("Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("XmlValidatingReader has been deprecated. Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead.")] + [<System.Obsolete("XmlValidatingReader has been deprecated. Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead.")>] + [System.Obsolete("Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("Use XmlReader created by XmlReader.Create() method using appropriate XmlReaderSettings instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System/AppDomain.xml b/xml/System/AppDomain.xml index bd603c06c96..6c2a4004392 100644 --- a/xml/System/AppDomain.xml +++ b/xml/System/AppDomain.xml @@ -194,10 +194,14 @@ Application domains, which are represented by objects, h 6.0.0.0 - + [System.Obsolete("AppDomain.AppendPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.AppendPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.AppendPrivatePath has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.AppendPrivatePath has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.AppendPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.AppendPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -635,10 +639,14 @@ Application domains, which are represented by objects, h 6.0.0.0 - + [System.Obsolete("AppDomain.ClearPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.ClearPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.ClearPrivatePath has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.ClearPrivatePath has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.ClearPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.ClearPrivatePath has been deprecated. Please investigate the use of AppDomainSetup.PrivateBinPath instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -721,10 +729,14 @@ Application domains, which are represented by objects, h 6.0.0.0 - + [System.Obsolete("AppDomain.ClearShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.ClearShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.ClearShadowCopyPath has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.ClearShadowCopyPath has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.ClearShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.ClearShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -5875,10 +5887,14 @@ This method overload uses the information from the 6.0.0.0 - + [System.Obsolete("AppDomain.GetCurrentThreadId has been deprecated because it does not provide a stable Id when managed threads are running on fibers (aka lightweight threads). To get a stable identifier for a managed thread, use the ManagedThreadId property on Thread. https://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("AppDomain.GetCurrentThreadId has been deprecated because it does not provide a stable Id when managed threads are running on fibers (aka lightweight threads). To get a stable identifier for a managed thread, use the ManagedThreadId property on Thread. https://go.microsoft.com/fwlink/?linkid=14202", false)>] + + [System.Obsolete("AppDomain.GetCurrentThreadId has been deprecated because it does not provide a stable Id when managed threads are running on fibers (aka lightweight threads). To get a stable identifier for a managed thread, use the ManagedThreadId property on Thread.")] + [<System.Obsolete("AppDomain.GetCurrentThreadId has been deprecated because it does not provide a stable Id when managed threads are running on fibers (aka lightweight threads). To get a stable identifier for a managed thread, use the ManagedThreadId property on Thread.")>] + [System.Obsolete("AppDomain.GetCurrentThreadId has been deprecated because it does not provide a stable Id when managed threads are running on fibers (aka lightweight threads). To get a stable identifier for a managed thread, use the ManagedThreadId property on Thread. http://go.microsoft.com/fwlink/?linkid=14202", false)] [<System.Obsolete("AppDomain.GetCurrentThreadId has been deprecated because it does not provide a stable Id when managed threads are running on fibers (aka lightweight threads). To get a stable identifier for a managed thread, use the ManagedThreadId property on Thread. http://go.microsoft.com/fwlink/?linkid=14202", false)>] @@ -7845,10 +7861,14 @@ This method overload uses the information from the 6.0.0.0 - + [System.Obsolete("AppDomain.SetCachePath has been deprecated. Please investigate the use of AppDomainSetup.CachePath instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetCachePath has been deprecated. Please investigate the use of AppDomainSetup.CachePath instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.SetCachePath has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.SetCachePath has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.SetCachePath has been deprecated. Please investigate the use of AppDomainSetup.CachePath instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetCachePath has been deprecated. Please investigate the use of AppDomainSetup.CachePath instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -8069,10 +8089,14 @@ This method overload uses the information from the 6.0.0.0 - + [System.Obsolete("AppDomain.SetDynamicBase has been deprecated. Please investigate the use of AppDomainSetup.DynamicBase instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetDynamicBase has been deprecated. Please investigate the use of AppDomainSetup.DynamicBase instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.SetDynamicBase has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.SetDynamicBase has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.SetDynamicBase has been deprecated. Please investigate the use of AppDomainSetup.DynamicBase instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetDynamicBase has been deprecated. Please investigate the use of AppDomainSetup.DynamicBase instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -8220,10 +8244,14 @@ This method overload uses the information from the 6.0.0.0 - + [System.Obsolete("AppDomain.SetShadowCopyFiles has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyFiles instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetShadowCopyFiles has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyFiles instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.SetShadowCopyFiles has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.SetShadowCopyFiles has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.SetShadowCopyFiles has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyFiles instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetShadowCopyFiles has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyFiles instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -8303,10 +8331,14 @@ This method overload uses the information from the 6.0.0.0 - + [System.Obsolete("AppDomain.SetShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("AppDomain.SetShadowCopyPath has been deprecated and is not supported.")] + [<System.Obsolete("AppDomain.SetShadowCopyPath has been deprecated and is not supported.")>] + [System.Obsolete("AppDomain.SetShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("AppDomain.SetShadowCopyPath has been deprecated. Please investigate the use of AppDomainSetup.ShadowCopyDirectories instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System/ArgumentNullException.xml b/xml/System/ArgumentNullException.xml index e7029dfb047..b06c9ecc811 100644 --- a/xml/System/ArgumentNullException.xml +++ b/xml/System/ArgumentNullException.xml @@ -394,9 +394,9 @@ - To be added. - To be added. - To be added. + The reference type argument to validate as non-null. + The name of the parameter with which corresponds. + Throws an if is . To be added. diff --git a/xml/System/BinaryData.xml b/xml/System/BinaryData.xml index 8feb3c7677f..e5c3e1a8c31 100644 --- a/xml/System/BinaryData.xml +++ b/xml/System/BinaryData.xml @@ -362,8 +362,8 @@ - To be added. - To be added. + Returns the hash code for the current object. + A 32-bit signed integer hash code. To be added. @@ -543,8 +543,19 @@ Converts the value of this instance to a string using UTF-8. - A string from the value of this instance, using UTF-8 to decode the bytes. - To be added. + A string representation of the value of this instance. + + + diff --git a/xml/System/Console.xml b/xml/System/Console.xml index 22333c6847e..27819085e31 100644 --- a/xml/System/Console.xml +++ b/xml/System/Console.xml @@ -241,10 +241,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -341,10 +337,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -505,10 +497,6 @@ [get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -606,10 +594,6 @@ [get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -702,10 +686,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -843,10 +823,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -933,10 +909,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1022,10 +994,6 @@ [get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1109,10 +1077,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1198,10 +1162,6 @@ [set: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<set: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [set: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<set: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [set: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<set: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1356,10 +1316,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1438,10 +1394,6 @@ [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1513,10 +1465,6 @@ Columns are numbered from left to right starting at 0. Rows are numbered from to [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1599,10 +1547,6 @@ Columns are numbered from left to right starting at 0. Rows are numbered from to [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1885,10 +1829,6 @@ Columns are numbered from left to right starting at 0. Rows are numbered from to [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -1952,10 +1892,6 @@ Columns are numbered from left to right starting at 0. Rows are numbered from to [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2394,10 +2330,6 @@ Columns are numbered from left to right starting at 0. Rows are numbered from to [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2727,10 +2659,6 @@ This method can be used to reacquire the standard output stream after it has bee [set: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<set: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [set: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<set: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [set: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<set: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2907,10 +2835,6 @@ This method can be used to reacquire the standard output stream after it has bee [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -2999,10 +2923,6 @@ This method can be used to reacquire the standard output stream after it has bee [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -3214,10 +3134,6 @@ This method can be used to reacquire the standard output stream after it has bee [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -3375,10 +3291,6 @@ This method can be used to reacquire the standard output stream after it has bee [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -3544,10 +3456,6 @@ This method can be used to reacquire the standard output stream after it has bee [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -3873,10 +3781,6 @@ This method can be used to reacquire the standard output stream after it has bee [set: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<set: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [set: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<set: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [set: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<set: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -3956,10 +3860,6 @@ This method can be used to reacquire the standard output stream after it has bee [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -4051,10 +3951,6 @@ This method can be used to reacquire the standard output stream after it has bee [get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] @@ -4308,10 +4204,6 @@ This method can be used to reacquire the standard output stream after it has bee [get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - [get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")] - [<get: System.Runtime.Versioning.UnsupportedOSPlatform("maccatalyst")>] - [get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] [<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] diff --git a/xml/System/Enum.xml b/xml/System/Enum.xml index c76bba46580..b16d2a6d0f2 100644 --- a/xml/System/Enum.xml +++ b/xml/System/Enum.xml @@ -3504,10 +3504,14 @@ thisInstance And flag = flag 6.0.0.0 - + [System.Obsolete("The provider argument is not used. Please use ToString().")] [<System.Obsolete("The provider argument is not used. Please use ToString().")>] + + [System.Obsolete("The provider argument is not used. Use ToString() instead.")] + [<System.Obsolete("The provider argument is not used. Use ToString() instead.")>] + System.String @@ -3643,10 +3647,14 @@ thisInstance And flag = flag 6.0.0.0 - + [System.Obsolete("The provider argument is not used. Please use ToString(String).")] [<System.Obsolete("The provider argument is not used. Please use ToString(String).")>] + + [System.Obsolete("The provider argument is not used. Use ToString(String) instead.")] + [<System.Obsolete("The provider argument is not used. Use ToString(String) instead.")>] + System.String @@ -3886,7 +3894,7 @@ thisInstance And flag = flag - To be added. + The type of the object. The span representation of the name or numeric value of one or more enumerated constants. When this method returns , an object containing an enumeration constant representing the parsed value. Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. @@ -4018,7 +4026,7 @@ thisInstance And flag = flag - To be added. + The type of the object. The span representation of the name or numeric value of one or more enumerated constants. to ignore case; to consider case. diff --git a/xml/System/ExecutionEngineException.xml b/xml/System/ExecutionEngineException.xml index a3597a26c54..7931c979140 100644 --- a/xml/System/ExecutionEngineException.xml +++ b/xml/System/ExecutionEngineException.xml @@ -36,10 +36,14 @@ - + [System.Obsolete("This type previously indicated an unspecified fatal error in the runtime. The runtime no longer raises this exception so this type is obsolete.")] [<System.Obsolete("This type previously indicated an unspecified fatal error in the runtime. The runtime no longer raises this exception so this type is obsolete.")>] + + [System.Obsolete("ExecutionEngineException previously indicated an unspecified fatal error in the runtime. The runtime no longer raises this exception so this type is obsolete.")] + [<System.Obsolete("ExecutionEngineException previously indicated an unspecified fatal error in the runtime. The runtime no longer raises this exception so this type is obsolete.")>] + [System.Serializable] [<System.Serializable>] diff --git a/xml/System/HashCode.xml b/xml/System/HashCode.xml index 1ae58a22abe..ca2da854d23 100644 --- a/xml/System/HashCode.xml +++ b/xml/System/HashCode.xml @@ -16,12 +16,7 @@ netstandard 2.1.0.0 - - Microsoft.Bcl.HashCode - - - @@ -119,13 +114,13 @@ The structure must be passed by-reference to other method - + - + Method System.Runtime @@ -185,9 +180,18 @@ This value can be a null reference (Nothing in Visual Basic), which will use the - To be added. - To be added. - To be added. + The span to add. + Adds a span of bytes to the hash code. + + + @@ -617,13 +621,13 @@ This value can be a null reference (Nothing in Visual Basic), which will use the - + - + Method System.Runtime diff --git a/xml/System/IntPtr.xml b/xml/System/IntPtr.xml index 6f11c818544..688392dc358 100644 --- a/xml/System/IntPtr.xml +++ b/xml/System/IntPtr.xml @@ -1479,12 +1479,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of characters containing a number to convert. + A bitwise combination of the enumeration values that indicates the style elements that can be present in . + An object that supplies culture-specific formatting information about . + Converts the read-only span of characters representation of a number in a specified style and culture-specific format to its signed native integer equivalent. + A signed native integer equivalent to the number contained in . To be added. + + is not a value or is not a combination of and values. + + is not in the correct format. + + represents a number less than or greater than . @@ -2193,12 +2199,13 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The span where this instance's value formatted as a span of characters should be written. + When this method returns, contains the number of characters that were written in . + The characters that represent a standard or custom format string that defines the acceptable format for . + An optional object that supplies culture-specific formatting information for . + Tries to format the value of the current instance into the provided span of characters. + + if the formatting was successful; otherwise, . To be added. @@ -2228,10 +2235,11 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. + A read-only span of characters containing a number to convert. + When this method returns, contains the signed native integer equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + Converts the read-only span of characters representation of a number to its signed native integer equivalent. A return value indicates whether the conversion succeeded. + + if was converted successfully; otherwise, . To be added. @@ -2263,7 +2271,7 @@ This member is an explicit interface member implementation. It can be used only A string containing a number to convert. - When this method returns, contains the signed native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or Empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + When this method returns, contains the signed native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. Converts the string representation of a number to its signed native integer equivalent. A return value indicates whether the conversion succeeded. if was converted successfully; otherwise, . @@ -2298,12 +2306,13 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of characters containing a number to convert. The string is interpreted using the style specified by . + A bitwise combination of enumeration values that indicates the style elements that can be present in . + An object that supplies culture-specific formatting information about . + When this method returns, contains the signed native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + Converts the read-only span of characters representation of a number in a specified style and culture-specific format to its signed native integer equivalent. A return value indicates whether the conversion succeeded. + + if was converted successfully; otherwise, . To be added. @@ -2339,7 +2348,7 @@ This member is an explicit interface member implementation. It can be used only A string containing a number to convert. The string is interpreted using the style specified by . A bitwise combination of enumeration values that indicates the style elements that can be present in . An object that supplies culture-specific formatting information about . - When this method returns, contains the signed native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or Empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + When this method returns, contains the signed native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. Converts the string representation of a number in a specified style and culture-specific format to its signed native integer equivalent. A return value indicates whether the conversion succeeded. if was converted successfully; otherwise, . diff --git a/xml/System/LoaderOptimization.xml b/xml/System/LoaderOptimization.xml index 133de44ae9c..6c289cf7440 100644 --- a/xml/System/LoaderOptimization.xml +++ b/xml/System/LoaderOptimization.xml @@ -99,10 +99,14 @@ 6.0.0.0 - + [System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("LoaderOptimization.DisallowBindings has been deprecated and is not supported.")] + [<System.Obsolete("LoaderOptimization.DisallowBindings has been deprecated and is not supported.")>] + [System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -148,10 +152,14 @@ 6.0.0.0 - + [System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("LoaderOptimization.DomainMask has been deprecated and is not supported.")] + [<System.Obsolete("LoaderOptimization.DomainMask has been deprecated and is not supported.")>] + [System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("This method has been deprecated. Please use Assembly.Load() instead. http://go.microsoft.com/fwlink/?linkid=14202")>] diff --git a/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml b/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml index 0c3b433675b..a201c4c2549 100644 --- a/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml +++ b/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml @@ -31,7 +31,7 @@ - To be added. + Provides a handler used by the language compiler to format interpolated strings into character spans. To be added. @@ -54,12 +54,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The number of constant characters outside of interpolation expressions in the interpolated string. + The number of interpolation expressions in the interpolated string. + The destination buffer. + Upon return, if the destination may be long enough to support the formatting, or if it won't be. + Creates a handler used to write an interpolated string into a span of characterss. + This is intended to be called only by compiler-generated code. Arguments are not validated as they'd otherwise be for members intended to be used directly. @@ -82,13 +82,13 @@ - To be added. - To be added. - To be added. + The number of constant characters outside of interpolation expressions in the interpolated string. + The number of interpolation expressions in the interpolated string. + The destination buffer. To be added. - To be added. - To be added. - To be added. + Upon return, if the destination may be long enough to support the formatting, or if it won't be. + Creates a handler used to write an interpolated string into a span of characters. + This is intended to be called only by compiler-generated code. Arguments are not validated as they'd otherwise be for members intended to be used directly. @@ -110,9 +110,9 @@ - To be added. - To be added. - To be added. + The value to write. + Writes the specified value to the handler. + if the operation failed; otherwise. To be added. @@ -135,9 +135,10 @@ - To be added. - To be added. - To be added. + The value to write. + Writes the specified value to the handler. + + on success; otherwise. To be added. @@ -161,11 +162,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The value to write. + The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value. + The format string. + Writes the specified value to the handler. + + on success; otherwise. To be added. @@ -189,11 +191,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The value to write. + >The minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value. + The format string. + Writes the specified value to the handler. + if the operation failed; otherwise. To be added. @@ -217,11 +219,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The value to write. + The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value. + The format string. + Writes a specified value to the handler using a specified format string. + + on success; otherwise. To be added. @@ -247,10 +250,11 @@ - To be added. - To be added. - To be added. - To be added. + The type of the value to write. + The value to write. + Writes the specified value to the handler. + + on success; otherwise. To be added. @@ -277,11 +281,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to write. + The value to write. + The minimum number of characters that should be written for this value.A negative value indicates left-aligned, and the required minimum is the absolute value. + Writes the specified value to the handler. + if the operation failed; otherwise. To be added. @@ -308,11 +312,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to write. + The value to write. + The format string. + Writes a specified value to the handler using a specified format string. + + on success; otherwise. To be added. @@ -340,12 +345,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the value to write. + The value to write. + The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value. + The format string. + Writes a specified value to the handler using a specified format string. + + on success; otherwise. To be added. @@ -368,9 +374,10 @@ - To be added. - To be added. - To be added. + The string to write. + Writes the specified string to the handler. + + if the value could be formatted to the span; otherwise, . To be added. diff --git a/xml/System/MemoryExtensions.xml b/xml/System/MemoryExtensions.xml index ad810445832..8b20c544b8b 100644 --- a/xml/System/MemoryExtensions.xml +++ b/xml/System/MemoryExtensions.xml @@ -1805,7 +1805,7 @@ If `source` and `destination` overlap, this method behaves as if the original va - To be added. + A span containing the lines to enumerate. Returns an enumeration of lines over the provided span. An enumeration of lines. @@ -1843,7 +1843,7 @@ It is recommended that protocol parsers not utilize this API. See the documentat - To be added. + A span containing the lines to enumerate. Returns an enumeration of lines over the provided span. An enumeration of lines. @@ -3365,7 +3365,7 @@ Invalid sequences will be represented in the enumeration by - To be added. + The type of elements in the sequence. The first sequence to compare. The second sequence to compare. The implementation to use when comparing elements, or to use the default for the type of an element. @@ -3401,7 +3401,7 @@ Invalid sequences will be represented in the enumeration by - To be added. + The type of elements in the sequence. The first sequence to compare. The second sequence to compare. The implementation to use when comparing elements, or to use the default for the type of an element. @@ -5664,11 +5664,12 @@ If `trimElements` is empty, the span is returned unaltered. - To be added. - To be added. - To be added. - To be added. - To be added. + The span to which the interpolated string should be formatted. + The interpolated string, passed by reference. + When this method returns, contains the number of characters written to the span. + Writes the specified interpolated string to the character span. + + if the entire interpolated string could be formatted successfully; otherwise, . To be added. @@ -5704,12 +5705,13 @@ If `trimElements` is empty, the span is returned unaltered. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The span to which the interpolated string should be formatted. + An object that supplies culture-specific formatting information. + The interpolated string, passed by reference. + When this method returns, contains the number of characters written to the span. + Writes the specified interpolated string to the character span. + + if the entire interpolated string could be formatted successfully; otherwise, . To be added. diff --git a/xml/System/ReadOnlySpan`1.xml b/xml/System/ReadOnlySpan`1.xml index 1923ab7670f..d7e95641b65 100644 --- a/xml/System/ReadOnlySpan`1.xml +++ b/xml/System/ReadOnlySpan`1.xml @@ -287,10 +287,14 @@ This method returns `default` when `array` is `null`. [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("Equals() on ReadOnlySpan will always throw an exception. Use == instead.")] [<System.Obsolete("Equals() on ReadOnlySpan will always throw an exception. Use == instead.")>] + + [System.Obsolete("Equals() on ReadOnlySpan will always throw an exception. Use the equality operator instead.")] + [<System.Obsolete("Equals() on ReadOnlySpan will always throw an exception. Use the equality operator instead.")>] + System.Boolean diff --git a/xml/System/Span`1.xml b/xml/System/Span`1.xml index 2d1c0d6cdba..d1d960412d1 100644 --- a/xml/System/Span`1.xml +++ b/xml/System/Span`1.xml @@ -386,10 +386,14 @@ This method copies all of `source` to `destination` even if `source` and `destin [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - + [System.Obsolete("Equals() on Span will always throw an exception. Use == instead.")] [<System.Obsolete("Equals() on Span will always throw an exception. Use == instead.")>] + + [System.Obsolete("Equals() on Span will always throw an exception. Use the equality operator instead.")] + [<System.Obsolete("Equals() on Span will always throw an exception. Use the equality operator instead.")>] + System.Boolean diff --git a/xml/System/String.xml b/xml/System/String.xml index 34cdaf832c9..145c320c279 100644 --- a/xml/System/String.xml +++ b/xml/System/String.xml @@ -4587,10 +4587,10 @@ Depending on Why you want to call the `Copy` method, there are a number of alter - To be added. - To be added. - To be added. - To be added. + An object that supplies culture-specific formatting information. + The interpolated string, passed by reference. + Creates a new string by using the specified provider to control the formatting of the specified interpolated string. + The string that results for formatting the interpolated string using the specified format provider. To be added. @@ -4628,11 +4628,11 @@ Depending on Why you want to call the `Copy` method, there are a number of alter - To be added. - To be added. - To be added. - To be added. - To be added. + An object that supplies culture-specific formatting information. + The initial buffer that may be used as temporary space as part of the formatting operation. The contents of this buffer may be overwritten. + The interpolated string, passed by reference. + Creates a new string by using the specified provider to control the formatting of the specified interpolated string. + The string that results for formatting the interpolated string using the specified format provider. To be added. @@ -11420,7 +11420,7 @@ This method searches for all newline sequences within the string and canonicaliz - To be added. + The text to use as replacement. Replaces all newline sequences in the current string with . A string whose contents match the current string, but with all newline sequences replaced with . diff --git a/xml/System/TimeZone.xml b/xml/System/TimeZone.xml index c4f8b00fbbb..abdbed3439b 100644 --- a/xml/System/TimeZone.xml +++ b/xml/System/TimeZone.xml @@ -36,10 +36,14 @@ - + [System.Obsolete("System.TimeZone has been deprecated. Please investigate the use of System.TimeZoneInfo instead.")] [<System.Obsolete("System.TimeZone has been deprecated. Please investigate the use of System.TimeZoneInfo instead.")>] + + [System.Obsolete("System.TimeZone has been deprecated. Investigate the use of System.TimeZoneInfo instead.")] + [<System.Obsolete("System.TimeZone has been deprecated. Investigate the use of System.TimeZoneInfo instead.")>] + [System.Serializable] [<System.Serializable>] diff --git a/xml/System/Type.xml b/xml/System/Type.xml index e87855aee53..ef2726240f6 100644 --- a/xml/System/Type.xml +++ b/xml/System/Type.xml @@ -15133,6 +15133,12 @@ If the value of this property is `true` for an array type, it can be used to cre 2.0.0.0 2.1.0.0 + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("If some of the generic arguments are annotated (either with DynamicallyAccessedMembersAttribute, or generic constraints), trimming can't validate that the requirements of those annotations are met.")>] + + System.Type diff --git a/xml/System/UIntPtr.xml b/xml/System/UIntPtr.xml index d4ba6151209..4fa8aeaec93 100644 --- a/xml/System/UIntPtr.xml +++ b/xml/System/UIntPtr.xml @@ -1339,12 +1339,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of characters containing a number to convert. + An optional bitwise combination of the enumeration values that indicates the style elements that can be present in . The default value is . + An optional object that supplies culture-specific formatting information about . The default value is . + Converts the read-only span of characters representation of a number in optionally specified style and optionally specified culture-specific format to its unsigned native integer equivalent. + An unsigned native integer equivalent to the number contained in . To be added. + + is not a value or is not a combination of and values. + + is not in the correct format. + + represents a number less than or greater than . @@ -1989,10 +1995,11 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. + A read-only span of characters containing a number to convert. + When this method returns, contains the unsigned native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + Converts the read-only span of characters representation of a number to its unsigned native integer equivalent. A return value indicates whether the conversion succeeded. + + if was converted successfully; otherwise, . To be added. @@ -2024,7 +2031,7 @@ This member is an explicit interface member implementation. It can be used only A string containing a number to convert. - When this method returns, contains the unsigned native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or Empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + When this method returns, contains the unsigned native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. Converts the string representation of a number to its unsigned native integer equivalent. A return value indicates whether the conversion succeeded. if was converted successfully; otherwise, . @@ -2059,12 +2066,13 @@ This member is an explicit interface member implementation. It can be used only - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of characters containing a number to convert. The span is interpreted using the style specified by . + A bitwise combination of enumeration values that indicates the style elements that can be present in . + An object that supplies culture-specific formatting information about . + When this method returns, contains the unsigned native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + Converts the read-only span of characters representation of a number in a specified style and culture-specific format to its unsigned native integer equivalent. A return value indicates whether the conversion succeeded. + + if was converted successfully; otherwise, . To be added. @@ -2100,7 +2108,7 @@ This member is an explicit interface member implementation. It can be used only A string containing a number to convert. The string is interpreted using the style specified by . A bitwise combination of enumeration values that indicates the style elements that can be present in . An object that supplies culture-specific formatting information about . - When this method returns, contains the unsigned native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or Empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. + When this method returns, contains the unsigned native integer value equivalent of the number contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or empty, is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in result will be overwritten. Converts the string representation of a number in a specified style and culture-specific format to its unsigned native integer equivalent. A return value indicates whether the conversion succeeded. if was converted successfully; otherwise, . diff --git a/xml/System/Uri.xml b/xml/System/Uri.xml index 19b23ee3662..4cb4b278d2c 100644 --- a/xml/System/Uri.xml +++ b/xml/System/Uri.xml @@ -503,10 +503,14 @@ The following code snippet shows example values of the various properties on the 6.0.0.0 - + [System.Obsolete("The constructor has been deprecated. Please use new Uri(string). The dontEscape parameter is deprecated and is always false. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The constructor has been deprecated. Please use new Uri(string). The dontEscape parameter is deprecated and is always false. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated; the dontEscape parameter is always false. Use Uri(string) instead.")] + [<System.Obsolete("This constructor has been deprecated; the dontEscape parameter is always false. Use Uri(string) instead.")>] + [System.Obsolete("The constructor has been deprecated. Please use new Uri(string). The dontEscape parameter is deprecated and is always false. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The constructor has been deprecated. Please use new Uri(string). The dontEscape parameter is deprecated and is always false. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -976,10 +980,14 @@ The URI formed by combining and + [System.Obsolete("The constructor has been deprecated. Please new Uri(Uri, string). The dontEscape parameter is deprecated and is always false. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The constructor has been deprecated. Please new Uri(Uri, string). The dontEscape parameter is deprecated and is always false. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("This constructor has been deprecated; the dontEscape parameter is always false. Use Uri(Uri, string) instead.")] + [<System.Obsolete("This constructor has been deprecated; the dontEscape parameter is always false. Use Uri(Uri, string) instead.")>] + [System.Obsolete("The constructor has been deprecated. Please new Uri(Uri, string). The dontEscape parameter is deprecated and is always false. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The constructor has been deprecated. Please new Uri(Uri, string). The dontEscape parameter is deprecated and is always false. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1272,10 +1280,14 @@ The URI formed by combining and + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.Canonicalize has been deprecated and is not supported.")] + [<System.Obsolete("Uri.Canonicalize has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1451,10 +1463,14 @@ The URI formed by combining and + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.CheckSecurity has been deprecated and is not supported.")] + [<System.Obsolete("Uri.CheckSecurity has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1749,10 +1765,14 @@ If you used an escaped string to construct this instance (for example, `"http:// 6.0.0.0 - + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.Escape has been deprecated and is not supported.")] + [<System.Obsolete("Uri.Escape has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -1865,8 +1885,8 @@ If you used an escaped string to construct this instance (for example, `"http:// [<System.Obsolete("The method has been deprecated. Please use GetComponents() or static EscapeUriString() to escape a Uri component or a string. https://go.microsoft.com/fwlink/?linkid=14202")>] - [System.Obsolete("The method has been deprecated. Please use GetComponents() or static EscapeDataString() to escape a Uri component or a string. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("The method has been deprecated. Please use GetComponents() or static EscapeDataString() to escape a Uri component or a string. https://go.microsoft.com/fwlink/?linkid=14202")>] + [System.Obsolete("Uri.EscapeString has been deprecated. Use GetComponents() or static EscapeDataString() to escape a Uri component or a string.")] + [<System.Obsolete("Uri.EscapeString has been deprecated. Use GetComponents() or static EscapeDataString() to escape a Uri component or a string.")>] [System.Obsolete("The method has been deprecated. Please use GetComponents() or static EscapeUriString() to escape a Uri component or a string. http://go.microsoft.com/fwlink/?linkid=14202")] @@ -1930,8 +1950,8 @@ If you used an escaped string to construct this instance (for example, `"http:// - [System.Obsolete("Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components instead.", DiagnosticId="SYSLIB0013", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Obsolete("Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components instead.", DiagnosticId="SYSLIB0013", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + [System.Obsolete("Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components.", DiagnosticId="SYSLIB0013", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Obsolete("Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components.", DiagnosticId="SYSLIB0013", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -2664,10 +2684,14 @@ The length of exceeds 32766 characters.6.0.0.0 - + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.IsBadFileSystemCharacter has been deprecated and is not supported.")] + [<System.Obsolete("Uri.IsBadFileSystemCharacter has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -2853,10 +2877,14 @@ The length of exceeds 32766 characters.6.0.0.0 - + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.IsExcludedCharacter has been deprecated and is not supported.")] + [<System.Obsolete("Uri.IsExcludedCharacter has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -3133,10 +3161,14 @@ The length of exceeds 32766 characters.6.0.0.0 - + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.IsReservedCharacter has been deprecated and is not supported.")] + [<System.Obsolete("Uri.IsReservedCharacter has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -3439,10 +3471,14 @@ The length of exceeds 32766 characters.6.0.0.0 - + [System.Obsolete("The method has been deprecated. Please use MakeRelativeUri(Uri uri). https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. Please use MakeRelativeUri(Uri uri). https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.MakeRelative has been deprecated. Use MakeRelativeUri(Uri uri).")] + [<System.Obsolete("Uri.MakeRelative has been deprecated. Use MakeRelativeUri(Uri uri).")>] + [System.Obsolete("The method has been deprecated. Please use MakeRelativeUri(Uri uri). http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. Please use MakeRelativeUri(Uri uri). http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -3776,10 +3812,14 @@ The length of exceeds 32766 characters.6.0.0.0 - + [System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.Parse has been deprecated and is not supported.")] + [<System.Obsolete("Uri.Parse has been deprecated and is not supported.")>] + [System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. It is not used by the system. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -4505,10 +4545,14 @@ The length of exceeds 32766 characters.6.0.0.0 - + [System.Obsolete("The method has been deprecated. Please use GetComponents() or static UnescapeDataString() to unescape a Uri component or a string. https://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. Please use GetComponents() or static UnescapeDataString() to unescape a Uri component or a string. https://go.microsoft.com/fwlink/?linkid=14202")>] + + [System.Obsolete("Uri.Unescape has been deprecated. Use GetComponents() or Uri.UnescapeDataString() to unescape a Uri component or a string.")] + [<System.Obsolete("Uri.Unescape has been deprecated. Use GetComponents() or Uri.UnescapeDataString() to unescape a Uri component or a string.")>] + [System.Obsolete("The method has been deprecated. Please use GetComponents() or static UnescapeDataString() to unescape a Uri component or a string. http://go.microsoft.com/fwlink/?linkid=14202")] [<System.Obsolete("The method has been deprecated. Please use GetComponents() or static UnescapeDataString() to unescape a Uri component or a string. http://go.microsoft.com/fwlink/?linkid=14202")>] @@ -4708,7 +4752,7 @@ The length of exceeds 32766 characters.System.String - To be added. + Specifies that the URI is accessed through the File Transfer Protocol Secure (FTPS). This field is read-only. To be added. @@ -5089,7 +5133,7 @@ The length of exceeds 32766 characters.System.String - To be added. + Specifies that the URI is accessed through the SSH File Transfer Protocol (SFTP). This field is read-only. To be added. @@ -5115,7 +5159,7 @@ The length of exceeds 32766 characters.System.String - To be added. + Specifies that the URI is accessed through the Secure Socket Shell protocol (SSH). This field is read-only. To be added. @@ -5141,7 +5185,7 @@ The length of exceeds 32766 characters.System.String - To be added. + Specifies that the URI is accessed through the Telnet protocol. This field is read-only. To be added. @@ -5167,7 +5211,7 @@ The length of exceeds 32766 characters.System.String - To be added. + Specifies that the URI is accessed through the WebSocket protocol (WS). This field is read-only. To be added. @@ -5193,7 +5237,7 @@ The length of exceeds 32766 characters.System.String - To be added. + Specifies that the URI is accessed through the WebSocket Secure protocol (WSS). This field is read-only. To be added. diff --git a/xml/ns-Microsoft.Extensions.Http.Logging.xml b/xml/ns-Microsoft.Extensions.Http.Logging.xml index 67b82b1aaa8..5ed25a9e812 100644 --- a/xml/ns-Microsoft.Extensions.Http.Logging.xml +++ b/xml/ns-Microsoft.Extensions.Http.Logging.xml @@ -1,6 +1,6 @@ - To be added. + Contains classes used for logging in . To be added. diff --git a/xml/ns-Microsoft.Extensions.Http.xml b/xml/ns-Microsoft.Extensions.Http.xml index d262930bd47..a6dc9642e7c 100644 --- a/xml/ns-Microsoft.Extensions.Http.xml +++ b/xml/ns-Microsoft.Extensions.Http.xml @@ -1,6 +1,6 @@ - To be added. + Contains classes and abstractions used for configuring and in . To be added. diff --git a/xml/ns-System.Diagnostics.Metrics.xml b/xml/ns-System.Diagnostics.Metrics.xml index cf46518350e..ddce0c9f8f3 100644 --- a/xml/ns-System.Diagnostics.Metrics.xml +++ b/xml/ns-System.Diagnostics.Metrics.xml @@ -1,6 +1,6 @@ - To be added. + Metrics are numerical measurements reported over time, most often used to monitor the health of an application and generate alerts. For example, a web service might track how many requests it receives each second, how many milliseconds it took to respond, and how many of the responses sent an error back to the user. These metrics can be reported to a monitoring system at frequent, regular intervals. The System.Diagnostics.Metrics namespace can be used to add metrics to an application. The APIs work on all platforms supported by .NET and are designed to integrate well with OpenTelemetry's growing ecosystem of tools. They also integrate with .NET SDK tools, such as dotnet-counters. A listener API is available for developers that want to create custom tooling or adapters to other systems. To be added. diff --git a/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml b/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml index 00bfa915bcf..b3c6a4ff5fc 100644 --- a/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml +++ b/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml @@ -1,6 +1,6 @@ - To be added. + Contains classes that support interoperation between managed code and the Objective-C Runtime. To be added. diff --git a/xml/ns-System.Text.Json.Nodes.xml b/xml/ns-System.Text.Json.Nodes.xml index 3a4a26cc51b..a2772857f4d 100644 --- a/xml/ns-System.Text.Json.Nodes.xml +++ b/xml/ns-System.Text.Json.Nodes.xml @@ -1,6 +1,6 @@ - To be added. + Provides types for handling an in-memory writeable document object model (DOM) for random access of the JSON elements within a structured view of the data. To be added. diff --git a/xml/ns-System.Windows.Forms.Analyzers.xml b/xml/ns-System.Windows.Forms.Analyzers.xml new file mode 100644 index 00000000000..f1747197e82 --- /dev/null +++ b/xml/ns-System.Windows.Forms.Analyzers.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + +