From e4a52dc5d2749c6ff37ff7984a72626802257a39 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Sat, 21 Aug 2021 01:02:55 +0000 Subject: [PATCH 01/28] CI Update Build.Reason:Manual by Genevieve Warren Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=248605&view=results source_repo.branch:net6-rc1 source_repo.url:https://apidrop.visualstudio.com/_git/binaries --- xml/FrameworksIndex/dotnet-plat-ext-6.0.xml | 37 +- xml/FrameworksIndex/net-6.0.xml | 121 ++- .../DeployManifest.xml | 2 +- xml/Microsoft.Build.Tasks/CreateProperty.xml | 4 +- xml/Microsoft.CSharp/CSharpCodeProvider.xml | 12 +- .../HashCodeCombiner.xml | 6 +- ...ironmentVariablesConfigurationProvider.xml | 22 + .../BinderOptions.xml | 3 +- .../ServiceCollectionDescriptorExtensions.xml | 36 + .../ActivatorUtilities.xml | 18 +- .../OptionsBuilderExtensions.xml | 12 + .../ServiceCollectionServiceExtensions.xml | 36 + .../ServiceDescriptor.xml | 24 + .../PatternTestResult.xml | 12 + .../FilePatternMatch.xml | 12 + .../ConsoleLifetime.xml | 18 + .../EnvironmentName.xml | 6 +- .../HostingHostBuilderExtensions.xml | 72 ++ .../IApplicationLifetime.xml | 6 +- .../IHostingEnvironment.xml | 6 +- .../ConsoleLoggerFormat.xml | 6 +- .../ConsoleLoggerOptions.xml | 30 +- .../OptionsSnapshot`1.xml | 2 +- .../JSStreamReference.xml | 14 +- .../DotNetStreamReference.xml | 114 +++ xml/Microsoft.JSInterop/JSRuntime.xml | 27 + .../ApplyApplicationDefaultsEventArgs.xml | 95 ++ .../ApplyApplicationDefaultsEventHandler.xml | 34 + .../WindowsFormsApplicationBase.xml | 51 + .../Conversions.xml | 6 +- .../NewLateBinding.xml | 48 +- .../Operators.xml | 6 +- xml/Microsoft.VisualBasic/Constants.xml | 6 +- xml/Microsoft.VisualBasic/FileSystem.xml | 32 +- xml/Microsoft.VisualBasic/VBCodeProvider.xml | 12 +- xml/Microsoft.Win32/SystemEvents.xml | 6 +- .../CodeDomProvider.xml | 21 +- xml/System.CodeDom/CodeMemberMethod.xml | 12 +- xml/System.CodeDom/CodeNamespace.xml | 12 +- .../CodeNamespaceImportCollection.xml | 4 +- xml/System.CodeDom/CodeTypeDeclaration.xml | 8 +- xml/System.CodeDom/CodeTypeReference.xml | 6 +- xml/System.CodeDom/MemberAttributes.xml | 4 + .../NameObjectCollectionBase.xml | 12 +- .../NameValueCollection.xml | 12 +- .../CaseInsensitiveHashCodeProvider.xml | 6 +- xml/System.Collections/Hashtable.xml | 42 +- xml/System.Collections/IHashCodeProvider.xml | 6 +- .../AssemblyCatalog.xml | 2 +- .../CompositionScopeDefinition.xml | 10 +- .../DirectoryCatalog.xml | 10 +- .../ExportProvider.xml | 8 +- .../FilteredCatalog.xml | 8 +- .../TypeCatalog.xml | 2 +- .../ComposablePartCatalog.xml | 2 +- .../ComposablePartException.xml | 16 +- .../CompositionContractMismatchException.xml | 6 +- .../CompositionError.xml | 2 +- .../CompositionException.xml | 12 +- .../ImportCardinalityMismatchException.xml | 16 +- .../AssociationAttribute.xml | 6 +- .../FilterUIHintAttribute.xml | 6 +- .../RootDesignerSerializerAttribute.xml | 6 +- .../DesignerTransactionCloseEventArgs.xml | 4 +- .../SelectionTypes.xml | 30 +- .../ViewTechnology.xml | 12 +- xml/System.ComponentModel/TypeDescriptor.xml | 6 +- .../ProviderException.xml | 10 +- .../AppSettingsSection.xml | 88 +- .../ClientSettingsSection.xml | 11 +- .../ConfigurationElement.xml | 208 ++-- .../ConfigurationElementCollection.xml | 276 +++--- .../ConfigurationErrorsException.xml | 10 +- .../ConfigurationException.xml | 52 +- .../ConfigurationSection.xml | 128 +-- .../ConfigurationSectionCollection.xml | 12 +- .../ConfigurationSectionGroup.xml | 16 +- .../ConfigurationSectionGroupCollection.xml | 12 +- .../ConfigurationSettings.xml | 8 +- .../ConnectionStringSettings.xml | 18 +- .../ConnectionStringSettingsCollection.xml | 12 +- .../ConnectionStringsSection.xml | 30 +- xml/System.Configuration/DefaultSection.xml | 92 +- xml/System.Configuration/IdnElement.xml | 11 +- xml/System.Configuration/IgnoreSection.xml | 92 +- .../IriParsingElement.xml | 11 +- .../KeyValueConfigurationCollection.xml | 12 +- .../KeyValueConfigurationElement.xml | 32 +- .../NameValueConfigurationCollection.xml | 12 +- .../NameValueConfigurationElement.xml | 16 +- .../PropertyInformationCollection.xml | 12 +- .../ProtectedConfigurationSection.xml | 16 +- .../ProtectedProviderSettings.xml | 14 +- xml/System.Configuration/ProviderSettings.xml | 64 +- .../ProviderSettingsCollection.xml | 12 +- .../RsaProtectedConfigurationProvider.xml | 4 +- .../SchemeSettingElement.xml | 13 +- xml/System.Configuration/SettingElement.xml | 15 +- .../SettingValueElement.xml | 81 +- xml/System.Configuration/SettingsProperty.xml | 9 +- .../SettingsPropertyCollection.xml | 4 +- .../SettingsPropertyIsReadOnlyException.xml | 10 +- .../SettingsPropertyNotFoundException.xml | 10 +- .../SettingsPropertyValueCollection.xml | 4 +- .../SettingsPropertyWrongTypeException.xml | 10 +- .../SettingsSerializeAs.xml | 4 +- xml/System.Configuration/UriSection.xml | 19 +- xml/System.Data.Common/DataAdapter.xml | 6 +- .../DbBatchCommandCollection.xml | 57 +- xml/System.Data.Odbc/ODBC32+RETCODE.xml | 127 +++ xml/System.Data.Odbc/ODBC32.xml | 27 + xml/System.Data.Odbc/OdbcParameter.xml | 4 +- .../OdbcParameterCollection.xml | 6 +- .../OdbcPermissionAttribute.xml | 2 +- .../OleDbPermissionAttribute.xml | 2 +- .../SqlClientPermissionAttribute.xml | 2 +- .../DataSysDescriptionAttribute.xml | 12 +- .../StandardEventKeywords.xml | 6 +- xml/System.Diagnostics.Metrics/Counter`1.xml | 33 + .../Histogram`1.xml | 33 + .../Instrument`1.xml | 33 + .../ISymbolBinder.xml | 6 +- xml/System.Diagnostics/Debug.xml | 86 +- .../DebuggerVisualizerAttribute.xml | 12 + ...extPropagator+PropagatorSetterCallback.xml | 2 +- xml/System.Diagnostics/EventLog.xml | 6 +- xml/System.Diagnostics/EventLogEntry.xml | 6 +- .../InstanceDataCollection.xml | 6 +- .../InstanceDataCollectionCollection.xml | 6 +- xml/System.Diagnostics/PerformanceCounter.xml | 6 +- .../PerformanceCounterCategory.xml | 12 +- .../PerformanceCounterManager.xml | 18 +- xml/System.Diagnostics/Process.xml | 80 +- xml/System.Diagnostics/ProcessThread.xml | 20 + xml/System.Diagnostics/TagList+Enumerator.xml | 153 +++ xml/System.Diagnostics/TagList.xml | 522 ++++++++++ .../SystemDrawingSection.xml | 15 +- xml/System.Drawing.Design/ToolboxItem.xml | 6 + .../EncoderParameter.xml | 6 +- xml/System.Drawing/FontFamily.xml | 6 +- xml/System.Globalization/CultureTypes.xml | 12 +- xml/System.IO.Compression/ZLibStream.xml | 33 +- .../IsolatedStorage.xml | 12 +- .../IsolatedStorageFile.xml | 12 +- .../IsolatedStorageFileStream.xml | 6 +- xml/System.IO.Packaging/PackUriHelper.xml | 4 +- xml/System.IO.Pipelines/PipeReader.xml | 6 +- xml/System.IO.Pipelines/PipeWriter.xml | 6 +- .../AnonymousPipeServerStreamAcl.xml | 2 +- .../NamedPipeServerStreamAcl.xml | 2 +- xml/System.IO/FileFormatException.xml | 9 +- xml/System.IO/FileStream.xml | 38 +- xml/System.IO/FileStreamOptions.xml | 4 +- xml/System.IO/Path.xml | 6 +- xml/System.IO/Stream.xml | 6 +- xml/System.IO/StreamReader.xml | 23 +- xml/System.IO/StreamWriter.xml | 20 +- xml/System.Linq.Expressions/Expression.xml | 32 +- xml/System.Linq.Expressions/MemberBinding.xml | 6 +- xml/System.Net.Http/HttpClientHandler.xml | 222 ----- xml/System.Net.Http/HttpRequestMessage.xml | 6 +- xml/System.Net.Http/WinHttpHandler.xml | 18 - xml/System.Net.Mail/MailMessage.xml | 6 +- .../IPGlobalProperties.xml | 10 + .../NetworkInterface.xml | 20 + .../SslApplicationProtocol.xml | 23 + xml/System.Net.Sockets/Socket.xml | 16 +- .../SocketInformationOptions.xml | 4 +- xml/System.Net.Sockets/TcpListener.xml | 6 +- xml/System.Net.WebSockets/WebSocket.xml | 4 + xml/System.Net/Dns.xml | 48 +- xml/System.Net/FileWebRequest.xml | 6 +- xml/System.Net/FileWebResponse.xml | 6 +- xml/System.Net/GlobalProxySelection.xml | 6 +- xml/System.Net/HttpWebRequest.xml | 16 +- xml/System.Net/HttpWebResponse.xml | 18 +- xml/System.Net/IPAddress.xml | 6 +- xml/System.Net/SecurityProtocolType.xml | 6 +- xml/System.Net/WebProxy.xml | 6 +- xml/System.Numerics/BitOperations.xml | 12 +- .../CustomReflectionContext.xml | 18 +- .../AssemblyBuilder.xml | 8 + xml/System.Reflection.Emit/FlowControl.xml | 6 +- .../GenericTypeParameterBuilder.xml | 6 + xml/System.Reflection.Emit/MethodBuilder.xml | 6 + xml/System.Reflection.Emit/ModuleBuilder.xml | 8 + xml/System.Reflection.Emit/OpCodeType.xml | 6 +- xml/System.Reflection.Emit/OperandType.xml | 6 +- xml/System.Reflection.Emit/TypeBuilder.xml | 16 + .../AssemblyExtensions.xml | 32 - .../DebugDirectoryBuilder.xml | 2 +- xml/System.Reflection/Assembly.xml | 42 +- .../AssemblyFlagsAttribute.xml | 18 +- xml/System.Reflection/MethodInfo.xml | 6 + xml/System.Reflection/Module.xml | 12 + .../NullabilityInfoContext.xml | 24 - .../DeserializingResourceReader.xml | 4 +- .../PreserializedResourceWriter.xml | 4 +- .../RuntimeHelpers.xml | 10 +- ...ocessCorruptedStateExceptionsAttribute.xml | 4 + .../CollectionsMarshal.xml | 2 +- .../ComWrappers.xml | 24 +- .../PosixSignalRegistration.xml | 4 - .../RuntimeEnvironment.xml | 12 +- .../UnmanagedType.xml | 6 +- .../AssemblyDependencyResolver.xml | 4 - .../RequiresPreviewFeaturesAttribute.xml | 63 ++ xml/System.Runtime/DependentHandle.xml | 3 +- xml/System.Runtime/JitInfo.xml | 9 +- .../SslProtocols.xml | 18 +- .../CmsSigner.xml | 6 +- .../Pkcs9LocalKeyId.xml | 24 + .../SignedCms.xml | 2 +- .../SignerInfo.xml | 6 +- .../DSACertificateExtensions.xml | 4 - .../PublicKey.xml | 4 - .../X509Certificate.xml | 12 +- .../CryptoSignedXmlRecursionException.xml | 116 +++ .../DSAKeyValue.xml | 4 - .../EncryptionPropertyCollection.xml | 4 +- .../ReferenceList.xml | 4 +- xml/System.Security.Cryptography/AesCcm.xml | 4 - xml/System.Security.Cryptography/AesGcm.xml | 4 - .../ChaCha20Poly1305.xml | 4 - xml/System.Security.Cryptography/DSA.xml | 12 - .../HMACSHA384.xml | 4 +- .../HMACSHA512.xml | 4 +- xml/System.Security.Cryptography/RC2.xml | 4 + .../Rfc2898DeriveBytes.xml | 4 + .../HostProtectionResource.xml | 4 + .../ReflectionPermissionAttribute.xml | 12 +- .../ReflectionPermissionFlag.xml | 18 +- .../RegistryPermissionAttribute.xml | 6 +- xml/System.Security.Policy/Evidence.xml | 36 +- .../FirstMatchCodeGroup.xml | 6 +- .../PermissionRequestEvidence.xml | 6 +- .../PolicyException.xml | 10 +- xml/System.Security.Policy/PolicyLevel.xml | 26 +- .../PolicyStatement.xml | 2 +- xml/System.Security.Policy/UnionCodeGroup.xml | 6 +- .../UrlMembershipCondition.xml | 3 +- .../ZoneMembershipCondition.xml | 3 +- .../HostProtectionException.xml | 21 +- xml/System.Security/SecurityContext.xml | 6 + .../SecurityTreatAsSafeAttribute.xml | 6 +- xml/System.Security/XmlSyntaxException.xml | 10 +- ...iceControllerPermissionEntryCollection.xml | 15 +- xml/System.Text.Json.Nodes/JsonNode.xml | 16 +- .../JsonMetadataServices.xml | 41 +- .../JsonObjectInfoValues`1.xml | 169 ++++ .../JsonParameterInfoValues.xml | 144 +++ .../JsonConverter`1.xml | 57 ++ .../JsonSourceGenerationOptionsAttribute.xml | 8 +- xml/System.Text.Json/JsonSerializer.xml | 889 +++++++++++++++++- xml/System.Text.Json/Utf8JsonWriter.xml | 9 +- .../Capture.xml | 27 + .../ChannelReader`1.xml | 3 +- xml/System.Threading/Overlapped.xml | 24 +- xml/System.Threading/Thread.xml | 30 +- xml/System.Threading/ThreadPool.xml | 6 +- xml/System.Threading/WaitHandle.xml | 6 +- .../AppManifestAnalyzer.xml | 90 ++ .../HighDpiMode.xml | 145 +++ xml/System.Windows.Forms.Design/EventsTab.xml | 12 +- .../PropertyTab.xml | 21 +- xml/System.Windows.Forms/Application.xml | 6 + xml/System.Windows.Forms/Control.xml | 35 + ...dViewColumnDividerDoubleClickEventArgs.xml | 3 +- xml/System.Windows.Forms/Form.xml | 27 + .../ProfessionalColorTable.xml | 21 + .../ProfessionalColors.xml | 21 + .../XamlLoadPermission.xml | 12 + xml/System.Xml.Linq/XElement.xml | 24 +- xml/System.Xml.Schema/XmlSchema.xml | 12 +- xml/System.Xml.Schema/XmlSchemaAttribute.xml | 6 +- xml/System.Xml.Schema/XmlSchemaCollection.xml | 6 +- xml/System.Xml.Schema/XmlSchemaElement.xml | 6 +- xml/System.Xml.Schema/XmlSchemaType.xml | 6 +- xml/System.Xml/ValidationType.xml | 12 +- xml/System.Xml/XmlConvert.xml | 12 +- xml/System.Xml/XmlDataDocument.xml | 6 +- xml/System.Xml/XmlReaderSettings.xml | 6 +- xml/System.Xml/XmlTextReader.xml | 6 +- xml/System.Xml/XmlValidatingReader.xml | 6 +- xml/System/AppDomain.xml | 48 +- xml/System/Char.xml | 3 +- xml/System/Console.xml | 108 --- xml/System/DateOnly.xml | 9 + xml/System/Enum.xml | 12 +- xml/System/ExecutionEngineException.xml | 6 +- xml/System/LoaderOptimization.xml | 12 +- xml/System/MemoryExtensions.xml | 4 +- xml/System/OperatingSystem.xml | 6 +- xml/System/ReadOnlySpan`1.xml | 6 +- xml/System/Span`1.xml | 6 +- xml/System/TimeOnly.xml | 13 +- xml/System/TimeZone.xml | 6 +- xml/System/Type.xml | 6 + xml/System/Uri.xml | 74 +- xml/ns-System.Windows.Forms.Analyzers.xml | 6 + 300 files changed, 5973 insertions(+), 1848 deletions(-) create mode 100644 xml/Microsoft.JSInterop/DotNetStreamReference.xml create mode 100644 xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventArgs.xml create mode 100644 xml/Microsoft.VisualBasic.ApplicationServices/ApplyApplicationDefaultsEventHandler.xml create mode 100644 xml/System.Data.Odbc/ODBC32+RETCODE.xml create mode 100644 xml/System.Data.Odbc/ODBC32.xml create mode 100644 xml/System.Diagnostics/TagList+Enumerator.xml create mode 100644 xml/System.Diagnostics/TagList.xml create mode 100644 xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml create mode 100644 xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml create mode 100644 xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml create mode 100644 xml/System.Windows.Forms.Analyzers/AppManifestAnalyzer.xml create mode 100644 xml/System.Windows.Forms.Analyzers/HighDpiMode.xml create mode 100644 xml/ns-System.Windows.Forms.Analyzers.xml 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/net-6.0.xml b/xml/FrameworksIndex/net-6.0.xml index a2962895474..8f0579fdcae 100644 --- a/xml/FrameworksIndex/net-6.0.xml +++ b/xml/FrameworksIndex/net-6.0.xml @@ -163,6 +163,8 @@ + + @@ -336,6 +338,12 @@ + + + + + + @@ -402,6 +410,7 @@ + @@ -423,6 +432,7 @@ + @@ -17740,11 +17750,13 @@ + + @@ -19642,8 +19654,8 @@ - - + + @@ -19659,8 +19671,8 @@ - - + + @@ -19670,8 +19682,8 @@ - - + + @@ -20527,6 +20539,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + @@ -21296,6 +21333,7 @@ + @@ -21304,6 +21342,7 @@ + @@ -21322,6 +21361,7 @@ + @@ -34903,6 +34943,7 @@ + @@ -40314,7 +40355,6 @@ - @@ -50273,6 +50313,9 @@ + + + @@ -57415,6 +57458,12 @@ + + + + + + @@ -57425,6 +57474,12 @@ + + + + + + @@ -57448,6 +57503,18 @@ + + + + + + + + + + + + @@ -57887,7 +57954,9 @@ + + @@ -58009,7 +58078,7 @@ - + @@ -58041,6 +58110,23 @@ + + + + + + + + + + + + + + + + + @@ -58061,6 +58147,7 @@ + @@ -77727,6 +77814,7 @@ + @@ -80594,6 +80682,7 @@ + @@ -83402,6 +83491,7 @@ + @@ -83461,6 +83551,7 @@ + @@ -87539,6 +87630,20 @@ + + + + + + + + + + + + + + diff --git a/xml/Microsoft.Build.Tasks.Deployment.ManifestUtilities/DeployManifest.xml b/xml/Microsoft.Build.Tasks.Deployment.ManifestUtilities/DeployManifest.xml index a063541aebd..db9b4dd19d4 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, they will not have the option to 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. The default is to have no minimum required version. This input only applies when Install is True. diff --git a/xml/Microsoft.Build.Tasks/CreateProperty.xml b/xml/Microsoft.Build.Tasks/CreateProperty.xml index dc62336feec..d604aab8004 100644 --- a/xml/Microsoft.Build.Tasks/CreateProperty.xml +++ b/xml/Microsoft.Build.Tasks/CreateProperty.xml @@ -161,8 +161,8 @@ Output TaskParameter="Value" PropertyName="MyTargetsToBuild" /CreateProperty - We need to respect the semicolon that they put in the value, and need to treat - this exactly as if they had done: + We need to respect the semicolon that he put in the value, and need to treat + this exactly as if he had done: PropertyGroup MyTargetsToBuild="Clean;Build" 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..23afb3b5a6b 100644 --- a/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml +++ b/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml @@ -109,5 +109,27 @@ 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.Configuration/BinderOptions.xml b/xml/Microsoft.Extensions.Configuration/BinderOptions.xml index b074e1c0512..91234f5f538 100644 --- a/xml/Microsoft.Extensions.Configuration/BinderOptions.xml +++ b/xml/Microsoft.Extensions.Configuration/BinderOptions.xml @@ -89,7 +89,8 @@ Gets or sets a value that indicates whether an exception is thrown when a configuration key doesn't have a matching property in the model object. - to throw an when a configuration key doesn't have a matching property in the model object; otherwise. + + to throw an when a configuration key doesn't have a matching property in the model object; otherwise. The exception that's thrown when no matching property is found contains a description of the missing property. 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..41f740dee1b 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml @@ -291,6 +291,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 @@ -482,6 +488,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -807,6 +819,12 @@ ReferenceTypeConstraint TService + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] + + @@ -1048,6 +1066,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.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.Extensions.Options/OptionsSnapshot`1.xml b/xml/Microsoft.Extensions.Options/OptionsSnapshot`1.xml index b361b5dac67..a8996f22b6c 100644 --- a/xml/Microsoft.Extensions.Options/OptionsSnapshot`1.xml +++ b/xml/Microsoft.Extensions.Options/OptionsSnapshot`1.xml @@ -27,7 +27,7 @@ The options type. - Implements . + Implements . To be added. 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/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/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/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/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 21601dec225..73a7292fdbb 100644 --- a/xml/System.Data.Common/DbBatchCommandCollection.xml +++ b/xml/System.Data.Common/DbBatchCommandCollection.xml @@ -186,6 +186,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. + + @@ -293,12 +318,12 @@ - + - + - + Property P:System.Collections.Generic.IList`1.Item(System.Int32) @@ -375,6 +400,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.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..371462997b7 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -122,6 +122,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>] + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Diagnostics.Metrics/Histogram`1.xml b/xml/System.Diagnostics.Metrics/Histogram`1.xml index 2d4a135616c..ca80d8a0f1a 100644 --- a/xml/System.Diagnostics.Metrics/Histogram`1.xml +++ b/xml/System.Diagnostics.Metrics/Histogram`1.xml @@ -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>] + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 1da44b465a3..29e306af158 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -114,6 +114,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>] + + + + + + To be added. + To be added. + To be added. + 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/Debug.xml b/xml/System.Diagnostics/Debug.xml index afa13b54978..2f73efc3551 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")] @@ -365,12 +365,12 @@ - - - - - - + + + + + + Method System.Runtime @@ -403,7 +403,7 @@ - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -411,7 +411,7 @@ - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -1856,12 +1856,12 @@ End of list of errors - - - - - - + + + + + + Method System.Runtime @@ -1887,7 +1887,7 @@ End of list of errors - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -2102,12 +2102,12 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - - - - - - + + + + + + Method System.Runtime @@ -2133,7 +2133,7 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -2785,12 +2785,12 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - - - - - - + + + + + + Method System.Runtime @@ -2816,7 +2816,7 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range"); - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] @@ -3032,12 +3032,12 @@ Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range") - - - - - - + + + + + + Method System.Runtime @@ -3063,7 +3063,7 @@ Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range") - + [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] 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+PropagatorSetterCallback.xml b/xml/System.Diagnostics/DistributedContextPropagator+PropagatorSetterCallback.xml index 92b4440ea26..68a669d2c0d 100644 --- a/xml/System.Diagnostics/DistributedContextPropagator+PropagatorSetterCallback.xml +++ b/xml/System.Diagnostics/DistributedContextPropagator+PropagatorSetterCallback.xml @@ -23,7 +23,7 @@ The medium used by propagators to write values to. The propagation field name. - The value corresponding to . + The value corresponding to . Represents the callback method that's used in propagators' inject methods. This callback is invoked to set the value of a named field. Propagators may invoke it multiple times in order to set multiple fields. 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/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..30d1b30b295 --- /dev/null +++ b/xml/System.Diagnostics/TagList+Enumerator.xml @@ -0,0 +1,153 @@ + + + + + + + + + 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 + + + + To be added. + 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> + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerator.MoveNext + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerator.Reset + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + To be added. + To be added. + + + + + + + + + + Property + + P:System.Collections.IEnumerator.Current + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Object + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Diagnostics/TagList.xml b/xml/System.Diagnostics/TagList.xml new file mode 100644 index 00000000000..a745b5729bd --- /dev/null +++ b/xml/System.Diagnostics/TagList.xml @@ -0,0 +1,522 @@ + + + + + + + + + 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 + + + + To be added. + To be added. + + + + + + + + + + Constructor + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Add(`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Clear + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + To be added. + 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 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + 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 + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + 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 + + + To be added. + 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>> + + + + To be added. + To be added. + 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 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.IList`1.Insert(System.Int32,`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + 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 + + + To be added. + 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> + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.ICollection`1.Remove(`0) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.Generic.IList`1.RemoveAt(System.Int32) + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + System.Diagnostics.DiagnosticSource + 6.0.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Collections.IEnumerator + + + + To be added. + To be added. + 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.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.Compression/ZLibStream.xml b/xml/System.IO.Compression/ZLibStream.xml index 0d6265fac87..7db926b48f4 100644 --- a/xml/System.IO.Compression/ZLibStream.xml +++ b/xml/System.IO.Compression/ZLibStream.xml @@ -168,8 +168,10 @@ Begins an asynchronous read operation. An object that represents the asynchronous read operation, which could still be pending. To be added. - is . - is less than zero. + + is . + + is less than zero. -or- @@ -211,8 +213,10 @@ Begins an asynchronous write operation. An object that represents the asynchronous write operation, which could still be pending. To be added. - is . - is less than zero. + + is . + + is less than zero. -or- @@ -240,7 +244,8 @@ Gets a value indicating whether the stream supports reading. - if the stream supports reading; otherwise. + + if the stream supports reading; otherwise. To be added. @@ -261,7 +266,8 @@ Gets a value indicating whether the stream supports seeking. - if the stream supports seeking; otherwise. + + if the stream supports seeking; otherwise. To be added. @@ -282,7 +288,8 @@ Gets a value indicating whether the stream supports writing. - if the stream supports writing; otherwise. + + if the stream supports writing; otherwise. To be added. @@ -310,8 +317,10 @@ The size of the buffer. This value must be greater than zero. Reads the bytes from the current stream and writes them to another stream, using the specified buffer size. To be added. - is . - is not a positive number. + + is . + + is not a positive number. The stream does not support writing. The stream is closed. @@ -343,8 +352,10 @@ Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. A task that represents the asynchronous copy operation. To be added. - is . - is not a positive number. + + is . + + is not a positive number. The stream does not support reading or writing. The stream is closed. Only one asynchronous reader or writer is allowed at a time. 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.Pipes/AnonymousPipeServerStreamAcl.xml b/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml index 1dd5f303dc8..969ee0354cb 100644 --- a/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml +++ b/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml @@ -15,7 +15,7 @@ - Provides security related APIs for the class. + Provides security related APIs for the class. To be added. diff --git a/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml b/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml index 46edb572138..dbd48dcefd4 100644 --- a/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml +++ b/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml @@ -15,7 +15,7 @@ - Provides security related APIs for the class. + Provides security related APIs for the class. To be added. 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/FileStreamOptions.xml b/xml/System.IO/FileStreamOptions.xml index 386337bf016..fc34f48da9d 100644 --- a/xml/System.IO/FileStreamOptions.xml +++ b/xml/System.IO/FileStreamOptions.xml @@ -14,7 +14,7 @@ - Defines a variety of configuration options for . + Defines a variety of configuration options for . To be added. @@ -31,7 +31,7 @@ - Initializes a instance with default values. + Initializes a instance with default values. To be added. 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.IO/StreamReader.xml b/xml/System.IO/StreamReader.xml index fa33452e73f..7fbae9ecad2 100644 --- a/xml/System.IO/StreamReader.xml +++ b/xml/System.IO/StreamReader.xml @@ -554,15 +554,17 @@ The complete file path to be read. - An object that specifies the configuration options for the underlying . - Initializes a new instance of the class for the specified file path, using the default encoding, enabling detection of byte order marks at the beginning of the file, and configured with the specified object. + An object that specifies the configuration options for the underlying . + Initializes a new instance of the class for the specified file path, using the default encoding, enabling detection of byte order marks at the beginning of the file, and configured with the specified object. To be added. - is not readable. + + is not readable. -or- is an empty string (""). - or is . + + or is . The file cannot be found. The specified path is invalid, such as being on an unmapped drive. @@ -1057,18 +1059,21 @@ The complete file path to be read. The character encoding to use. Indicates whether to look for byte order marks at the beginning of the file. - An object that specifies the configuration options for the underlying . - Initializes a new instance of the class for the specified file path, with the specified character encoding, byte order mark detection option, and configured with the specified object. + An object that specifies the configuration options for the underlying . + Initializes a new instance of the class for the specified file path, with the specified character encoding, byte order mark detection option, and configured with the specified object. To be added. - is not readable. + + is not readable. -or- is an empty string (""). - or or is . + + or or is . The file cannot be found. The specified path is invalid, such as being on an unmapped drive. - includes an incorrect or invalid syntax for file name, directory name, or volume label. + + includes an incorrect or invalid syntax for file name, directory name, or volume label. File and Stream I/O How to: Read Text from a File diff --git a/xml/System.IO/StreamWriter.xml b/xml/System.IO/StreamWriter.xml index f6740ad7ba8..1bc72c94f22 100644 --- a/xml/System.IO/StreamWriter.xml +++ b/xml/System.IO/StreamWriter.xml @@ -488,12 +488,14 @@ The complete file path to write to. - An object that specifies the configuration options for the underlying . - Initializes a new instance of the class for the specified file, using the default encoding, and configured with the specified object. + An object that specifies the configuration options for the underlying . + Initializes a new instance of the class for the specified file, using the default encoding, and configured with the specified object. To be added. - is + + is . - is not writable. + + is not writable. File and Stream I/O How to: Read Text from a File How to: Write Text to a File @@ -715,12 +717,14 @@ The complete file path to write to. The character encoding to use. - An object that specifies the configuration options for the underlying . - Initializes a new instance of the class for the specified file, using the specified encoding, and configured with the specified object. + An object that specifies the configuration options for the underlying . + Initializes a new instance of the class for the specified file, using the specified encoding, and configured with the specified object. To be added. - is + + is . - is not writable. + + is not writable. File and Stream I/O How to: Read Text from a File How to: Write Text to a File 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.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/HttpRequestMessage.xml b/xml/System.Net.Http/HttpRequestMessage.xml index 24a0c2aad64..f5a7adc79f3 100644 --- a/xml/System.Net.Http/HttpRequestMessage.xml +++ b/xml/System.Net.Http/HttpRequestMessage.xml @@ -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/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/SslApplicationProtocol.xml b/xml/System.Net.Security/SslApplicationProtocol.xml index d0d581c3edd..9b995d1fa39 100644 --- a/xml/System.Net.Security/SslApplicationProtocol.xml +++ b/xml/System.Net.Security/SslApplicationProtocol.xml @@ -260,6 +260,29 @@ For a complete list of supported protocols, see [TLS Application-Layer Protocol To be added. + + + + + + + + Field + + System.Net.Security + 6.0.0.0 + + + netstandard + + + System.Net.Security.SslApplicationProtocol + + + To be added. + To be added. + + 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..2b56223b227 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>] 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..cbfc3d39a76 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")>] 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..e63ef7dbfa8 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")>] 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.Numerics/BitOperations.xml b/xml/System.Numerics/BitOperations.xml index 0b9902f0962..284bba5d208 100644 --- a/xml/System.Numerics/BitOperations.xml +++ b/xml/System.Numerics/BitOperations.xml @@ -52,7 +52,8 @@ The value to evaluate as being a power of two. Evaluates whether the specified value is a power of two. - if the specified value is a power of two; otherwise. + + if the specified value is a power of two; otherwise. To be added. @@ -80,7 +81,8 @@ The value to evaluate as being a power of two. Evaluates whether the specified value is a power of 2. - if the specified value is a power of two; otherwise. + + if the specified value is a power of two; otherwise. To be added. @@ -114,7 +116,8 @@ The value to evaluate as being a power of two. Evaluates whether the specified value is a power of two. - if the specified value is a power of two; otherwise. + + if the specified value is a power of two; otherwise. To be added. @@ -148,7 +151,8 @@ The value to evaluate as being a power of two. Evaluates whether the specified value is a power of two. - if the specified value is a power of two; otherwise. + + if the specified value is a power of two; otherwise. To be added. 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.PortableExecutable/DebugDirectoryBuilder.xml b/xml/System.Reflection.PortableExecutable/DebugDirectoryBuilder.xml index 343e0a2d34f..a5c2d2943fe 100644 --- a/xml/System.Reflection.PortableExecutable/DebugDirectoryBuilder.xml +++ b/xml/System.Reflection.PortableExecutable/DebugDirectoryBuilder.xml @@ -120,7 +120,7 @@ contains a NUL character. - Either is smaller than 0x0100 or is less than 1. + Either is smaller than 0x0100 or is less than 1. 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/NullabilityInfoContext.xml b/xml/System.Reflection/NullabilityInfoContext.xml index 550e40790c6..bdbefb1fb1d 100644 --- a/xml/System.Reflection/NullabilityInfoContext.xml +++ b/xml/System.Reflection/NullabilityInfoContext.xml @@ -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 @@ -78,12 +72,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 @@ -109,12 +97,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 @@ -140,12 +122,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 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/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/CollectionsMarshal.xml b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml index d0e557c392a..c273119809f 100644 --- a/xml/System.Runtime.InteropServices/CollectionsMarshal.xml +++ b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml @@ -79,7 +79,7 @@ To be added. 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. + 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. diff --git a/xml/System.Runtime.InteropServices/ComWrappers.xml b/xml/System.Runtime.InteropServices/ComWrappers.xml index a27ce7c1540..95c0bef6a18 100644 --- a/xml/System.Runtime.InteropServices/ComWrappers.xml +++ b/xml/System.Runtime.InteropServices/ComWrappers.xml @@ -19,10 +19,26 @@ [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. @@ -374,6 +390,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/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/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..1aea749e11e 100644 --- a/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml +++ b/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml @@ -41,5 +41,68 @@ To be added. + + + + + + + + Constructor + + System.Runtime + 6.0.0.0 + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Runtime + 6.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Runtime + 6.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime/DependentHandle.xml b/xml/System.Runtime/DependentHandle.xml index 83954ee716c..30b55b021c7 100644 --- a/xml/System.Runtime/DependentHandle.xml +++ b/xml/System.Runtime/DependentHandle.xml @@ -153,7 +153,8 @@ This method is not thread-safe. Gets a value indicating whether this instance was constructed with and has not yet been disposed. - if this instance was constructed with and has not yet been disposed; otherwise. + + if this instance was constructed with and has not yet been disposed; otherwise. - to return a value specific to the current thread; to return a global value. The default value is . + + to return a value specific to the current thread; to return a global value. The default value is . Gets the amount of time the JIT Compiler has spent compiling methods. If is , then this value is scoped to the current thread; otherwise, this is a global value. The amount of time the JIT Compiler has spent compiling methods. To be added. @@ -60,7 +61,8 @@ - to return a value specific to the current thread; to return a global value. The default value is . + + to return a value specific to the current thread; to return a global value. The default value is . Gets the number of bytes of intermediate language that have been compiled. If is , then this value is scoped to the current thread; otherwise, this is a global value. The number of bytes of IL the JIT has compiled. To be added. @@ -84,7 +86,8 @@ - to return a value specific to the current thread; to return a global value. The default value is . + + to return a value specific to the current thread; to return a global value. The default value is . Gets the number of methods that have been compiled. If is , then this value is scoped to the current thread; otherwise, this is a global value. The number of methods the JIT has compiled. 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..fb74f53bc01 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml @@ -99,6 +99,30 @@ 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 + + + + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml index 5a4bf71205e..eff46f772b5 100644 --- a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml +++ b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml @@ -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..f5da60a182a 100644 --- a/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml +++ b/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml @@ -317,10 +317,14 @@ ASN1 corrupted data. 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 diff --git a/xml/System.Security.Cryptography.X509Certificates/DSACertificateExtensions.xml b/xml/System.Security.Cryptography.X509Certificates/DSACertificateExtensions.xml index 1fdfb32b7cd..5388c15a565 100644 --- a/xml/System.Security.Cryptography.X509Certificates/DSACertificateExtensions.xml +++ b/xml/System.Security.Cryptography.X509Certificates/DSACertificateExtensions.xml @@ -34,10 +34,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/PublicKey.xml b/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml index d4da3fbb8b3..29b0f25ec08 100644 --- a/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml +++ b/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml @@ -300,10 +300,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.Xml/CryptoSignedXmlRecursionException.xml b/xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml new file mode 100644 index 00000000000..88c7eb76f11 --- /dev/null +++ b/xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml @@ -0,0 +1,116 @@ + + + + + + + + + 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>] + + + + To be added. + To be added. + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + To be added. + To be added. + + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Constructor + + System.Security.Cryptography.Xml + 6.0.0.0 + + + + + + + To be added. + To be added. + To be added. + 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/EncryptionPropertyCollection.xml b/xml/System.Security.Cryptography.Xml/EncryptionPropertyCollection.xml index ba5c6209835..86f07343f72 100644 --- a/xml/System.Security.Cryptography.Xml/EncryptionPropertyCollection.xml +++ b/xml/System.Security.Cryptography.Xml/EncryptionPropertyCollection.xml @@ -3,9 +3,9 @@ - + - + System.Security 2.0.0.0 diff --git a/xml/System.Security.Cryptography.Xml/ReferenceList.xml b/xml/System.Security.Cryptography.Xml/ReferenceList.xml index 7411ade7421..c8f148768cf 100644 --- a/xml/System.Security.Cryptography.Xml/ReferenceList.xml +++ b/xml/System.Security.Cryptography.Xml/ReferenceList.xml @@ -3,9 +3,9 @@ - + - + System.Security 2.0.0.0 diff --git a/xml/System.Security.Cryptography/AesCcm.xml b/xml/System.Security.Cryptography/AesCcm.xml index 327d789f911..5b6c286f17e 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")>] diff --git a/xml/System.Security.Cryptography/AesGcm.xml b/xml/System.Security.Cryptography/AesGcm.xml index 2245885745b..67c7222866d 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")>] diff --git a/xml/System.Security.Cryptography/ChaCha20Poly1305.xml b/xml/System.Security.Cryptography/ChaCha20Poly1305.xml index 11ed0fed951..ca96a110bc6 100644 --- a/xml/System.Security.Cryptography/ChaCha20Poly1305.xml +++ b/xml/System.Security.Cryptography/ChaCha20Poly1305.xml @@ -26,10 +26,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/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/HMACSHA384.xml b/xml/System.Security.Cryptography/HMACSHA384.xml index bf76d453bf7..012673dc694 100644 --- a/xml/System.Security.Cryptography/HMACSHA384.xml +++ b/xml/System.Security.Cryptography/HMACSHA384.xml @@ -563,8 +563,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 369da680585..37ce7913358 100644 --- a/xml/System.Security.Cryptography/HMACSHA512.xml +++ b/xml/System.Security.Cryptography/HMACSHA512.xml @@ -563,8 +563,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/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 ecc12637155..298a255a689 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>] 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.Policy/Evidence.xml b/xml/System.Security.Policy/Evidence.xml index 2171e489fa1..1919b5bc56b 100644 --- a/xml/System.Security.Policy/Evidence.xml +++ b/xml/System.Security.Policy/Evidence.xml @@ -210,7 +210,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.")>] @@ -309,7 +313,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.")>] @@ -441,7 +449,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.")>] @@ -686,7 +698,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 +770,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.")>] @@ -984,7 +1004,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.")>] 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..b672d49338b 100644 --- a/xml/System.Security.Policy/PolicyStatement.xml +++ b/xml/System.Security.Policy/PolicyStatement.xml @@ -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 547f8710843..4d0e82bc72d 100644 --- a/xml/System.Security.Policy/UrlMembershipCondition.xml +++ b/xml/System.Security.Policy/UrlMembershipCondition.xml @@ -3,8 +3,9 @@ - + + 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.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/JsonNode.xml b/xml/System.Text.Json.Nodes/JsonNode.xml index c93bd740b4a..f4046e4f689 100644 --- a/xml/System.Text.Json.Nodes/JsonNode.xml +++ b/xml/System.Text.Json.Nodes/JsonNode.xml @@ -110,27 +110,29 @@ To be added. - - - + + + - - - + + + Method System.Text.Json 6.0.0.0 - TValue + T + To be added. + To be added. Gets the value for the current . 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..6f8773d8a18 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,19 @@ - - - - + - 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 . - Creates metadata for a complex class or struct. - A instance representing the class or struct. + To be added. + To be added. + To be added. + To be added. + To be added. To be added. - Thrown when and are both . - + 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..61a8a2534b2 --- /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 + + + + To be added. + To be added. + 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[]> + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.Serialization.JsonNumberHandling + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Func<T> + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Func<System.Object[],T> + + + To be added. + 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[]> + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Action<System.Text.Json.Utf8JsonWriter,T> + + + To be added. + 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..47e7f1817ca --- /dev/null +++ b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml @@ -0,0 +1,144 @@ + + + + + + + + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + To be added. + 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 + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Type + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Text.Json + 6.0.0.0 + + + System.Int32 + + + To be added. + 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..df8285f076f 100644 --- a/xml/System.Text.Json.Serialization/JsonConverter`1.xml +++ b/xml/System.Text.Json.Serialization/JsonConverter`1.xml @@ -163,6 +163,35 @@ For more information, see [How to write custom converters for JSON serialization + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + T + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -204,5 +233,33 @@ For more information, see [How to write custom converters for JSON serialization + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Void + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml b/xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml index 2dd7280ce2d..728850435b5 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 diff --git a/xml/System.Text.Json/JsonSerializer.xml b/xml/System.Text.Json/JsonSerializer.xml index 8562af52812..4e1d5072f7c 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 @@ -264,7 +266,7 @@ Using a UTF-16 span is not as efficient as using the - + Method @@ -313,8 +315,9 @@ Using a is not as efficient as using the - + + Method @@ -381,7 +384,7 @@ There is remaining data in the string beyond a single JSON value. - + Method @@ -426,12 +429,202 @@ Using a is not as efficient as using the 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Object + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + - + + Method @@ -504,7 +697,7 @@ A value could not be read from the reader. - + Method @@ -571,7 +764,7 @@ A value could not be read from the reader. - + Method @@ -612,7 +805,7 @@ A value could not be read from the reader. - + Method @@ -648,8 +841,9 @@ A value could not be read from the reader. - + + Method @@ -706,7 +900,7 @@ There is remaining data in the span beyond a single JSON value. - + Method @@ -739,7 +933,7 @@ There is remaining data in the span beyond a single JSON value. - + Method @@ -790,7 +984,7 @@ Using a UTF-16 span is not as efficient as using the - + Method @@ -840,8 +1034,9 @@ Using a is not as efficient as using the - + + Method @@ -902,7 +1097,7 @@ There is remaining data in the string beyond a single JSON value. - + Method @@ -948,12 +1143,214 @@ Using a is not as efficient as using the 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 + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + TValue + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + TValue + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + TValue + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + - + + Method @@ -1020,7 +1417,7 @@ A value could not be read from the reader. - + Method @@ -1086,8 +1483,9 @@ A value could not be read from the reader. - + + Method @@ -1153,7 +1551,7 @@ There is remaining data in the stream. - + Method @@ -1189,8 +1587,9 @@ There is remaining data in the stream. - + + Method @@ -1251,7 +1650,7 @@ There is remaining data in the stream. - + Method @@ -1288,7 +1687,7 @@ There is remaining data in the stream. - + Method @@ -1328,8 +1727,9 @@ There is remaining data in the stream. - + + Method @@ -1388,7 +1788,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1431,7 +1831,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1471,7 +1871,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1506,8 +1906,9 @@ Using a is not as efficient as using UTF-8 - + + Method @@ -1567,7 +1968,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1603,8 +2004,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -1654,7 +2056,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1698,7 +2100,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1738,7 +2140,7 @@ Using a is not as efficient as using UTF-8 - + Method @@ -1773,8 +2175,9 @@ Using a is not as efficient as using UTF-8 - + + Method @@ -1827,7 +2230,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1862,8 +2265,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -1924,7 +2328,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -1961,8 +2365,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -2016,7 +2421,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -2049,12 +2454,403 @@ 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonDocument + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonDocument + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonElement + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.JsonElement + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.Nodes.JsonNode + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + 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 + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Text.Json + 6.0.0.0 + + + System.Text.Json.Nodes.JsonNode + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + - + + Method @@ -2111,7 +2907,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method @@ -2146,8 +2942,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + + Method @@ -2195,7 +2992,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - + Method diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index f72fdcec6e8..d347dbe7f69 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -2834,7 +2834,8 @@ The property name should already be escaped when the instance of The raw JSON content to write. - to validate if the input is an RFC 8259-compliant JSON payload; otherwise. + + to validate if the input is an RFC 8259-compliant JSON payload; otherwise. Writes the input as JSON content. It is expected that the input content is a single complete JSON value. The raw JSON content to write. - to validate if the input is an RFC 8259-compliant JSON payload; otherwise. + + to validate if the input is an RFC 8259-compliant JSON payload; otherwise. Writes the input as JSON content. It is expected that the input content is a single complete JSON value. The raw JSON content to write. - to validate if the input is an RFC 8259-compliant JSON payload; otherwise. + + to validate if the input is an RFC 8259-compliant JSON payload; otherwise. Writes the input as JSON content. It is expected that the input content is a single complete JSON value. + + + + + + + + Property + + System.Text.RegularExpressions + 6.0.0.0 + + + System + + + netstandard + + + System.ReadOnlySpan<System.Char> + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Threading.Channels/ChannelReader`1.xml b/xml/System.Threading.Channels/ChannelReader`1.xml index a5a1f18c279..86adb26bfc1 100644 --- a/xml/System.Threading.Channels/ChannelReader`1.xml +++ b/xml/System.Threading.Channels/ChannelReader`1.xml @@ -86,7 +86,8 @@ Gets a value that indicates whether is available for use on this instance. - if peeking is supported by this channel instance; otherwise. + + if peeking is supported by this channel instance; otherwise. To be added. 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.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..d0ca9c2616e --- /dev/null +++ b/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml @@ -0,0 +1,145 @@ + + + + + + + + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Enum + + + To be added. + To be added. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 0 + + To be added. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 4 + + To be added. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 2 + + To be added. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 3 + + To be added. + + + + + + + + + + Field + + System.Windows.Forms.Analyzers.CSharp + 6.0.0.0 + + + System.Windows.Forms.Analyzers + 6.0.0.0 + + + System.Windows.Forms.Analyzers.HighDpiMode + + 1 + + To be added. + + + + 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..172a8203fb1 100644 --- a/xml/System.Windows.Forms/Application.xml +++ b/xml/System.Windows.Forms/Application.xml @@ -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 diff --git a/xml/System.Windows.Forms/Control.xml b/xml/System.Windows.Forms/Control.xml index 51e341c286a..3a404008c95 100644 --- a/xml/System.Windows.Forms/Control.xml +++ b/xml/System.Windows.Forms/Control.xml @@ -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 + + + To be added. + To be added. + To be added. + + 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/Form.xml b/xml/System.Windows.Forms/Form.xml index 67116871ac9..b38a631ad84 100644 --- a/xml/System.Windows.Forms/Form.xml +++ b/xml/System.Windows.Forms/Form.xml @@ -3259,6 +3259,33 @@ 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 + + + To be added. + To be added. + To be added. + + 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.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.Xml.Linq/XElement.xml b/xml/System.Xml.Linq/XElement.xml index 21f49c448a6..8b4e00f5eb7 100644 --- a/xml/System.Xml.Linq/XElement.xml +++ b/xml/System.Xml.Linq/XElement.xml @@ -4284,7 +4284,8 @@ orderDate=10/6/2006 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -4376,7 +4377,8 @@ dt=10/6/2006 12:30:00 PM -07:00 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -4454,7 +4456,8 @@ value=79228162514264337593543950335 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -4530,7 +4533,8 @@ value=1.79769313486231E+308 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -4607,7 +4611,8 @@ value=3c1cc55b-baff-4b7a-9d17-077af3aa5730 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -4760,7 +4765,8 @@ value=9223372036854775807 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -5844,7 +5850,8 @@ value=3.402823E+38 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . @@ -6154,7 +6161,8 @@ value=18446744073709551615 The element does not contain a valid value. The parameter is . LINQ to XML overview - is . + + is . 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..981792cd2a8 100644 --- a/xml/System.Xml/XmlReaderSettings.xml +++ b/xml/System.Xml/XmlReaderSettings.xml @@ -1197,10 +1197,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/Char.xml b/xml/System/Char.xml index a4d253b1790..604549f14e0 100644 --- a/xml/System/Char.xml +++ b/xml/System/Char.xml @@ -1158,7 +1158,8 @@ When a managed type, which is represented as a Unicode UTF-16 The character to analyze. Returns if is an ASCII character ([ U+0000..U+007F ]). - if is an ASCII character; otherwise. + + if is an ASCII character; otherwise. [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/DateOnly.xml b/xml/System/DateOnly.xml index 714507103d3..7b746e0070b 100644 --- a/xml/System/DateOnly.xml +++ b/xml/System/DateOnly.xml @@ -694,6 +694,7 @@ The string that contains the string to parse. Converts a string that contains string representation of a date to its equivalent by using the conventions of the current culture. An object that is equivalent to the date contained in . + To be added. is . @@ -725,6 +726,7 @@ A bitwise combination of enumeration values that indicates the permitted format of . A typical value to specify is . Converts a memory span that contains string representation of a date to its equivalent by using culture-specific format information and a formatting style. An object that is equivalent to the date contained in , as specified by provider and styles. + To be added. does not contain a valid string representation of a date. @@ -754,6 +756,7 @@ A bitwise combination of the enumeration values that indicates the style elements that can be present in for the parse operation to succeed, and that defines how to interpret the parsed date. A typical value to specify is . Converts a string that contains string representation of a date to its equivalent by using culture-specific format information and a formatting style. An object that is equivalent to the date contained in , as specified by provider and styles. + To be added. is . @@ -785,6 +788,7 @@ Converts the specified span representation of a date to its equivalent using the specified array of formats. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. An object that is equivalent to the date contained in , as specified by format, provider, and style. + To be added. does not contain a valid string representation of a date. @@ -814,6 +818,7 @@ Converts the specified string representation of a date to its equivalent using the specified format. The format of the string representation must match the specified format exactly or an exception is thrown. An object that is equivalent to the date contained in , as specified by format. + To be added. is . @@ -845,6 +850,7 @@ Converts the specified span representation of a date to its equivalent using the specified array of formats. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. An object that is equivalent to the date contained in , as specified by format, provider, and style. + To be added. is . @@ -879,6 +885,7 @@ Converts the specified span representation of a date to its equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown. An object that is equivalent to the date contained in , as specified by format, provider, and style. + To be added. does not contain a valid string representation of a date. @@ -942,6 +949,7 @@ Converts the specified string representation of a date to its equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown. An object that is equivalent to the date contained in , as specified by format, provider, and style. + To be added. is . @@ -976,6 +984,7 @@ Converts the specified string representation of a date to its equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. An object that is equivalent to the date contained in , as specified by format, provider, and style. + To be added. is . diff --git a/xml/System/Enum.xml b/xml/System/Enum.xml index c76bba46580..c1331376080 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 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/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.xml b/xml/System/MemoryExtensions.xml index 789a2b7105b..ad810445832 100644 --- a/xml/System/MemoryExtensions.xml +++ b/xml/System/MemoryExtensions.xml @@ -5652,7 +5652,7 @@ If `trimElements` is empty, the span is returned unaltered. System.Boolean - + @@ -5691,7 +5691,7 @@ If `trimElements` is empty, the span is returned unaltered. System.Boolean - + diff --git a/xml/System/OperatingSystem.xml b/xml/System/OperatingSystem.xml index 8fcbc804c2e..2ce6b0ce8b8 100644 --- a/xml/System/OperatingSystem.xml +++ b/xml/System/OperatingSystem.xml @@ -579,7 +579,8 @@ Indicates whether the current application is running on Mac Catalyst. - if the current application is running on Mac Catalyst; otherwise. + + if the current application is running on Mac Catalyst; otherwise. To be added. @@ -616,7 +617,8 @@ The version minor number. The version build number. Check for the Mac Catalyst version (iOS version as presented in Apple documentation) with a ≤ version comparison. Used to guard APIs that were added in the given Mac Catalyst release. - if the Mac Catalyst version is greater or equal than the specified version comparison; otherwise. + + if the Mac Catalyst version is greater or equal than the specified version comparison; 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/TimeOnly.xml b/xml/System/TimeOnly.xml index 23fea0800d0..51e63db0b0d 100644 --- a/xml/System/TimeOnly.xml +++ b/xml/System/TimeOnly.xml @@ -539,7 +539,8 @@ The ending time of day, exclusive. Determines if a time falls within the range provided. Supports both "normal" ranges such as 10:00-12:00, and ranges that span midnight such as 23:00-01:00. - , if the time falls within the range, otherwise. + + , if the time falls within the range, otherwise. The string to parse. Converts the string representation of a time to its equivalent by using the conventions of the current culture. A instance. + To be added. is . @@ -884,6 +886,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze A bitwise combination of enumeration values that indicates the permitted format of . A typical value to specify is . Converts a memory span that contains string representation of a time to its equivalent by using culture-specific format information and a formatting style. A instance. + To be added. does not contain a valid string representation of a time. @@ -913,6 +916,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze A bitwise combination of the enumeration values that indicates the style elements that can be present in s for the parse operation to succeed, and that defines how to interpret the parsed date. A typical value to specify is . Converts the string representation of a time to its equivalent by using culture-specific format information and a formatting style. A instance. + To be added. is . @@ -944,6 +948,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified span to its equivalent using the specified array of formats. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. A instance. + To be added. does not contain a valid string representation of a time. @@ -973,6 +978,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified string representation of a time to its equivalent using the specified format. The format of the string representation must match the specified format exactly or an exception is thrown. A instance. + To be added. is . @@ -1004,6 +1010,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified span to a equivalent using the specified array of formats. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. A instance. + To be added. is . @@ -1038,6 +1045,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified span representation of a time to its equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown. A instance. + To be added. does not contain a valid string representation of a time. @@ -1070,6 +1078,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified span representation of a time to its equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. A instance. + To be added. does not contain a valid string representation of a time. @@ -1102,6 +1111,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified string representation of a time to its equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown. A instance. + To be added. is . @@ -1136,6 +1146,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze Converts the specified string representation of a time to its equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown. A instance. + To be added. is . 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/Uri.xml b/xml/System/Uri.xml index 30445b4d016..6842bfbb0e0 100644 --- a/xml/System/Uri.xml +++ b/xml/System/Uri.xml @@ -505,10 +505,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")>] @@ -978,10 +982,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")>] @@ -1274,10 +1282,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")>] @@ -1453,10 +1465,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")>] @@ -1751,10 +1767,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")>] @@ -1867,8 +1887,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")] @@ -1932,8 +1952,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}")>] @@ -2666,10 +2686,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")>] @@ -2855,10 +2879,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")>] @@ -3135,10 +3163,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")>] @@ -3441,10 +3473,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")>] @@ -3778,10 +3814,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")>] @@ -4507,10 +4547,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")>] 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. + + From c5cf285f541e9192c394eb3cd61a799fd138e2b2 Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Mon, 6 Sep 2021 12:08:40 -0700 Subject: [PATCH 02/28] Update InteropServices doc (#7107) * Update InteropServices doc * Docs for MemoryMarshal and PosixSignalContext. * Doc update for CollectionsMarshal * Update docs for Objective-C classes --- ...l+UnhandledExceptionPropagationHandler.xml | 2 +- .../ObjectiveCMarshal.xml | 23 ++++++++++++++----- .../Architecture.xml | 2 +- .../CollectionsMarshal.xml | 8 +++---- .../MemoryMarshal.xml | 2 +- .../PosixSignalContext.xml | 2 +- .../UnmanagedCallConvAttribute.xml | 2 +- ...tem.Runtime.InteropServices.ObjectiveC.xml | 2 +- 8 files changed, 27 insertions(+), 16 deletions(-) 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..4399b257a0a 100644 --- a/xml/System.Runtime.InteropServices/CollectionsMarshal.xml +++ b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml @@ -75,8 +75,8 @@ - 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. @@ -117,8 +117,8 @@ Items should not be added to or removed from the - 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 . diff --git a/xml/System.Runtime.InteropServices/MemoryMarshal.xml b/xml/System.Runtime.InteropServices/MemoryMarshal.xml index 0bba1f03524..b90de0ec092 100644 --- a/xml/System.Runtime.InteropServices/MemoryMarshal.xml +++ b/xml/System.Runtime.InteropServices/MemoryMarshal.xml @@ -682,7 +682,7 @@ 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. diff --git a/xml/System.Runtime.InteropServices/PosixSignalContext.xml b/xml/System.Runtime.InteropServices/PosixSignalContext.xml index eb679cd07a1..d71eec932aa 100644 --- a/xml/System.Runtime.InteropServices/PosixSignalContext.xml +++ b/xml/System.Runtime.InteropServices/PosixSignalContext.xml @@ -34,7 +34,7 @@ - To be added. + The signal that occurred. Initializes a new instance of the class. To be added. 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/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. From edfb1ff720e08d1638ba66bdd491b877aa6942d3 Mon Sep 17 00:00:00 2001 From: Natalia Kondratyeva Date: Tue, 7 Sep 2021 20:09:56 +0200 Subject: [PATCH 03/28] Port triple-slash comments to docs for Microsoft.Extensions.Http (#7103) * Port triple-slash comments to docs for Microsoft.Extensions.Http * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../LoggingHttpMessageHandler.xml | 27 ++++++++++++++----- .../LoggingScopeHttpMessageHandler.xml | 27 ++++++++++++++----- .../HttpMessageHandlerBuilder.xml | 17 +++++++++--- .../IHttpMessageHandlerBuilderFilter.xml | 2 +- 4 files changed, 54 insertions(+), 19 deletions(-) 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/HttpMessageHandlerBuilder.xml b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml index a6678a57eb1..db002c1235c 100644 --- a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml +++ b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml @@ -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. From f8805bae411cab6294199c83d573f761ca81d7b1 Mon Sep 17 00:00:00 2001 From: Natalia Kondratyeva Date: Tue, 7 Sep 2021 20:11:09 +0200 Subject: [PATCH 04/28] Add remaining undoc API for M.E.Http (#7110) --- .../HttpClientFactoryOptions.xml | 2 +- .../HttpMessageHandlerBuilder.xml | 2 +- .../PolicyHttpMessageHandler.xml | 10 +++++++++- xml/ns-Microsoft.Extensions.Http.Logging.xml | 2 +- xml/ns-Microsoft.Extensions.Http.xml | 2 +- 5 files changed, 13 insertions(+), 5 deletions(-) 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 db002c1235c..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. 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/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. From ce38356ca3a81e37c4a450bc24978f800466db5b Mon Sep 17 00:00:00 2001 From: Devendar Reddy Adulla Date: Tue, 7 Sep 2021 19:26:13 -0700 Subject: [PATCH 05/28] Porting WinForms triple slash to docs (#7114) Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- .../HighDpiMode.xml | 311 +- xml/System.Windows.Forms/Application.xml | 4443 +- .../ComboBox+ObjectCollection.xml | 1743 +- xml/System.Windows.Forms/Control.xml | 39469 ++++++++-------- xml/System.Windows.Forms/DialogResult.xml | 564 +- .../FolderBrowserDialog.xml | 1225 +- xml/System.Windows.Forms/Form.xml | 15111 +++--- .../LinkClickedEventArgs.xml | 418 +- .../MessageBoxButtons.xml | 412 +- .../MessageBoxDefaultButton.xml | 266 +- xml/System.Windows.Forms/TaskDialogButton.xml | 1354 +- .../TaskDialogCommandLinkButton.xml | 182 +- xml/System.Windows.Forms/TextRenderer.xml | 2 +- 13 files changed, 32785 insertions(+), 32715 deletions(-) diff --git a/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml b/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml index d0ca9c2616e..a2b072da3ea 100644 --- a/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml +++ b/xml/System.Windows.Forms.Analyzers/HighDpiMode.xml @@ -1,145 +1,166 @@ - - - - - - - - - System.Windows.Forms.Analyzers.CSharp - 6.0.0.0 - - - System.Windows.Forms.Analyzers - 6.0.0.0 - - - System.Enum - - - To be added. - To be added. - - - - - - - - - - Field - - System.Windows.Forms.Analyzers.CSharp - 6.0.0.0 - - - System.Windows.Forms.Analyzers - 6.0.0.0 - - - System.Windows.Forms.Analyzers.HighDpiMode - - 0 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms.Analyzers.CSharp - 6.0.0.0 - - - System.Windows.Forms.Analyzers - 6.0.0.0 - - - System.Windows.Forms.Analyzers.HighDpiMode - - 4 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms.Analyzers.CSharp - 6.0.0.0 - - - System.Windows.Forms.Analyzers - 6.0.0.0 - - - System.Windows.Forms.Analyzers.HighDpiMode - - 2 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms.Analyzers.CSharp - 6.0.0.0 - - - System.Windows.Forms.Analyzers - 6.0.0.0 - - - System.Windows.Forms.Analyzers.HighDpiMode - - 3 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms.Analyzers.CSharp - 6.0.0.0 - - - System.Windows.Forms.Analyzers - 6.0.0.0 - - - System.Windows.Forms.Analyzers.HighDpiMode - - 1 - - To be added. - - - - + + + + + + + + + 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/Application.xml b/xml/System.Windows.Forms/Application.xml index 172a8203fb1..8853f1b68a2 100644 --- a/xml/System.Windows.Forms/Application.xml +++ b/xml/System.Windows.Forms/Application.xml @@ -1,2211 +1,2232 @@ - - - - - - - - - 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 - - - - 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"::: - - ]]> - - - - - - - - - - - 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 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"::: - - ]]> - - - - - - - - - - - Property - - 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 caller can quit this application. - - if the caller can quit this application; otherwise, . - - being hosted within a Web browser. Thus, the cannot quit the . - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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). - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Microsoft.Win32.RegistryKey - - - 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. - - \\\\ - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - Gets the company name associated with the application. - The company name. - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Globalization.CultureInfo - - - Gets or sets the culture information for the current thread. - A representing the culture information for the current thread. - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.InputLanguage - - - Gets or sets the current input language for the current thread. - An representing the current input language for the current thread. - - - - - - - - - - - - - - - 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 - - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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.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 - - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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. - - 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. - - - - - System.Windows.Forms - 4.0.0.0 - - - Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed. - - - - - - - - - - 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.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.Void - - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - Returns whether any within the application cancelled the exit. - Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed. - To be added. - - - - - - - - - - - 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 - - - - 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 . - - ]]> - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - - - - The Windows event message to filter. - Runs any filters against a window message, and returns a copy of the modified message. - - if the filters were processed; otherwise, . - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.HighDpiMode - - - Gets the current high DPI mode for the application. - One of the enumeration values that indicates the high DPI mode. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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"::: - - ]]> - - - - - - - - - - - Property - - 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 a message loop exists on this thread. - - if a message loop exists; otherwise, . - - to instruct Windows Forms if the hosting environment still has an active message loop. - - ]]> - - - - - - - - - - - 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.Threading.ApartmentState - - - - 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. - - ]]> - - - - - - - - - - - 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 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. - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Forms.FormCollection - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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"::: - - ]]> - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - - - - - - - - - - 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 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"::: - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets a value specifying whether the current application is drawing controls with visual styles. - - 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 .| - - ]]> - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Shuts down the application and starts a new instance immediately. - - 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. - - - - - System.Windows.Forms - 4.0.0.0 - - - Begins running a standard application message loop on the current thread. - - - - - - - - - - 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 - - - - 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. - - ]]> - - A main message loop is already running on this thread. - - - - - - - - - - - - - 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 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"::: - - ]]> - - A main message loop is already running on this thread. - - - - - - - - - - - - - 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 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"::: - - ]]> - - A main message loop is already running on the current thread. - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - Gets or sets the format string to apply to top-level window captions when they are displayed with a warning banner. - The format string to apply to top-level window captions. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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()); - } -} -``` - - ]]> - - You can only call this method before the first window is created by your Windows Forms application. - - - - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 6.0.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - One of the enumeration values that specifies the high DPI mode to set. - Sets the high DPI mode of the process. - - if the high DPI mode was set; otherwise, . - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - - A indicating the power activity mode to which to transition. - - to force the suspended mode immediately; to cause Windows to send a suspend request to every application. - - to disable restoring the system's power status to active on a wake event, to enable restoring the system's power status to active on a wake event. - Suspends or hibernates the system, or requests that the system be suspended or hibernated. - - if the system is being suspended, otherwise, . - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - 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"::: - - ]]> - - - - - - - - - - - Method - - System.Windows.Forms - 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.Void - - - - - - 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"::: - - ]]> - - You cannot set the exception mode after the application has created its first window. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - An value describing how the application should behave if an exception is thrown without being caught. - - 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"::: - - ]]> - - You cannot set the exception mode after the application has created its first window. - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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. - - 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). - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Threading.ThreadExceptionEventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - Unregisters the message loop callback made with . - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Microsoft.Win32.RegistryKey - - - 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. - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether visual styles are enabled for the application. - - 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. - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Boolean - - - Gets or sets whether the wait cursor is used for all open forms of the application. - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.VisualStyles.VisualStyleState - - - 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"::: - - ]]> - - - - - + + + + + + + + + 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 + + + + 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"::: + + ]]> + + + + + + + + + + + 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 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"::: + + ]]> + + + + + + + + + + + Property + + 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 caller can quit this application. + + if the caller can quit this application; otherwise, . + + being hosted within a Web browser. Thus, the cannot quit the . + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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). + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Microsoft.Win32.RegistryKey + + + 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. + + \\\\ + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + Gets the company name associated with the application. + The company name. + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Globalization.CultureInfo + + + Gets or sets the culture information for the current thread. + A representing the culture information for the current thread. + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.InputLanguage + + + Gets or sets the current input language for the current thread. + An representing the current input language for the current thread. + + + + + + + + + + + + + + + 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 + + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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.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 + + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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. + + 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. + + + + + System.Windows.Forms + 4.0.0.0 + + + Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed. + + + + + + + + + + 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.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.Void + + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + Returns whether any within the application cancelled the exit. + Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed. + To be added. + + + + + + + + + + + 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 + + + + 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 . + + ]]> + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + + + + The Windows event message to filter. + Runs any filters against a window message, and returns a copy of the modified message. + + if the filters were processed; otherwise, . + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.HighDpiMode + + + Gets the current high DPI mode for the application. + One of the enumeration values that indicates the high DPI mode. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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"::: + + ]]> + + + + + + + + + + + Property + + 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 a message loop exists on this thread. + + if a message loop exists; otherwise, . + + to instruct Windows Forms if the hosting environment still has an active message loop. + + ]]> + + + + + + + + + + + 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.Threading.ApartmentState + + + + 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. + + ]]> + + + + + + + + + + + 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 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. + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Forms.FormCollection + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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"::: + + ]]> + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + + + + + + + + + + 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 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"::: + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets a value specifying whether the current application is drawing controls with visual styles. + + 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 .| + + ]]> + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Shuts down the application and starts a new instance immediately. + + 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. + + + + + System.Windows.Forms + 4.0.0.0 + + + Begins running a standard application message loop on the current thread. + + + + + + + + + + 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 + + + + 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. + + ]]> + + A main message loop is already running on this thread. + + + + + + + + + + + + + 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 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"::: + + ]]> + + A main message loop is already running on this thread. + + + + + + + + + + + + + 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 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"::: + + ]]> + + A main message loop is already running on the current thread. + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + Gets or sets the format string to apply to top-level window captions when they are displayed with a warning banner. + The format string to apply to top-level window captions. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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()); + } +} +``` + + ]]> + + You can only call this method before the first window is created by your Windows Forms application. + + + + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 6.0.0.0 + + + System.Void + + + + + + 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. + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + One of the enumeration values that specifies the high DPI mode to set. + Sets the high DPI mode of the process. + + if the high DPI mode was set; otherwise, . + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + + A indicating the power activity mode to which to transition. + + to force the suspended mode immediately; to cause Windows to send a suspend request to every application. + + to disable restoring the system's power status to active on a wake event, to enable restoring the system's power status to active on a wake event. + Suspends or hibernates the system, or requests that the system be suspended or hibernated. + + if the system is being suspended, otherwise, . + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + 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"::: + + ]]> + + + + + + + + + + + Method + + System.Windows.Forms + 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.Void + + + + + + 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"::: + + ]]> + + You cannot set the exception mode after the application has created its first window. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + An value describing how the application should behave if an exception is thrown without being caught. + + 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"::: + + ]]> + + You cannot set the exception mode after the application has created its first window. + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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. + + 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). + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Threading.ThreadExceptionEventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + Unregisters the message loop callback made with . + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Microsoft.Win32.RegistryKey + + + 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. + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether visual styles are enabled for the application. + + 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. + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Boolean + + + Gets or sets whether the wait cursor is used for all open forms of the application. + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.VisualStyles.VisualStyleState + + + 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"::: + + ]]> + + + + + diff --git a/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml b/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml index 95b61b94bee..5ff2725da1f 100644 --- a/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml +++ b/xml/System.Windows.Forms/ComboBox+ObjectCollection.xml @@ -1,867 +1,876 @@ - - - - - - - - - - - - - - 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.Collections.Generic.IComparer<System.Windows.Forms.ComboBox+ObjectCollection+Entry> - - - - - [System.ComponentModel.ListBindable(false)] - [<System.ComponentModel.ListBindable(false)>] - - - - 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. - - ]]> - - - - - - - - - - - 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 this object collection. - Initializes a new instance of . - - control. - - ]]> - - - - - - - - - - - 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. - - 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 . - - - - - - - - - - - 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 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 . - - - - - - - - - - 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 . - - , 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 if the specified item is located within the collection. - - 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 - - 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 copy the collection to. - The object array to copy the collection to. - 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. - - ]]> - - - - - - - - - - - - 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 use this value when looping through the values of the collection. - - ]]> - - - - - - - - - - - - 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 that can be used 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. - 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. - - ]]> - - The parameter was . - - - - - - - - - - - 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 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. - - ]]> - - The was . - The was less than zero. - - -or- - - The was greater than the count of items in the collection. - - - - - - - - - - - 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 this collection can be modified. - Always . - To be added. - - - - - - - - - - - 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 retrieve. - 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. - - ]]> - - The index was less than zero. - - -or- - - The was greater of equal to the count of items in the collection. - - - - - - - - - - - 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 - - - - - - The to remove from the list. - Removes the specified item from the . - - - - - - - - - - - - - - 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 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"::: - - ]]> - - The parameter was less than zero. - - -or- - - The parameter was greater than or equal to the count of items in the collection. - - - - - - - - - - - Method - - M:System.Collections.Generic.IComparer`1.Compare(`0,`0) - - - System.Windows.Forms - 6.0.0.0 - - - System.Int32 - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - - - - - - 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 collection. The array must have zero-based indexing. - The one-dimensional array 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. - For a description of this member, see . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - - 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 - - - - - - An object that represents the item to add to the collection. - 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. - - ]]> - - The parameter is . - There is insufficient space available to store the new item. - - - - - - - - - - - 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. - - ]]> - - - - - - + + + + + + + + + + + + + + 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.Collections.Generic.IComparer<System.Windows.Forms.ComboBox+ObjectCollection+Entry> + + + + + [System.ComponentModel.ListBindable(false)] + [<System.ComponentModel.ListBindable(false)>] + + + + 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. + + ]]> + + + + + + + + + + + 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 this object collection. + Initializes a new instance of . + + control. + + ]]> + + + + + + + + + + + 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. + + 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 . + + + + + + + + + + + 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 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 . + + + + + + + + + + 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 . + + , 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 if the specified item is located within the collection. + + 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 + + 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 copy the collection to. + The object array to copy the collection to. + 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. + + ]]> + + + + + + + + + + + + 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 use this value when looping through the values of the collection. + + ]]> + + + + + + + + + + + + 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 that can be used 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. + 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. + + ]]> + + The parameter was . + + + + + + + + + + + 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 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. + + ]]> + + The was . + The was less than zero. + + -or- + + The was greater than the count of items in the collection. + + + + + + + + + + + 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 this collection can be modified. + Always . + To be added. + + + + + + + + + + + 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 retrieve. + 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. + + ]]> + + The index was less than zero. + + -or- + + The was greater of equal to the count of items in the collection. + + + + + + + + + + + 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 + + + + + + The to remove from the list. + Removes the specified item from the . + + + + + + + + + + + + + + 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 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"::: + + ]]> + + The parameter was less than zero. + + -or- + + The parameter was greater than or equal to the count of items in the collection. + + + + + + + + + + + Method + + M:System.Collections.Generic.IComparer`1.Compare(`0,`0) + + + System.Windows.Forms + 6.0.0.0 + + + System.Int32 + + + + + + + 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. + + + + + + + + + + + + + + + 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 collection. The array must have zero-based indexing. + The one-dimensional array 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. + For a description of this member, see . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + + 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 + + + + + + An object that represents the item to add to the collection. + 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. + + ]]> + + The parameter is . + There is insufficient space available to store the new item. + + + + + + + + + + + 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. + + ]]> + + + + + + diff --git a/xml/System.Windows.Forms/Control.xml b/xml/System.Windows.Forms/Control.xml index 3a404008c95..eedd73d13ee 100644 --- a/xml/System.Windows.Forms/Control.xml +++ b/xml/System.Windows.Forms/Control.xml @@ -1,19735 +1,19734 @@ - - - - - - - - - - - - - - - - - - - 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.Component - - - - System.ComponentModel.IComponent - - - System.ComponentModel.ISynchronizeInvoke - - - System.IDisposable - - - System.Windows.Forms.IBindableComponent - - - System.Windows.Forms.IDropTarget - - - System.Windows.Forms.IWin32Window - - - - - [System.ComponentModel.DefaultEvent("Click")] - [<System.ComponentModel.DefaultEvent("Click")>] - - - [System.ComponentModel.DefaultProperty("Text")] - [<System.ComponentModel.DefaultProperty("Text")>] - - - [System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.ToolboxItemFilter("System.Windows.Forms")] - [<System.ComponentModel.ToolboxItemFilter("System.Windows.Forms")>] - - - [System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)] - [<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>] - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - [System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - - 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) - - ]]> - - 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. - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Initializes a new instance of the class. - - - - - - - - - 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")>] - - - - - 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. - - ]]> - - - - - - - - - - - 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 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. - - ]]> - - - - - - - - - - - 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 to be the parent of the control. - 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 . - - ]]> - - - - - - - - - - - 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 text displayed by the control. - The position of the control, in pixels, from the left edge of the control's container. The value is assigned to the property. - The position of the control, in pixels, from the top edge of the control's container. The value is assigned to the property. - The width of the control, in pixels. The value is assigned to the property. - 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. - - ]]> - - - - - - - - - - - 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 to be the parent of the control. - The text displayed by the control. - The position of the control, in pixels, from the left edge of the control's container. The value is assigned to the property. - The position of the control, in pixels, from the top edge of the control's container. The value is assigned to the property. - The width of the control, in pixels. The value is assigned to the property. - 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. - - ]]> - - - - - - System.Windows.Forms - 4.0.0.0 - - - Notifies the accessibility client applications of . - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Void - - - - - - - The to notify the accessibility client applications of. - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - - The to notify the accessibility client applications of. - The identifier of the . - The child to notify of the accessible event. - Notifies the accessibility client applications of the specified for the specified child control . - To be added. - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.AccessibleObject - - - 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). - - ]]> - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.String - - - 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 - - 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.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.String - - - 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 - - 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.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.String - - - 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 - - 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.DefaultValue(System.Windows.Forms.AccessibleRole.Default)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.AccessibleRole.Default)>] - - - - System.Windows.Forms.AccessibleRole - - - 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). - - ]]> - - The value assigned is not one of the values. - - - - - - - - - - - - - - - Property - - 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.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - [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 or sets a value indicating whether the control can accept data that the user drags onto it. - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - - - - Property - - 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.DefaultValue(System.Windows.Forms.AnchorStyles.Left | System.Windows.Forms.AnchorStyles.Top)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.AnchorStyles.Left | System.Windows.Forms.AnchorStyles.Top)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] - [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] - - - - System.Windows.Forms.AnchorStyles - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.DefaultValue(typeof(System.Drawing.Point), "0, 0")] - [<System.ComponentModel.DefaultValue(typeof(System.Drawing.Point), "0, 0")>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Point - - - Gets or sets where this control is scrolled to in . - A specifying the scroll location. The default is the upper-left corner of the control. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 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.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)] - [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)>] - - - - System.Boolean - - - This property is not relevant for this class. - - if enabled; otherwise, . - - - - - - - - - - - - - Event - - System.Windows.Forms - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.EventHandler - - - This event is not relevant for this class. - - - - - - - - - - - - - Property - - 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.InteropServices.DispId(-501)] - [<System.Runtime.InteropServices.DispId(-501)>] - - - - System.Drawing.Color - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Image - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(System.Windows.Forms.ImageLayout.Tile)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.ImageLayout.Tile)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Windows.Forms.ImageLayout - - - 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 . - - ]]> - - The specified enumeration value does not exist. - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Executes a delegate asynchronously on the thread that the control's underlying handle was created on. - - - - - - - - - - Method - - System.Windows.Forms - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.IAsyncResult - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.IAsyncResult - - - - - - 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. - - 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. - - - - - - - - - - - - - - - - - - Method - - M:System.ComponentModel.ISynchronizeInvoke.BeginInvoke(System.Delegate,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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.IAsyncResult - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - A delegate to a method that takes parameters of the same number and type that are contained in the parameter. - An array of objects to pass as arguments to the given method. This can be if no arguments are needed. - 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"::: - - ]]> - - No appropriate window handle can be found. - - - - - - - - - - - - - - - Property - - P:System.Windows.Forms.IBindableComponent.BindingContext - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Forms.BindingContext - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Int32 - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Rectangle - - - 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 - - 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 - - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Boolean - - - Gets a value indicating whether the property can be set to an active value, to enable IME support. - - in all cases. - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control can receive focus. - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] - - - - System.Boolean - - - Determines if events can be raised on the control. - - if the control is hosted as an ActiveX control whose events are not frozen; otherwise, . - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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 a value indicating whether the control can be selected. - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value indicating whether the control has captured the mouse. - - 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 - - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - [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 or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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/). - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.UICuesEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value indicating whether to catch calls on the wrong thread that access a control's property when an application is being debugged. - - if calls on the wrong thread are caught; otherwise, . - - property. Set to `true` to find and diagnose this thread activity more easily while debugging. - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Rectangle - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Size - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [System.ComponentModel.Description("ControlCompanyNameDescr")] - [<System.ComponentModel.Description("ControlCompanyNameDescr")>] - - - - System.String - - - 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"::: - - ]]> - - - - - - - - - - - - - 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.Boolean - - - - - - The to evaluate. - Retrieves a value indicating whether the specified control is a child of the control. - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control, or one of its child controls, currently has the input focus. - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - [System.ComponentModel.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - - System.Windows.Forms.ContextMenu - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - - System.EventHandler - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - - System.Windows.Forms.ContextMenuStrip - - - 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"::: - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - - System.Windows.Forms.ControlEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - 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(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - - System.Windows.Forms.ControlEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - 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.Content)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)>] - - - - System.Windows.Forms.Control+ControlCollection - - - 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"::: - - ]]> - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.AccessibleObject - - - - 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"::: - - ]]> - - - When overriding in a derived class, do not call the base class's method. - - - - - - - - - - - - - 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 - - - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.Control+ControlCollection - - - - Creates a new instance of the control collection for the control. - A new instance of assigned to the control. - To be added. - - The base class version of this method should not be called by a derived class. - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control has been created. - - 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. - - ]]> - - - - - - - - - - - - - - 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.Drawing.Graphics - - - - 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"::: - - ]]> - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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. - - ]]> - - The object is in a disposed state. - - When overriding in a derived class, be sure to call the base class's method to ensure that the handle is created. - - - - - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.CreateParams - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. - - - - - - - - - - - - - - - - - - - - - Property - - 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.AmbientValue(null)] - [<System.ComponentModel.AmbientValue(null)>] - - - - System.Windows.Forms.Cursor - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and methods of the property; you can override only one if needed. - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - P:System.Windows.Forms.IBindableComponent.DataBindings - - - 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.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)>] - - - [System.ComponentModel.ParenthesizePropertyName(true)] - [<System.ComponentModel.ParenthesizePropertyName(true)>] - - - [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)] - [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)>] - - - - System.Windows.Forms.ControlBindingsCollection - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Color - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.Cursor - - - 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. - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Font - - - 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"::: - - ]]> - - The default font or the regional alternative fonts are not installed on the client computer. - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Color - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.ImeMode - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Forms.Padding - - - Gets the space, in pixels, that is specified by default between controls. - A that represents the default space between controls. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Drawing.Size - - - Gets the length and height, in pixels, that is specified as the default maximum size of a control. - A representing the size of the control. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Drawing.Size - - - Gets the length and height, in pixels, that is specified as the default minimum size of a control. - A representing the size of the control. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Forms.Padding - - - Gets the internal spacing, in pixels, of the contents of a control. - A that represents the internal spacing of the contents of a control. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.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.Drawing.Size - - - 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"::: - - ]]> - - - When overriding the property in a derived class, it is preferable to return a with the desired dimensions rather than to override all the implementation. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - The Windows to process. - Sends the specified message to the default window procedure. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - Destroys the handle associated with the control. - To be added. - - When overriding in a derived class, be sure to call the base class's method to ensure that the handle is destroyed. - - - - - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Int32 - - - Gets the DPI value for the display device where the control is currently being displayed. - The DPI value of the display device. - To be added. - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Rectangle - - - 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. - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Alternatively, you must provide all the implementation. - - - - - - - - - - - - - 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 - - - - - - - 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. - - ]]> - - - - 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)). - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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 a value indicating whether the base class is in the process of disposing. - - 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. - - ]]> - - - - - - - - - - - - - - - - - - Property - - 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.DefaultValue(System.Windows.Forms.DockStyle.None)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.DockStyle.None)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] - [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] - - - - System.Windows.Forms.DockStyle - - - 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"::: - - ]]> - - The value assigned is not one of the values. - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and methods of the property; you can override only one if needed. - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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.Windows.Forms.DragDropEffects - - - - - - - The data to drag. - One of the values. - 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"::: - - ]]> - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.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.Boolean - - - Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. - - if the surface of the control should be drawn using double buffering; otherwise, . - - [!NOTE] -> is not a bindable property. - - ]]> - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - 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. - - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the DPI setting for a control is changed programmatically after the DPI of its parent control or form has changed. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the DPI setting for a control is changed programmatically before a DPI change event for its parent control or form has occurred. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DragEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DragEventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DragEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The bitmap to be drawn to. - 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. - - ]]> - - - - - - - - - - - - Property - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.Runtime.InteropServices.DispId(-514)] - [<System.Runtime.InteropServices.DispId(-514)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the control can respond to user interaction. - - 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"::: - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Method - - M:System.ComponentModel.ISynchronizeInvoke.EndInvoke(System.IAsyncResult) - - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Object - - - - - - The that represents a specific invoke asynchronous operation, returned when calling . - 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. - - ]]> - - The parameter value is . - The object was not created by a preceding call of the method from the same control. - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - 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.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.Windows.Forms.Form - - - - 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"::: - - ]]> - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - - Sets input focus to the control. - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control has input focus. - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. - - - - - - - - - - - - - - - Property - - 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.AmbientValue(null)] - [<System.ComponentModel.AmbientValue(null)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.Runtime.InteropServices.DispId(-512)] - [<System.Runtime.InteropServices.DispId(-512)>] - - - - System.Drawing.Font - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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 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. - - ]]> - - - - - - - - - - - - Property - - 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.InteropServices.DispId(-513)] - [<System.Runtime.InteropServices.DispId(-513)>] - - - - System.Drawing.Color - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.Control - - - - - - The window handle () to search for. - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.Control - - - - - - The window handle () to search for. - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.AccessibleObject - - - - - - An that identifies the to retrieve. - Retrieves the specified . - The specified . - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.AutoSizeMode - - - - Retrieves a value indicating how a control will behave when its property is enabled. - One of the values. - To be added. - - - - - System.Windows.Forms - 4.0.0.0 - - - Retrieves the child control at a specified location. - - - - - - - - - - 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.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.Windows.Forms.Control - - - - - - A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area. - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.Control - - - - - - - A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area. - One of the values of , determining whether to ignore child controls of a certain type. - Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. - The child at the specified coordinates. - To be added. - - - - - - - - - - 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.Windows.Forms.IContainerControl - - - - Returns the next up the control's chain of parent controls. - An , that represents the parent of the . - To be added. - - - - - - - - - - - - - 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.Windows.Forms.Control - - - - - - - The to start the search with. - - to search forward in the tab order; to search backward. - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Size - - - - - - The custom-sized area for a control. - 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. - - ]]> - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Rectangle - - - - - - - - A that specifies the area for which to retrieve the display bounds. - The height and width of the control's bounds. - One of the values of that specifies the bounds of the control to use when defining its size and position. - 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. - - ]]> - - - - - - - - - - - - - - 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.Boolean - - - - - - The bit to return the value from. - Retrieves the value of the specified control style bit for the control. - - 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 - - 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 - - - - Determines if the control is a top-level control. - - if the control is a top-level control; otherwise, . - To be added. - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.GiveFeedbackEventHandler - - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Property - - P:System.Windows.Forms.IWin32Window.Handle - - - 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.Runtime.InteropServices.DispId(-515)] - [<System.Runtime.InteropServices.DispId(-515)>] - - - - System.IntPtr - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control contains one or more child controls. - - 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"::: - - ]]> - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - [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.Int32 - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.HelpEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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.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.Void - - - - 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 - - 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.AmbientValue(System.Windows.Forms.ImeMode.Inherit)] - [<System.ComponentModel.AmbientValue(System.Windows.Forms.ImeMode.Inherit)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Forms.ImeMode - - - 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). - - ]]> - - The assigned value is not one of the enumeration values. - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.ImeMode - - - Gets or sets the IME mode of a control. - The IME mode of the control. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that the control is displayed correctly. - - - - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Invalidates a specific region of the control and causes a paint message to be sent to the control. - - - - - - - - - - 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.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.Void - - - - 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 - - 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 - - - - - - - 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 - - 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.Void - - - - - - 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 - - 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.Void - - - - - - 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 - - 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 that represents the region to invalidate. - - 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 - - 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 to invalidate. - - 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. - - ]]> - - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.InvalidateEventHandler - - - 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"::: - - ]]> - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Executes a delegate on the thread that owns the control's underlying window handle. - - - - - - - - - - Method - - System.Windows.Forms - 6.0.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - 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.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 - - - - - - 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. - 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 - - M:System.ComponentModel.ISynchronizeInvoke.Invoke(System.Delegate,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.Object - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - A delegate to a method that takes parameters of the same number and type that are contained in the parameter. - An array of objects to pass as arguments to the specified method. This parameter can be if the method takes no arguments. - 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"::: - - ]]> - - - - - - - - - - - - - Method - - System.Windows.Forms - 6.0.0.0 - - - T - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The to assign the event to. - An that contains the event data. - Raises the event for the specified control. - To be added. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The to assign the event to. - An that contains the event data. - Raises the event for the specified control. - To be added. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The to assign the event to. - An that contains the event data. - Raises the event for the specified control. - To be added. - - - - - - - - - - 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.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.Void - - - - - - - The to assign the event to. - An that contains the event data. - Raises the event for the specified control. - To be added. - - - - - - - - - - - - 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.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.Void - - - - - - - The to assign the event to. - An that contains the event data. - Raises the event for the specified control. - To be added. - - - - - - - - - - - Property - - P:System.ComponentModel.ISynchronizeInvoke.InvokeRequired - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. - - 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). - - ]]> - - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value indicating whether the control is visible to accessibility applications. - - if the control is visible to accessibility applications; otherwise, . - To be added. - - - - - - - - - - - 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 - - - To be added. - To be added. - To be added. - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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 a value indicating whether the control has been disposed of. - - if the control has been disposed of; otherwise, . - - method. - - ]]> - - - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control has a handle associated with it. - - if a handle has been assigned to the control; otherwise, . - - property to determine whether has been called. - - ]]> - - - - - - - - - - - - - - - - - - - - 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.Boolean - - - - - - The character to test. - Determines if a character is an input character that the control recognizes. - - 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 - - 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 - - - - - - One of the values. - Determines whether the specified key is a regular input key or a special key that requires preprocessing. - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The CAPS LOCK, NUM LOCK, or SCROLL LOCK member of the enumeration. - Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. - - 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"::: - - ]]> - - The parameter refers to a key other than the CAPS LOCK, NUM LOCK, or SCROLL LOCK key. - - - - - - - - - - Property - - System.Windows.Forms - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control is mirrored. - - if the control is mirrored; otherwise, . - - - - - - - - - - - - - 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.Boolean - - - - - - - The character to test. - The string to search. - Determines if the specified character is the mnemonic character assigned to the control in the specified string. - - 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"::: - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.KeyEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.KeyPressEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.KeyEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.LayoutEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] - - - - System.Windows.Forms.Layout.LayoutEngine - - - 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. - - ]]> - - - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - [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.Int32 - - - 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 - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Point - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Size - - - - - - The size to be scaled. - Transforms a size from logical to device units by scaling it for the current DPI and rounding down to the nearest integer value for width and height. - The scaled size. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - The Logical value to convert. - Converts a Logical DPI value to its equivalent DeviceUnit DPI value. - The resulting DeviceUnit value. - To be added. - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Windows.Forms.Padding - - - 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. - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.AmbientValue(typeof(System.Drawing.Size), "0, 0")] - [<System.ComponentModel.AmbientValue(typeof(System.Drawing.Size), "0, 0")>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Size - - - Gets or sets the size that is the upper limit that can specify. - An ordered pair of type representing the width and height of a rectangle. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Size - - - Gets or sets the size that is the lower limit that can specify. - An ordered pair of type representing the width and height of a rectangle. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.Keys - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MouseButtons - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MouseEventHandler - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MouseEventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MouseEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MouseEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Point - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MouseEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.MouseEventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - 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.String - - - 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"::: - - ]]> - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - A representing the area to invalidate. - Raises the event with a specified region of the control to invalidate. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - Method - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event and for typical docking and anchoring functions to work. Derived classes should override this method to do any custom layout logic. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, calling the base class's method is not necessary because there is no initial implementation. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - Inheriting classes should override this method to handle the erase background request from windows. When overriding in a derived class it is not necessary to call the base class's . - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - A that contains the event data. - Raises the event. - - is set, you can override to do layered painting. See for more information. - - ]]> - - The parameter 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. The method can be called during construction, so if you override it can be called before the control constructor is called. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Windows.Forms.Padding - - - 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 - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.PaintEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - 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)>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Forms.Control - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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/). - - ]]> - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Forces the control to apply layout logic to child controls. - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - A that represents the most recently changed control. - 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 - - 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.Drawing.Point - - - - - - The screen coordinate to convert. - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Point - - - - - - The client coordinate to convert. - 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"::: - - ]]> - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.Drawing.Size - - - Gets the size of a rectangular area into which the control can fit. - A containing the height and width, in pixels. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Windows.Forms.PreProcessControlState - - - - - - A that represents the message to process. - Preprocesses keyboard or input messages within the message loop before they are dispatched. - One of the values, depending on whether is or and whether or are or . - To be added. - - - - - - - - - - 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.Boolean - - - - - - A , passed by reference, that represents the message to process. The possible values are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. - Preprocesses keyboard or input messages within the message loop before they are dispatched. - - 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 . - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.PreviewKeyDownEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - 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.Boolean - - - - - - - A , passed by reference, that represents the window message to process. - One of the values that represents the key to process. - Processes a command key. - - 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. - - ]]> - - - When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. - - - - - - - - - - - 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.Boolean - - - - - - The character to process. - Processes a dialog character. - - 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. - - ]]> - - - When overriding the method in a derived class, a control should return to indicate that it has processed the character. For characters that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. - - - - - - - - - - - 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.Boolean - - - - - - One of the values that represents the key to process. - Processes a dialog key. - - 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. - - ]]> - - - When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. - - - - - - - - - - - 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.Boolean - - - - - - A , passed by reference, that represents the window message to process. - Processes a key message and generates the appropriate control events. - - 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. - - ]]> - - - When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. - - - - - - - - - - - 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.Boolean - - - - - - A , passed by reference, that represents the window message to process. - Processes a keyboard message. - - 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. - - ]]> - - - When overriding the method, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of the base class's should be returned. Controls will seldom, if ever, need to override this method. - - - - - - - - - - - - - - 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.Boolean - - - - - - A , passed by reference, that represents the window message to process. - Previews a keyboard message. - - 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. - - ]]> - - - When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. - - - - - - - - - - - - - - - - - - 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.Boolean - - - - - - The character to process. - Processes a mnemonic character. - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.String - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.String - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.ImeMode - - - Gets an object that represents a propagating IME mode. - An object that represents a propagating IME mode. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.QueryAccessibilityHelpEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.QueryContinueDragEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The event to raise. - A that contains the event data. - Raises the appropriate drag event. - To be added. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The event to raise. - A that contains the event data. - Raises the appropriate key event. - To be added. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The event to raise. - A that contains the event data. - Raises the appropriate mouse event. - To be added. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The event to raise. - A that contains the event data. - Raises the appropriate paint event. - To be added. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Void - - - - 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`. - - ]]> - - - - - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control is currently re-creating its handle. - - if the control is currently re-creating its handle; otherwise, . - - property returns `true` if the method is still running on the control. - - ]]> - - - - - - - - - - - - - - - - - - - - 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.Drawing.Rectangle - - - - - - The screen coordinate to convert. - Computes the size and location of the specified screen rectangle in client coordinates. - A that represents the converted , , in client coordinates. - To be added. - - - - - - - - - - - - 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.Drawing.Rectangle - - - - - - The client coordinate to convert. - 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"::: - - ]]> - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - - - - - An representing the handle of the control to reflect the message to. - A representing the Windows message to reflect. - Reflects the specified message to the control that is bound to the specified handle. - - 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 - - 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 - - - - Forces the control to invalidate its client area and immediately redraw itself and any child controls. - To be added. - - When overriding in a derived class, be sure to call the base class's method so the control and its child controls are invalidated and redrawn. - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Region - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Obsolete("This property has been deprecated. Please use RightToLeft instead. http://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated. Please use RightToLeft instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.Obsolete("This property has been deprecated. Please use RightToLeft instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated. Please use RightToLeft instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - - - - System.Boolean - - - This property is now obsolete. - - if the control is rendered from right to left; otherwise, . The default is . - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The DPI value prior to the change. - The DPI value after the change. - Provides constants for rescaling the control when a DPI change occurs. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Void - - - - Resets the property to its default value. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Void - - - - Causes a control bound to the to reread all the items in the list and refresh their displayed values. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [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.Void - - - - Resets the property to its default value. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [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.Void - - - - Resets the property to its default value. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Void - - - - Resets the property to its default value. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Void - - - - Resets the property to its default value. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - Resets the control to handle the event. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [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.Void - - - - Resets the property to its default value. - - - - - - - - - - - - - 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 - - - - Resets the property to its default value (). - - or creating your own control incorporating the . - - ]]> - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value indicating whether the control redraws itself when resized. - - 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. - - ]]> - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Resumes the usual layout logic. - - - - - - - - - - - - - - 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.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.Void - - - - 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 - - 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 - - - - - - - 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. - - ]]> - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Int32 - - - 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 - - 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.AmbientValue(System.Windows.Forms.RightToLeft.Inherit)] - [<System.ComponentModel.AmbientValue(System.Windows.Forms.RightToLeft.Inherit)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Windows.Forms.RightToLeft - - - 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. - - ]]> - - The assigned value is not one of the values. - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Converts the current alignment to the appropriate alignment to support right-to-left text. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Drawing.ContentAlignment - - - - - - One of the values. - 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. - - ]]> - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Windows.Forms.HorizontalAlignment - - - - - - One of the values. - 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. - - ]]> - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [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.Windows.Forms.LeftRightAlignment - - - - - - One of the values. - 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. - - ]]> - - - - - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.ContentAlignment - - - - - - One of the values. - 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. - - ]]> - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.HorizontalAlignment - - - - - - One of the values. - 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. - - ]]> - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.LeftRightAlignment - - - - - - One of the values. - 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. - - ]]> - - - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Scales the control and any child controls. - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - - - [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.Void - - - - - - The ratio to use for scaling. - Scales the control and any child controls. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - - - - System.Void - - - - - - - The horizontal scaling factor. - The vertical scaling factor. - Scales the entire control and any child controls. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The bitmap to scale. - Scales a logical bitmap value to it's equivalent device unit value when a DPI change occurs. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value that determines the scaling of child controls. - - 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. - - ]]> - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The factor by which the height and width of the control will be scaled. - 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. - - - - - - - - - - ]]> - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The horizontal scaling factor. - The vertical scaling factor. - This method is not relevant for this class. - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - 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 - - 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.Void - - - - 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"::: - - ]]> - - - - - - - - - - - - - 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 - - - - - - - - to specify the direction of the control to select; otherwise, . - - 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. - - - - - - - - - - - - - - - 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.Boolean - - - - - - - - - - The at which to start the search. - - to move forward in the tab order; to move backward in the tab order. - - to ignore the controls with the property set to ; otherwise, . - - to include nested (children of child controls) child controls; otherwise, . - - to continue searching from the first control in the tab order after the last control has been reached; otherwise, . - Activates the next control. - - 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 - - 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 - - - - 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. - - ]]> - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - One of the values. - Sets a value indicating how a control will behave when its property is enabled. - To be added. - - - - - System.Windows.Forms - 4.0.0.0 - - - Sets the bounds of the control. - - - - - - - - - - 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 new property value of the control. - The new property value of the control. - The new property value of the control. - The new property value of the control. - Sets the bounds of the control to the specified location and size. - To be added. - - - - - - - - - - - - - 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 new property value of the control. - The new property value of the control. - The new property value of the control. - The new property value of the control. - 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"::: - - ]]> - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - - - - The new property value of the control. - The new property value of the control. - The new property value of the control. - The new property value of the control. - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method to force the bounds of the control to change. Derived classes can add size restrictions to the method. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The client area width, in pixels. - 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"::: - - ]]> - - - 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). - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The bit to set. - - 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 - - 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 - - - - - - - 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`. - - ]]> - - The parameter is set to and the control is an ActiveX control. - The return value is not equal to the parameter and the property is not . - - - - - - - - - - - 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 - - - - - - - to make the control visible; otherwise, . - Sets the control to the specified visible state. - - - - - When overriding in a derived class, be sure to call the base class's method to force the visibility of the control to change. - - - - - - - - - - - - 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.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.Void - - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the control should display focus rectangles. - - if the control should display focus rectangles; otherwise, . - - - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. - - - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. - - if the keyboard accelerators are visible; otherwise, . - - - - - - - - - - - - - - - - Property - - P:System.ComponentModel.IComponent.Site - - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.ComponentModel.ISite - - - Gets or sets the site of the control. - The associated with the , if any. - To be added. - - - - - - - - - - - - Property - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Size - - - 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"::: - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Size - - - - - - A value representing the height and width of the control's client area. - Determines the size of the entire control from the height and width of its client area. - A value representing the height and width of the entire control. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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 - - - - 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 - - M:System.Windows.Forms.IDropTarget.OnDragDrop(System.Windows.Forms.DragEventArgs) - - - System.Windows.Forms - 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.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - M:System.Windows.Forms.IDropTarget.OnDragEnter(System.Windows.Forms.DragEventArgs) - - - System.Windows.Forms - 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.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - M:System.Windows.Forms.IDropTarget.OnDragLeave(System.EventArgs) - - - System.Windows.Forms - 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.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - M:System.Windows.Forms.IDropTarget.OnDragOver(System.Windows.Forms.DragEventArgs) - - - System.Windows.Forms - 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.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.MergableProperty(false)] - [<System.ComponentModel.MergableProperty(false)>] - - - - System.Int32 - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - [System.Runtime.InteropServices.DispId(-516)] - [<System.Runtime.InteropServices.DispId(-516)>] - - - [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 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 . - -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"::: - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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.Bindable(true)] - [<System.ComponentModel.Bindable(true)>] - - - [System.ComponentModel.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - [System.ComponentModel.Localizable(false)] - [<System.ComponentModel.Localizable(false)>] - - - [System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))>] - - - - System.Object - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - 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.Bindable(true)] - [<System.ComponentModel.Bindable(true)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.Runtime.InteropServices.DispId(-517)] - [<System.Runtime.InteropServices.DispId(-517)>] - - - - System.String - - - 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"::: - - ]]> - - - When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - [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.Int32 - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.Control - - - 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`. - - ]]> - - - - - - - - - - - - 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 - - - - 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. - - ]]> - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Updates the bounds of the control. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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. - - ]]> - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - - - The coordinate of the control. - The coordinate of the control. - The of the control. - 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. - - ]]> - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - - - - - The coordinate of the control. - The coordinate of the control. - The of the control. - The of the control. - The client of the control. - 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. - - ]]> - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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. - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - [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 or sets a value indicating whether to use the wait cursor for the current control and all child controls. - - to use the wait cursor for the current control and all child controls; otherwise, . The default is . - - property. - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - 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.CancelEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value indicating whether the control and all its child controls are displayed. - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - [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.Int32 - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Windows.Forms.IWindowTarget - - - This property is not relevant for this class. - The NativeWindow contained within the control. - - - - - - - - - - - - - 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 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"::: - - ]]> - - - Inheriting controls should call the base class's method to process any messages that they do not handle. - - - - - - - + + + + + + + + + + + + + + + + + + + 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.Component + + + + System.ComponentModel.IComponent + + + System.ComponentModel.ISynchronizeInvoke + + + System.IDisposable + + + System.Windows.Forms.IBindableComponent + + + System.Windows.Forms.IDropTarget + + + System.Windows.Forms.IWin32Window + + + + + [System.ComponentModel.DefaultEvent("Click")] + [<System.ComponentModel.DefaultEvent("Click")>] + + + [System.ComponentModel.DefaultProperty("Text")] + [<System.ComponentModel.DefaultProperty("Text")>] + + + [System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.ToolboxItemFilter("System.Windows.Forms")] + [<System.ComponentModel.ToolboxItemFilter("System.Windows.Forms")>] + + + [System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)] + [<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>] + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + [System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Design.Serialization.DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.ControlDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + + 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) + + ]]> + + 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. + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Initializes a new instance of the class. + + + + + + + + + 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")>] + + + + + 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. + + ]]> + + + + + + + + + + + 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 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. + + ]]> + + + + + + + + + + + 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 to be the parent of the control. + 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 . + + ]]> + + + + + + + + + + + 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 text displayed by the control. + The position of the control, in pixels, from the left edge of the control's container. The value is assigned to the property. + The position of the control, in pixels, from the top edge of the control's container. The value is assigned to the property. + The width of the control, in pixels. The value is assigned to the property. + 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. + + ]]> + + + + + + + + + + + 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 to be the parent of the control. + The text displayed by the control. + The position of the control, in pixels, from the left edge of the control's container. The value is assigned to the property. + The position of the control, in pixels, from the top edge of the control's container. The value is assigned to the property. + The width of the control, in pixels. The value is assigned to the property. + 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. + + ]]> + + + + + + System.Windows.Forms + 4.0.0.0 + + + Notifies the accessibility client applications of . + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Void + + + + + + + The to notify the accessibility client applications of. + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + + The to notify the accessibility client applications of. + The identifier of the . + The child to notify of the accessible event. + Notifies the accessibility client applications of the specified for the specified child control . + To be added. + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.AccessibleObject + + + 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). + + ]]> + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.String + + + 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 + + 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.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.String + + + 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 + + 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.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.String + + + 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 + + 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.DefaultValue(System.Windows.Forms.AccessibleRole.Default)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.AccessibleRole.Default)>] + + + + System.Windows.Forms.AccessibleRole + + + 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). + + ]]> + + The value assigned is not one of the values. + + + + + + + + + + + + + + + Property + + 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.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + [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 or sets a value indicating whether the control can accept data that the user drags onto it. + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + + + + Property + + 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.DefaultValue(System.Windows.Forms.AnchorStyles.Left | System.Windows.Forms.AnchorStyles.Top)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.AnchorStyles.Left | System.Windows.Forms.AnchorStyles.Top)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] + [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] + + + + System.Windows.Forms.AnchorStyles + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.DefaultValue(typeof(System.Drawing.Point), "0, 0")] + [<System.ComponentModel.DefaultValue(typeof(System.Drawing.Point), "0, 0")>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Point + + + Gets or sets where this control is scrolled to in . + A specifying the scroll location. The default is the upper-left corner of the control. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 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.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)] + [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)>] + + + + System.Boolean + + + This property is not relevant for this class. + + if enabled; otherwise, . + + + + + + + + + + + + + Event + + System.Windows.Forms + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.EventHandler + + + This event is not relevant for this class. + + + + + + + + + + + + + Property + + 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.InteropServices.DispId(-501)] + [<System.Runtime.InteropServices.DispId(-501)>] + + + + System.Drawing.Color + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Image + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(System.Windows.Forms.ImageLayout.Tile)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.ImageLayout.Tile)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Windows.Forms.ImageLayout + + + 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 . + + ]]> + + The specified enumeration value does not exist. + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Executes a delegate asynchronously on the thread that the control's underlying handle was created on. + + + + + + + + + + Method + + System.Windows.Forms + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.IAsyncResult + + + + + + 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. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.IAsyncResult + + + + + + 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. + + 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. + + + + + + + + + + + + + + + + + + Method + + M:System.ComponentModel.ISynchronizeInvoke.BeginInvoke(System.Delegate,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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.IAsyncResult + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + A delegate to a method that takes parameters of the same number and type that are contained in the parameter. + An array of objects to pass as arguments to the given method. This can be if no arguments are needed. + 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"::: + + ]]> + + No appropriate window handle can be found. + + + + + + + + + + + + + + + Property + + P:System.Windows.Forms.IBindableComponent.BindingContext + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Forms.BindingContext + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Int32 + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Rectangle + + + 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 + + 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 + + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Boolean + + + Gets a value indicating whether the property can be set to an active value, to enable IME support. + + in all cases. + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control can receive focus. + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] + + + + System.Boolean + + + Determines if events can be raised on the control. + + if the control is hosted as an ActiveX control whose events are not frozen; otherwise, . + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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 a value indicating whether the control can be selected. + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value indicating whether the control has captured the mouse. + + 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 + + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + [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 or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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/). + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.UICuesEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value indicating whether to catch calls on the wrong thread that access a control's property when an application is being debugged. + + if calls on the wrong thread are caught; otherwise, . + + property. Set to `true` to find and diagnose this thread activity more easily while debugging. + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Rectangle + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Size + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [System.ComponentModel.Description("ControlCompanyNameDescr")] + [<System.ComponentModel.Description("ControlCompanyNameDescr")>] + + + + System.String + + + 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"::: + + ]]> + + + + + + + + + + + + + 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.Boolean + + + + + + The to evaluate. + Retrieves a value indicating whether the specified control is a child of the control. + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control, or one of its child controls, currently has the input focus. + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + [System.ComponentModel.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + + System.Windows.Forms.ContextMenu + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + + System.EventHandler + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + + System.Windows.Forms.ContextMenuStrip + + + 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"::: + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + + System.Windows.Forms.ControlEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + 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(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + + System.Windows.Forms.ControlEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + 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.Content)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)>] + + + + System.Windows.Forms.Control+ControlCollection + + + 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"::: + + ]]> + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.AccessibleObject + + + + 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"::: + + ]]> + + + When overriding in a derived class, do not call the base class's method. + + + + + + + + + + + + + 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 + + + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.Control+ControlCollection + + + + Creates a new instance of the control collection for the control. + A new instance of assigned to the control. + To be added. + + The base class version of this method should not be called by a derived class. + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control has been created. + + 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. + + ]]> + + + + + + + + + + + + + + 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.Drawing.Graphics + + + + 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"::: + + ]]> + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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. + + ]]> + + The object is in a disposed state. + + When overriding in a derived class, be sure to call the base class's method to ensure that the handle is created. + + + + + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.CreateParams + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. + + + + + + + + + + + + + + + + + + + + + Property + + 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.AmbientValue(null)] + [<System.ComponentModel.AmbientValue(null)>] + + + + System.Windows.Forms.Cursor + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and methods of the property; you can override only one if needed. + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + P:System.Windows.Forms.IBindableComponent.DataBindings + + + 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.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)>] + + + [System.ComponentModel.ParenthesizePropertyName(true)] + [<System.ComponentModel.ParenthesizePropertyName(true)>] + + + [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)] + [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)>] + + + + System.Windows.Forms.ControlBindingsCollection + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Color + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.Cursor + + + 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. + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Font + + + 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"::: + + ]]> + + The default font or the regional alternative fonts are not installed on the client computer. + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Color + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.ImeMode + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Forms.Padding + + + Gets the space, in pixels, that is specified by default between controls. + A that represents the default space between controls. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Drawing.Size + + + Gets the length and height, in pixels, that is specified as the default maximum size of a control. + A representing the size of the control. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Drawing.Size + + + Gets the length and height, in pixels, that is specified as the default minimum size of a control. + A representing the size of the control. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Forms.Padding + + + Gets the internal spacing, in pixels, of the contents of a control. + A that represents the internal spacing of the contents of a control. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.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.Drawing.Size + + + 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"::: + + ]]> + + + When overriding the property in a derived class, it is preferable to return a with the desired dimensions rather than to override all the implementation. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + The Windows to process. + Sends the specified message to the default window procedure. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + Destroys the handle associated with the control. + To be added. + + When overriding in a derived class, be sure to call the base class's method to ensure that the handle is destroyed. + + + + + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Int32 + + + Gets the DPI value for the display device where the control is currently being displayed. + The DPI value of the display device. + To be added. + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Rectangle + + + 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. + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Alternatively, you must provide all the implementation. + + + + + + + + + + + + + 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 + + + + + + + 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. + + ]]> + + + + 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)). + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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 a value indicating whether the base class is in the process of disposing. + + 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. + + ]]> + + + + + + + + + + + + + + + + + + Property + + 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.DefaultValue(System.Windows.Forms.DockStyle.None)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.DockStyle.None)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] + [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] + + + + System.Windows.Forms.DockStyle + + + 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"::: + + ]]> + + The value assigned is not one of the values. + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and methods of the property; you can override only one if needed. + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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.Windows.Forms.DragDropEffects + + + + + + + The data to drag. + One of the values. + 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"::: + + ]]> + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.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.Boolean + + + Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. + + if the surface of the control should be drawn using double buffering; otherwise, . + + [!NOTE] +> is not a bindable property. + + ]]> + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + 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. + + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the DPI setting for a control is changed programmatically after the DPI of its parent control or form has changed. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the DPI setting for a control is changed programmatically before a DPI change event for its parent control or form has occurred. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DragEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DragEventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DragEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The bitmap to be drawn to. + 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. + + ]]> + + + + + + + + + + + + Property + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.Runtime.InteropServices.DispId(-514)] + [<System.Runtime.InteropServices.DispId(-514)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the control can respond to user interaction. + + 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"::: + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Method + + M:System.ComponentModel.ISynchronizeInvoke.EndInvoke(System.IAsyncResult) + + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Object + + + + + + The that represents a specific invoke asynchronous operation, returned when calling . + 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. + + ]]> + + The parameter value is . + The object was not created by a preceding call of the method from the same control. + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + 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.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.Windows.Forms.Form + + + + 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"::: + + ]]> + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + + Sets input focus to the control. + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control has input focus. + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. + + + + + + + + + + + + + + + Property + + 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.AmbientValue(null)] + [<System.ComponentModel.AmbientValue(null)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.Runtime.InteropServices.DispId(-512)] + [<System.Runtime.InteropServices.DispId(-512)>] + + + + System.Drawing.Font + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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 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. + + ]]> + + + + + + + + + + + + Property + + 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.InteropServices.DispId(-513)] + [<System.Runtime.InteropServices.DispId(-513)>] + + + + System.Drawing.Color + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.Control + + + + + + The window handle () to search for. + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.Control + + + + + + The window handle () to search for. + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.AccessibleObject + + + + + + An that identifies the to retrieve. + Retrieves the specified . + The specified . + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.AutoSizeMode + + + + Retrieves a value indicating how a control will behave when its property is enabled. + One of the values. + To be added. + + + + + System.Windows.Forms + 4.0.0.0 + + + Retrieves the child control at a specified location. + + + + + + + + + + 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.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.Windows.Forms.Control + + + + + + A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area. + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.Control + + + + + + + A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area. + One of the values of , determining whether to ignore child controls of a certain type. + Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. + The child at the specified coordinates. + To be added. + + + + + + + + + + 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.Windows.Forms.IContainerControl + + + + Returns the next up the control's chain of parent controls. + An , that represents the parent of the . + To be added. + + + + + + + + + + + + + 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.Windows.Forms.Control + + + + + + + The to start the search with. + + to search forward in the tab order; to search backward. + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Size + + + + + + The custom-sized area for a control. + 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. + + ]]> + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Rectangle + + + + + + + + A that specifies the area for which to retrieve the display bounds. + The height and width of the control's bounds. + One of the values of that specifies the bounds of the control to use when defining its size and position. + 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. + + ]]> + + + + + + + + + + + + + + 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.Boolean + + + + + + The bit to return the value from. + Retrieves the value of the specified control style bit for the control. + + 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 + + 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 + + + + Determines if the control is a top-level control. + + if the control is a top-level control; otherwise, . + To be added. + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.GiveFeedbackEventHandler + + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Property + + P:System.Windows.Forms.IWin32Window.Handle + + + 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.Runtime.InteropServices.DispId(-515)] + [<System.Runtime.InteropServices.DispId(-515)>] + + + + System.IntPtr + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control contains one or more child controls. + + 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"::: + + ]]> + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + [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.Int32 + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.HelpEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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.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.Void + + + + 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 + + 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.AmbientValue(System.Windows.Forms.ImeMode.Inherit)] + [<System.ComponentModel.AmbientValue(System.Windows.Forms.ImeMode.Inherit)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Forms.ImeMode + + + 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). + + ]]> + + The assigned value is not one of the enumeration values. + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.ImeMode + + + Gets or sets the IME mode of a control. + The IME mode of the control. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that the control is displayed correctly. + + + + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Invalidates a specific region of the control and causes a paint message to be sent to the control. + + + + + + + + + + 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.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.Void + + + + 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 + + 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 + + + + + + + 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 + + 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.Void + + + + + + 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 + + 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.Void + + + + + + 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 + + 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 that represents the region to invalidate. + + 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 + + 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 to invalidate. + + 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. + + ]]> + + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.InvalidateEventHandler + + + 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"::: + + ]]> + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Executes a delegate on the thread that owns the control's underlying window handle. + + + + + + + + + + Method + + System.Windows.Forms + 6.0.0.0 + + + System.Void + + + + + + 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. + + + + + + + + + + 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.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 + + + + + + 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. + 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 + + M:System.ComponentModel.ISynchronizeInvoke.Invoke(System.Delegate,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.Object + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + A delegate to a method that takes parameters of the same number and type that are contained in the parameter. + An array of objects to pass as arguments to the specified method. This parameter can be if the method takes no arguments. + 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"::: + + ]]> + + + + + + + + + + + + + Method + + System.Windows.Forms + 6.0.0.0 + + + T + + + + + + + + + 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. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The to assign the event to. + An that contains the event data. + Raises the event for the specified control. + To be added. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The to assign the event to. + An that contains the event data. + Raises the event for the specified control. + To be added. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The to assign the event to. + An that contains the event data. + Raises the event for the specified control. + To be added. + + + + + + + + + + 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.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.Void + + + + + + + The to assign the event to. + An that contains the event data. + Raises the event for the specified control. + To be added. + + + + + + + + + + + + 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.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.Void + + + + + + + The to assign the event to. + An that contains the event data. + Raises the event for the specified control. + To be added. + + + + + + + + + + + Property + + P:System.ComponentModel.ISynchronizeInvoke.InvokeRequired + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. + + 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). + + ]]> + + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value indicating whether the control is visible to accessibility applications. + + if the control is visible to accessibility applications; otherwise, . + To be added. + + + + + + + + + + + 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. + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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 a value indicating whether the control has been disposed of. + + if the control has been disposed of; otherwise, . + + method. + + ]]> + + + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control has a handle associated with it. + + if a handle has been assigned to the control; otherwise, . + + property to determine whether has been called. + + ]]> + + + + + + + + + + + + + + + + + + + + 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.Boolean + + + + + + The character to test. + Determines if a character is an input character that the control recognizes. + + 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 + + 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 + + + + + + One of the values. + Determines whether the specified key is a regular input key or a special key that requires preprocessing. + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The CAPS LOCK, NUM LOCK, or SCROLL LOCK member of the enumeration. + Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. + + 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"::: + + ]]> + + The parameter refers to a key other than the CAPS LOCK, NUM LOCK, or SCROLL LOCK key. + + + + + + + + + + Property + + System.Windows.Forms + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control is mirrored. + + if the control is mirrored; otherwise, . + + + + + + + + + + + + + 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.Boolean + + + + + + + The character to test. + The string to search. + Determines if the specified character is the mnemonic character assigned to the control in the specified string. + + 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"::: + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.KeyEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.KeyPressEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.KeyEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.LayoutEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] + + + + System.Windows.Forms.Layout.LayoutEngine + + + 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. + + ]]> + + + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + [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.Int32 + + + 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 + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Point + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Size + + + + + + The size to be scaled. + Transforms a size from logical to device units by scaling it for the current DPI and rounding down to the nearest integer value for width and height. + The scaled size. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + The Logical value to convert. + Converts a Logical DPI value to its equivalent DeviceUnit DPI value. + The resulting DeviceUnit value. + To be added. + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Windows.Forms.Padding + + + 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. + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.AmbientValue(typeof(System.Drawing.Size), "0, 0")] + [<System.ComponentModel.AmbientValue(typeof(System.Drawing.Size), "0, 0")>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Size + + + Gets or sets the size that is the upper limit that can specify. + An ordered pair of type representing the width and height of a rectangle. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Size + + + Gets or sets the size that is the lower limit that can specify. + An ordered pair of type representing the width and height of a rectangle. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.Keys + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MouseButtons + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MouseEventHandler + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MouseEventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MouseEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MouseEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Point + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MouseEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.MouseEventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + 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.String + + + 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"::: + + ]]> + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + A representing the area to invalidate. + Raises the event with a specified region of the control to invalidate. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + Method + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event and for typical docking and anchoring functions to work. Derived classes should override this method to do any custom layout logic. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, calling the base class's method is not necessary because there is no initial implementation. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + Inheriting classes should override this method to handle the erase background request from windows. When overriding in a derived class it is not necessary to call the base class's . + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + A that contains the event data. + Raises the event. + + is set, you can override to do layered painting. See for more information. + + ]]> + + The parameter 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. The method can be called during construction, so if you override it can be called before the control constructor is called. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Windows.Forms.Padding + + + 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 + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.PaintEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + 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)>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Forms.Control + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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/). + + ]]> + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Forces the control to apply layout logic to child controls. + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + A that represents the most recently changed control. + 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 + + 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.Drawing.Point + + + + + + The screen coordinate to convert. + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Point + + + + + + The client coordinate to convert. + 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"::: + + ]]> + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.Drawing.Size + + + Gets the size of a rectangular area into which the control can fit. + A containing the height and width, in pixels. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Windows.Forms.PreProcessControlState + + + + + + A that represents the message to process. + Preprocesses keyboard or input messages within the message loop before they are dispatched. + One of the values, depending on whether is or and whether or are or . + + + + + + + + + + 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.Boolean + + + + + + A , passed by reference, that represents the message to process. The possible values are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. + Preprocesses keyboard or input messages within the message loop before they are dispatched. + + 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 . + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.PreviewKeyDownEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + 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.Boolean + + + + + + + A , passed by reference, that represents the window message to process. + One of the values that represents the key to process. + Processes a command key. + + 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. + + ]]> + + + When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. + + + + + + + + + + + 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.Boolean + + + + + + The character to process. + Processes a dialog character. + + 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. + + ]]> + + + When overriding the method in a derived class, a control should return to indicate that it has processed the character. For characters that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. + + + + + + + + + + + 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.Boolean + + + + + + One of the values that represents the key to process. + Processes a dialog key. + + 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. + + ]]> + + + When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. + + + + + + + + + + + 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.Boolean + + + + + + A , passed by reference, that represents the window message to process. + Processes a key message and generates the appropriate control events. + + 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. + + ]]> + + + When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. Controls will seldom, if ever, need to override this method. + + + + + + + + + + + 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.Boolean + + + + + + A , passed by reference, that represents the window message to process. + Processes a keyboard message. + + 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. + + ]]> + + + When overriding the method, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of the base class's should be returned. Controls will seldom, if ever, need to override this method. + + + + + + + + + + + + + + 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.Boolean + + + + + + A , passed by reference, that represents the window message to process. + Previews a keyboard message. + + 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. + + ]]> + + + When overriding the method in a derived class, a control should return to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's method should be returned. + + + + + + + + + + + + + + + + + + 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.Boolean + + + + + + The character to process. + Processes a mnemonic character. + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.String + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.String + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.ImeMode + + + Gets an object that represents a propagating IME mode. + An object that represents a propagating IME mode. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.QueryAccessibilityHelpEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.QueryContinueDragEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The event to raise. + A that contains the event data. + Raises the appropriate drag event. + To be added. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The event to raise. + A that contains the event data. + Raises the appropriate key event. + To be added. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The event to raise. + A that contains the event data. + Raises the appropriate mouse event. + To be added. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The event to raise. + A that contains the event data. + Raises the appropriate paint event. + To be added. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Void + + + + 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`. + + ]]> + + + + + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control is currently re-creating its handle. + + if the control is currently re-creating its handle; otherwise, . + + property returns `true` if the method is still running on the control. + + ]]> + + + + + + + + + + + + + + + + + + + + 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.Drawing.Rectangle + + + + + + The screen coordinate to convert. + Computes the size and location of the specified screen rectangle in client coordinates. + A that represents the converted , , in client coordinates. + To be added. + + + + + + + + + + + + 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.Drawing.Rectangle + + + + + + The client coordinate to convert. + 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"::: + + ]]> + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + + + + + An representing the handle of the control to reflect the message to. + A representing the Windows message to reflect. + Reflects the specified message to the control that is bound to the specified handle. + + 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 + + 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 + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + To be added. + + When overriding in a derived class, be sure to call the base class's method so the control and its child controls are invalidated and redrawn. + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Region + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Obsolete("This property has been deprecated. Please use RightToLeft instead. http://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This property has been deprecated. Please use RightToLeft instead. http://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.Obsolete("This property has been deprecated. Please use RightToLeft instead. https://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This property has been deprecated. Please use RightToLeft instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + + + System.Boolean + + + This property is now obsolete. + + if the control is rendered from right to left; otherwise, . The default is . + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The DPI value prior to the change. + The DPI value after the change. + Provides constants for rescaling the control when a DPI change occurs. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Void + + + + Resets the property to its default value. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Void + + + + Causes a control bound to the to reread all the items in the list and refresh their displayed values. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [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.Void + + + + Resets the property to its default value. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [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.Void + + + + Resets the property to its default value. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Void + + + + Resets the property to its default value. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Void + + + + Resets the property to its default value. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + Resets the control to handle the event. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [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.Void + + + + Resets the property to its default value. + + + + + + + + + + + + + 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 + + + + Resets the property to its default value (). + + or creating your own control incorporating the . + + ]]> + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value indicating whether the control redraws itself when resized. + + 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. + + ]]> + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Resumes the usual layout logic. + + + + + + + + + + + + + + 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.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.Void + + + + 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 + + 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 + + + + + + + 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. + + ]]> + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Int32 + + + 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 + + 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.AmbientValue(System.Windows.Forms.RightToLeft.Inherit)] + [<System.ComponentModel.AmbientValue(System.Windows.Forms.RightToLeft.Inherit)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Windows.Forms.RightToLeft + + + 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. + + ]]> + + The assigned value is not one of the values. + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Converts the current alignment to the appropriate alignment to support right-to-left text. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Drawing.ContentAlignment + + + + + + One of the values. + 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. + + ]]> + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Windows.Forms.HorizontalAlignment + + + + + + One of the values. + 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. + + ]]> + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [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.Windows.Forms.LeftRightAlignment + + + + + + One of the values. + 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. + + ]]> + + + + + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.ContentAlignment + + + + + + One of the values. + 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. + + ]]> + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.HorizontalAlignment + + + + + + One of the values. + 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. + + ]]> + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.LeftRightAlignment + + + + + + One of the values. + 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. + + ]]> + + + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Scales the control and any child controls. + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + + [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.Void + + + + + + The ratio to use for scaling. + Scales the control and any child controls. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. http://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the Scale(SizeF ratio) method instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + + + System.Void + + + + + + + The horizontal scaling factor. + The vertical scaling factor. + Scales the entire control and any child controls. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The bitmap to scale. + Scales a logical bitmap value to it's equivalent device unit value when a DPI change occurs. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value that determines the scaling of child controls. + + 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. + + ]]> + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The factor by which the height and width of the control will be scaled. + 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. + + + + + + + + + + ]]> + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The horizontal scaling factor. + The vertical scaling factor. + This method is not relevant for this class. + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + 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 + + 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.Void + + + + 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"::: + + ]]> + + + + + + + + + + + + + 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 + + + + + + + + to specify the direction of the control to select; otherwise, . + + 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. + + + + + + + + + + + + + + + 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.Boolean + + + + + + + + + + The at which to start the search. + + to move forward in the tab order; to move backward in the tab order. + + to ignore the controls with the property set to ; otherwise, . + + to include nested (children of child controls) child controls; otherwise, . + + to continue searching from the first control in the tab order after the last control has been reached; otherwise, . + Activates the next control. + + 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 + + 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 + + + + 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. + + ]]> + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + One of the values. + Sets a value indicating how a control will behave when its property is enabled. + To be added. + + + + + System.Windows.Forms + 4.0.0.0 + + + Sets the bounds of the control. + + + + + + + + + + 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 new property value of the control. + The new property value of the control. + The new property value of the control. + The new property value of the control. + Sets the bounds of the control to the specified location and size. + To be added. + + + + + + + + + + + + + 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 new property value of the control. + The new property value of the control. + The new property value of the control. + The new property value of the control. + 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"::: + + ]]> + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + + + + The new property value of the control. + The new property value of the control. + The new property value of the control. + The new property value of the control. + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method to force the bounds of the control to change. Derived classes can add size restrictions to the method. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The client area width, in pixels. + 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"::: + + ]]> + + + 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). + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The bit to set. + + 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 + + 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 + + + + + + + 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`. + + ]]> + + The parameter is set to and the control is an ActiveX control. + The return value is not equal to the parameter and the property is not . + + + + + + + + + + + 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 + + + + + + + to make the control visible; otherwise, . + Sets the control to the specified visible state. + + + + + When overriding in a derived class, be sure to call the base class's method to force the visibility of the control to change. + + + + + + + + + + + + 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.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.Void + + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the control should display focus rectangles. + + if the control should display focus rectangles; otherwise, . + + + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. + + + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. + + if the keyboard accelerators are visible; otherwise, . + + + + + + + + + + + + + + + + Property + + P:System.ComponentModel.IComponent.Site + + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.ComponentModel.ISite + + + Gets or sets the site of the control. + The associated with the , if any. + To be added. + + + + + + + + + + + + Property + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Size + + + 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"::: + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Size + + + + + + A value representing the height and width of the control's client area. + Determines the size of the entire control from the height and width of its client area. + A value representing the height and width of the entire control. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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 + + + + 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 + + M:System.Windows.Forms.IDropTarget.OnDragDrop(System.Windows.Forms.DragEventArgs) + + + System.Windows.Forms + 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.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + M:System.Windows.Forms.IDropTarget.OnDragEnter(System.Windows.Forms.DragEventArgs) + + + System.Windows.Forms + 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.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + M:System.Windows.Forms.IDropTarget.OnDragLeave(System.EventArgs) + + + System.Windows.Forms + 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.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + M:System.Windows.Forms.IDropTarget.OnDragOver(System.Windows.Forms.DragEventArgs) + + + System.Windows.Forms + 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.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.MergableProperty(false)] + [<System.ComponentModel.MergableProperty(false)>] + + + + System.Int32 + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + [System.Runtime.InteropServices.DispId(-516)] + [<System.Runtime.InteropServices.DispId(-516)>] + + + [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 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 . + +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"::: + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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.Bindable(true)] + [<System.ComponentModel.Bindable(true)>] + + + [System.ComponentModel.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + [System.ComponentModel.Localizable(false)] + [<System.ComponentModel.Localizable(false)>] + + + [System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))>] + + + + System.Object + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + 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.Bindable(true)] + [<System.ComponentModel.Bindable(true)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.Runtime.InteropServices.DispId(-517)] + [<System.Runtime.InteropServices.DispId(-517)>] + + + + System.String + + + 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"::: + + ]]> + + + When overriding the property in a derived class, use the base class's property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the and accessors of the property; you can override only one if needed. + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + [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.Int32 + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.Control + + + 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`. + + ]]> + + + + + + + + + + + + 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 + + + + 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. + + ]]> + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Updates the bounds of the control. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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. + + ]]> + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + + + The coordinate of the control. + The coordinate of the control. + The of the control. + 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. + + ]]> + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + + + + + The coordinate of the control. + The coordinate of the control. + The of the control. + The of the control. + The client of the control. + 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. + + ]]> + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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. + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + [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 or sets a value indicating whether to use the wait cursor for the current control and all child controls. + + to use the wait cursor for the current control and all child controls; otherwise, . The default is . + + property. + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + 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.CancelEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value indicating whether the control and all its child controls are displayed. + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + [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.Int32 + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Windows.Forms.IWindowTarget + + + This property is not relevant for this class. + The NativeWindow contained within the control. + + + + + + + + + + + + + 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 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"::: + + ]]> + + + Inheriting controls should call the base class's method to process any messages that they do not handle. + + + + + + + diff --git a/xml/System.Windows.Forms/DialogResult.xml b/xml/System.Windows.Forms/DialogResult.xml index 921a389492e..1d2c320a010 100644 --- a/xml/System.Windows.Forms/DialogResult.xml +++ b/xml/System.Windows.Forms/DialogResult.xml @@ -1,282 +1,282 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Enum - - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - - 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"::: - - ]]> - - - - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 3 - - The dialog box return value is (usually sent from a button labeled Abort). - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 2 - - The dialog box return value is (usually sent from a button labeled Cancel). - - - - - - - - - - Field - - System.Windows.Forms - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 11 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 5 - - The dialog box return value is (usually sent from a button labeled Ignore). - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 7 - - The dialog box return value is (usually sent from a button labeled No). - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 0 - - - is returned from the dialog box. This means that the modal dialog continues running. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 1 - - The dialog box return value is (usually sent from a button labeled OK). - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 4 - - The dialog box return value is (usually sent from a button labeled Retry). - - - - - - - - - - Field - - System.Windows.Forms - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 10 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DialogResult - - 6 - - The dialog box return value is (usually sent from a button labeled Yes). - - - - + + + + + + + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Enum + + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + + 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"::: + + ]]> + + + + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 3 + + The dialog box return value is (usually sent from a button labeled Abort). + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 2 + + The dialog box return value is (usually sent from a button labeled Cancel). + + + + + + + + + + Field + + System.Windows.Forms + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 11 + + The dialog box return value is Continue (usually sent from a button labeled Continue). + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 5 + + The dialog box return value is (usually sent from a button labeled Ignore). + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 7 + + The dialog box return value is (usually sent from a button labeled No). + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 0 + + + is returned from the dialog box. This means that the modal dialog continues running. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 1 + + The dialog box return value is (usually sent from a button labeled OK). + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 4 + + The dialog box return value is (usually sent from a button labeled Retry). + + + + + + + + + + Field + + System.Windows.Forms + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 10 + + The dialog box return value is Try Again (usually sent from a button labeled Try Again). + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DialogResult + + 6 + + The dialog box return value is (usually sent from a button labeled Yes). + + + + diff --git a/xml/System.Windows.Forms/FolderBrowserDialog.xml b/xml/System.Windows.Forms/FolderBrowserDialog.xml index dc1ecfa6b6c..e02e399419e 100644 --- a/xml/System.Windows.Forms/FolderBrowserDialog.xml +++ b/xml/System.Windows.Forms/FolderBrowserDialog.xml @@ -1,610 +1,615 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.CommonDialog - - - - - [System.ComponentModel.DefaultEvent("HelpRequest")] - [<System.ComponentModel.DefaultEvent("HelpRequest")>] - - - [System.ComponentModel.DefaultProperty("SelectedPath")] - [<System.ComponentModel.DefaultProperty("SelectedPath")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] - - - - 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"::: - - ]]> - - - - - - - - - - - - - Constructor - - System.Windows.Forms - 1.0.5000.0 - 2.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 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"::: - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value that indicates whether the dialog will be automatically upgraded to enable new features. - - if the the dialog will be automatically upgraded to enable new features; otherwise, . The default value is . - To be added. - - - - - - - - - - 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.Localizable(false)] - [<System.ComponentModel.Localizable(false)>] - - - - System.Nullable<System.Guid> - - - To be added. - To be added. - To be added. - - - - - - - - - - Property - - 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(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue("")] - [<System.ComponentModel.DefaultValue("")>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [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.String - - - 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"::: - - ]]> - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.EventHandler - - - Occurs when the user clicks the **Help** button on the dialog box. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue("")] - [<System.ComponentModel.DefaultValue("")>] - - - [System.ComponentModel.Editor("System.Windows.Forms.Design.InitialDirectoryEditor, System.Windows.Forms.Design, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", typeof(System.Drawing.Design.UITypeEditor))] - [<System.ComponentModel.Editor("System.Windows.Forms.Design.InitialDirectoryEditor, System.Windows.Forms.Design, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", typeof(System.Drawing.Design.UITypeEditor))>] - - - - System.String - - - To be added. - To be added. - To be added. - - - - - - - - - - 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 - - - - Resets properties to their default values. - - , , and properties to their default values. For a list of default values, see the constructor. - - ]]> - - - - - - - - - - - Property - - 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(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue(System.Environment+SpecialFolder.Desktop)] - [<System.ComponentModel.DefaultValue(System.Environment+SpecialFolder.Desktop)>] - - - [System.ComponentModel.Localizable(false)] - [<System.ComponentModel.Localizable(false)>] - - - [System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.SpecialFolderEnumConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.SpecialFolderEnumConverter))>] - - - [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.Environment+SpecialFolder - - - 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"::: - - ]]> - - The value assigned is not one of the values. - - - - - - - - - - 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.Boolean - - - - - - A handle to the window that owns the folder browser dialog. - Displays a folder browser dialog box. - - if the folder browser dialog was successfully run; otherwise, . - To be added. - - - - - - - - - - Property - - 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(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue("")] - [<System.ComponentModel.DefaultValue("")>] - - - [System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))] - [<System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))] - [<System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))>] - - - [System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))] - [<System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))>] - - - - System.String - - - 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 - - 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(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - [System.ComponentModel.Localizable(false)] - [<System.ComponentModel.Localizable(false)>] - - - [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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value indicating whether the **New Folder** button appears in the folder browser dialog box. - - 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"::: - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.Description("FolderBrowserDialogUseDescriptionForTitle")] - [<System.ComponentModel.Description("FolderBrowserDialogUseDescriptionForTitle")>] - - - - System.Boolean - - - Gets or sets a value that indicates whether to use the value of the property as the dialog title for Vista style dialogs. This property has no effect on old style dialogs. - - if the value of the property is used as the dialog title; if the value is added as additional text to the dialog. The default is . - 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.Windows.Forms.CommonDialog + + + + + [System.ComponentModel.DefaultEvent("HelpRequest")] + [<System.ComponentModel.DefaultEvent("HelpRequest")>] + + + [System.ComponentModel.DefaultProperty("SelectedPath")] + [<System.ComponentModel.DefaultProperty("SelectedPath")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.FolderBrowserDialogDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>] + + + + 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"::: + + ]]> + + + + + + + + + + + + + Constructor + + System.Windows.Forms + 1.0.5000.0 + 2.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 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"::: + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value that indicates whether the dialog will be automatically upgraded to enable new features. + + if the the dialog will be automatically upgraded to enable new features; otherwise, . The default value is . + To be added. + + + + + + + + + + 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.Localizable(false)] + [<System.ComponentModel.Localizable(false)>] + + + + System.Nullable<System.Guid> + + + + 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. + + + + + + + + + + Property + + 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(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue("")] + [<System.ComponentModel.DefaultValue("")>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [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.String + + + 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"::: + + ]]> + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.EventHandler + + + Occurs when the user clicks the **Help** button on the dialog box. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue("")] + [<System.ComponentModel.DefaultValue("")>] + + + [System.ComponentModel.Editor("System.Windows.Forms.Design.InitialDirectoryEditor, System.Windows.Forms.Design, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", typeof(System.Drawing.Design.UITypeEditor))] + [<System.ComponentModel.Editor("System.Windows.Forms.Design.InitialDirectoryEditor, System.Windows.Forms.Design, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", typeof(System.Drawing.Design.UITypeEditor))>] + + + + System.String + + + Gets or sets the initial directory displayed by the folder browser dialog. + To be added. + To be added. + + + + + + + + + + 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 + + + + Resets properties to their default values. + + , , and properties to their default values. For a list of default values, see the constructor. + + ]]> + + + + + + + + + + + Property + + 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(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue(System.Environment+SpecialFolder.Desktop)] + [<System.ComponentModel.DefaultValue(System.Environment+SpecialFolder.Desktop)>] + + + [System.ComponentModel.Localizable(false)] + [<System.ComponentModel.Localizable(false)>] + + + [System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.SpecialFolderEnumConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.SpecialFolderEnumConverter))>] + + + [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.Environment+SpecialFolder + + + 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"::: + + ]]> + + The value assigned is not one of the values. + + + + + + + + + + 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.Boolean + + + + + + A handle to the window that owns the folder browser dialog. + Displays a folder browser dialog box. + + if the folder browser dialog was successfully run; otherwise, . + To be added. + + + + + + + + + + Property + + 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(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue("")] + [<System.ComponentModel.DefaultValue("")>] + + + [System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))] + [<System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))] + [<System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))>] + + + [System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))] + [<System.ComponentModel.Editor("System.Windows.Forms.Design.SelectedPathEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.Drawing.Design.UITypeEditor))>] + + + + System.String + + + 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 + + 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(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + [System.ComponentModel.Localizable(false)] + [<System.ComponentModel.Localizable(false)>] + + + [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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value indicating whether the **New Folder** button appears in the folder browser dialog box. + + 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"::: + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.Description("FolderBrowserDialogUseDescriptionForTitle")] + [<System.ComponentModel.Description("FolderBrowserDialogUseDescriptionForTitle")>] + + + + System.Boolean + + + Gets or sets a value that indicates whether to use the value of the property as the dialog title for Vista style dialogs. This property has no effect on old style dialogs. + + if the value of the property is used as the dialog title; if the value is added as additional text to the dialog. The default is . + To be added. + + + + diff --git a/xml/System.Windows.Forms/Form.xml b/xml/System.Windows.Forms/Form.xml index b38a631ad84..e466fe2a751 100644 --- a/xml/System.Windows.Forms/Form.xml +++ b/xml/System.Windows.Forms/Form.xml @@ -1,7551 +1,7560 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.ContainerControl - - - - - [System.ComponentModel.DefaultEvent("Load")] - [<System.ComponentModel.DefaultEvent("Load")>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))>] - - - [System.ComponentModel.DesignerCategory("Form")] - [<System.ComponentModel.DesignerCategory("Form")>] - - - [System.ComponentModel.DesignTimeVisible(false)] - [<System.ComponentModel.DesignTimeVisible(false)>] - - - [System.ComponentModel.InitializationEvent("Load")] - [<System.ComponentModel.InitializationEvent("Load")>] - - - [System.ComponentModel.ToolboxItem(false)] - [<System.ComponentModel.ToolboxItem(false)>] - - - [System.ComponentModel.ToolboxItemFilter("System.Windows.Forms.Control.TopLevel")] - [<System.ComponentModel.ToolboxItemFilter("System.Windows.Forms.Control.TopLevel")>] - - - [System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)] - [<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>] - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))>] - - - [System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))] - [<System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))>] - - - - 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"::: - - ]]> - - Multiple-Document Interface (MDI) Applications - - - - - - - - - Constructor - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - 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"::: - - ]]> - - - - - - - - - - - Property - - 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.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - - System.Windows.Forms.IButtonControl - - - 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"::: - - ]]> - - - - - - - - - - - - - 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 - - - - 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"::: - - ]]> - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - 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 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. - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.Form - - - 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 - - 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.Windows.Forms.Form - - - 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"::: - - ]]> - - - - - - - - - - - - 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 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - to show the scroll bars; otherwise, . - Adjusts the scroll bars on the container based on the current control positions and the control currently selected. - To be added. - - - - - - - - - - Property - - 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.Boolean - - - Gets or sets a value indicating whether the opacity of the form can be adjusted. - - 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. - - ]]> - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. http://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - 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 - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. http://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.ComponentModel.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the form adjusts its size to fit the height of the font used on the form and scales its controls. - - 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. - - ]]> - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Drawing.Size - - - 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. - - ]]> - - - - - - - - - - - - - Property - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the form enables autoscrolling. - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Boolean - - - Resize the form according to the setting of . - - 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"::: - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.EventHandler - - - Occurs when the property changes. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DefaultValue(System.Windows.Forms.AutoSizeMode.GrowOnly)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.AutoSizeMode.GrowOnly)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Windows.Forms.AutoSizeMode - - - 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"::: - - ]]> - - The value is not a valid value. - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Windows.Forms.AutoValidate - - - Gets or sets a value that indicates whether controls in this container will be automatically validated when the focus changes. - An enumerated value that indicates whether contained controls are implicitly validated on focus change. The default is Inherit. - To be added. - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.EventHandler - - - Occurs when the property changes. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Color - - - 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. - To be added. - - - - - - - - - - - Property - - 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.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - - System.Windows.Forms.IButtonControl - - - 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"::: - - ]]> - - - - - - - - - - - - - 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 - - - - 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 - - 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 - - - - 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 - - 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.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Size - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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 - - - - 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. - - ]]> - - The form was closed while a handle was being created. - You cannot call this method from the event when is set to . - - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.ComponentModel.CancelEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether a control box is displayed in the caption bar of the form. - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.AccessibleObject - - - - Creates a new accessibility object for the control. - A new accessible object for the control. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Windows.Forms.Control+ControlCollection - - - - Creates a new instance of the control collection for the control. - A new instance of assigned to the control. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - Creates the handle for the form. If a derived class overrides this function, it must call the base implementation. - To be added. - A handle for this has already been created. - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.CreateParams - - - 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. - To be added. - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.ImeMode - - - 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. - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Size - - - Gets the default size of the control. - The default of the control. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - The Windows to process. - Sends the specified message to the default window procedure. - To be added. - - - - - - - - - - - Property - - 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.Drawing.Rectangle - - - 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. - - - - - - - - - - - - - - Property - - 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.Drawing.Point - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - 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)>] - - - [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.Forms.DialogResult - - - 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"::: - - ]]> - - The value specified is outside the range of valid values. - - - - - - - - - - - - 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 - - - - - - - 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. - - ]]> - - - - 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)). - - - - - - - - - - - Event - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.DpiChangedEventHandler - - - Occurs when the DPI setting changes on the display device where the form is currently displayed. - To be added. - - - - - - - - - - Property - - 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.DefaultValue(System.Windows.Forms.FormBorderStyle.Sizable)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.FormBorderStyle.Sizable)>] - - - [System.Runtime.InteropServices.DispId(-504)] - [<System.Runtime.InteropServices.DispId(-504)>] - - - - System.Windows.Forms.FormBorderStyle - - - 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"::: - - ]]> - - The value specified is outside the range of valid values. - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.FormClosedEventHandler - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.FormClosingEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. http://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. https://go.microsoft.com/fwlink/?linkid=14202")] - [<System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.SizeF - - - - - - A representing the font to determine the autoscaled base size of the form. - 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. - - ]]> - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Drawing.Rectangle - - - - - - - - A that specifies the area for which to retrieve the display bounds. - The height and width of the control's bounds. - One of the values of that specifies the bounds of the control to use when defining its size and position. - Retrieves the bounds within which the control is scaled. - A representing the bounds within which the control is scaled. - To be added. - - - - - - - - - - - Property - - 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.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - - System.Boolean - - - Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form. - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.ComponentModel.CancelEventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Property - - 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.AmbientValue(null)] - [<System.ComponentModel.AmbientValue(null)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Drawing.Icon - - - 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. - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.InputLanguageChangedEventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.InputLanguageChangingEventHandler - - - 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 - - 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.Boolean - - - Gets a value indicating whether the form is a multiple-document interface (MDI) child form. - - 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. - - ]]> - - - - - - - - - - - - - - Property - - 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.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the form is a container for multiple-document interface (MDI) child forms. - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets a value indicating whether the form can use all windows and user input events without restriction. - - 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 - - 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.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus. - - 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"::: - - ]]> - - - - - - - - - - - - - - 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 - - - - - - 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"::: - - ]]> - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.SettingsBindable(true)] - [<System.ComponentModel.SettingsBindable(true)>] - - - - System.Drawing.Point - - - 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`. - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - [System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))>] - - - - System.Windows.Forms.MenuStrip - - - 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 - - System.Windows.Forms - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Windows.Forms.Padding - - - Gets or sets the space between controls. - A value that represents the space between controls. - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.EventHandler - - - Occurs when the property changes. - To be added. - - - - - - - - - - Property - - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the **Maximize** button is displayed in the caption bar of the form. - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Rectangle - - - 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 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. - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - Property - - 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.DefaultValue(typeof(System.Drawing.Size), "0, 0")] - [<System.ComponentModel.DefaultValue(typeof(System.Drawing.Size), "0, 0")>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] - [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] - - - - System.Drawing.Size - - - 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"::: - - ]]> - - The values of the height or width within the object are less than zero. - - - - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - 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.Windows.Forms.Form[] - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - System.Windows.Forms - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - - - - Property - - 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)>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Forms.Form - - - 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"::: - - ]]> - - 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. - - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - [System.ComponentModel.DefaultValue(null)] - [<System.ComponentModel.DefaultValue(null)>] - - - [System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))>] - - - - System.Windows.Forms.MainMenu - - - 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"::: - - ]]> - - - - - - - - - - - - - - Event - - 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.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Event - - 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.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.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)>] - - - [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.Forms.MainMenu - - - Gets the merged menu for the form. - A that represents the merged menu of the form. - - assigned to a form, use the property. - - ]]> - - - - - - - - - - - - - - Property - - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the **Minimize** button is displayed in the caption bar of the form. - - 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 - - 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.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] - [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] - - - [System.ComponentModel.DefaultValue(typeof(System.Drawing.Size), "0, 0")] - [<System.ComponentModel.DefaultValue(typeof(System.Drawing.Size), "0, 0")>] - - - - System.Drawing.Size - - - 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. - - ]]> - - The values of the height or width within the object are less than zero. - - - - - - - - - - Event - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Property - - 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.Boolean - - - Gets a value indicating whether this form is displayed modally. - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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"::: - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - Raises the event. - - - - - When overriding in a derived class, be sure to call the base class's method. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - - - - - - The DPI value for the display device where the form was previously displayed. - The DPI value for the display device where the form will be displayed. - A representing the new size of the form based on the new DPI value. - Raises the GetDpiScaledSize event. - - if successful; otherwise . - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The event data. - Raises the event. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - 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. - - ]]> - - - When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. - - - - - - - - - - - - - - Property - - 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.DefaultValue(1)] - [<System.ComponentModel.DefaultValue(1)>] - - - [System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.OpacityConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.OpacityConverter))>] - - - - System.Double - - - 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 - - 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.Windows.Forms.Form[] - - - 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"::: - - ]]> - - - - - - - - - - - - - - Property - - 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.Windows.Forms.Form - - - 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. - - ]]> - - A top-level window cannot have an owner. - - - - - - - - - - - - - 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.Boolean - - - - - - - A , passed by reference, that represents the Win32 message to process. - One of the values that represents the key to process. - Processes a command key. - - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - - - - The character to process. - Processes a dialog character. - - if the character was processed by the control; otherwise, . - To be added. - - - - - - - - - - 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.Boolean - - - - - - One of the values that represents the key to process. - Processes a dialog box key. - - 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 - - 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 - - - - - - A , passed by reference, that represents the window message to process. - Previews a keyboard message. - - if the message was processed by the control; otherwise, . - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The character to process. - Processes a mnemonic character. - - if the character was processed as a mnemonic by the control; otherwise, . - To be added. - - - - - - - - - - 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.Boolean - - - - - - - to cycle forward through the controls in the ContainerControl; otherwise, . - Selects the next available control and makes it the active control. - - if a control is selected; otherwise, . - To be added. - - - - - - - - - - - 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 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`. - - ]]> - - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.Drawing.Rectangle - - - 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 - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - [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 or sets a value indicating whether right-to-left mirror placement is turned on. - - 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). - - ]]> - - - - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - The factor by which the height and width of the control are scaled. - A value that specifies the bounds of the control to use when defining its size and position. - Scales the location, size, padding, and margin of a control. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - Percentage to scale the form horizontally. - Percentage to scale the form vertically. - Performs scaling of the form. - To be added. - - - - - - - - - - - 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 - - - - - - - If set to true that the active control is changed. - If directed is true, then this controls the direction in which focus is moved. If this is , then the next control is selected; otherwise, the previous control is selected. - Selects this form, and optionally selects the next or previous control. - To be added. - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - - - - The new property value of the control. - The new property value of the control. - The new property value of the control. - The new property value of the control. - A bitwise combination of the values. - Performs the work of setting the specified bounds of this control. - To be added. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - Requested width of the client region. - Requested height of the client region. - Sets the client size of the form. This will adjust the bounds of the form to make the client size the requested size. - To be added. - - - - - - - - - - - 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 x-coordinate of the form's location. - The y-coordinate of the form's location. - The width of the form. - 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 - - 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 x-coordinate of the form's location. - 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 - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - - to make the control visible; otherwise, . - Sets the control to the specified visible state. - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - 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 ). - - - - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Shows the form as a modal dialog box. - - - - - - - - - - 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.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.Windows.Forms.DialogResult - - - - 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"::: - - ]]> - - 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 ). - - - - - - - - - - - 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.Windows.Forms.DialogResult - - - - - - Any object that implements that represents the top-level window that will own the modal dialog box. - 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"::: - - ]]> - - 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 current process is not running in user interactive mode (for more information, see ). - - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether an icon is displayed in the caption bar of the form. - - 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 - - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the form is displayed in the Windows taskbar. - - 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"::: - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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"::: - - ]]> - - - - - - - - - - - - - - - - - - - - - - Property - - System.Windows.Forms - 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.Boolean - - - Gets a value indicating whether the window will be activated when it is shown. - - 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. - - ]]> - - - - - - - - - - - - Property - - 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.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] - [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] - - - [System.ComponentModel.Localizable(false)] - [<System.ComponentModel.Localizable(false)>] - - - - System.Drawing.Size - - - 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"::: - - ]]> - - - - - - - - - - - - - - - Property - - 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.DefaultValue(System.Windows.Forms.SizeGripStyle.Auto)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.SizeGripStyle.Auto)>] - - - - System.Windows.Forms.SizeGripStyle - - - 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"::: - - ]]> - - The value specified is outside the range of valid values. - - - - - - - - - - - - Property - - 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.DefaultValue(System.Windows.Forms.FormStartPosition.WindowsDefaultLocation)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.FormStartPosition.WindowsDefaultLocation)>] - - - [System.ComponentModel.Localizable(true)] - [<System.ComponentModel.Localizable(true)>] - - - - System.Windows.Forms.FormStartPosition - - - 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"::: - - ]]> - - The value specified is outside the range of valid values. - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Int32 - - - 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. - - ]]> - - - - - - - - - - - Event - - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.EventHandler - - - Occurs when the value of the property changes. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 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.DefaultValue(true)] - [<System.ComponentModel.DefaultValue(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Runtime.InteropServices.DispId(-516)] - [<System.Runtime.InteropServices.DispId(-516)>] - - - - System.Boolean - - - 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 . - To be added. - - - - - - - - - - Event - - System.Windows.Forms - 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.EventHandler - - - Occurs when the property changes. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.SettingsBindable(true)] - [<System.ComponentModel.SettingsBindable(true)>] - - - - System.String - - - Gets or sets the text associated with this control. - The text associated with this control. - To be added. - - - - - - - - - - - Property - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Boolean - - - Gets or sets a value indicating whether to display the form as a top-level window. - - 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"::: - - ]]> - - A Multiple-document interface (MDI) parent form must be a top-level window. - - - - - - - - - - - Property - - 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.DefaultValue(false)] - [<System.ComponentModel.DefaultValue(false)>] - - - - System.Boolean - - - Gets or sets a value indicating whether the form should be displayed as a topmost form. - - 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"::: - - ]]> - - - - - - - - - - - - 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.String - - - - Gets a string representing the current instance of the form. - A string consisting of the fully qualified name of the form object's class, with the property of the form appended to the end. For example, if the form is derived from the class MyForm in the MyNamespace namespace, and the property is set to Hello, World, this method will return MyNamespace.MyForm, Text: Hello, World. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Drawing.Color - - - 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"::: - - ]]> - - - - - - - - - - - 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 - - - - 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. - - ]]> - - - - - - - - System.Windows.Forms - 4.0.0.0 - - - Validates all selectable child controls in the form. - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Boolean - - - - Causes all of the child controls within a control that support validation to validate their data. - - if all of the children validated successfully; otherwise, . If called from the or event handlers, this method will always return . - To be added. - - - - - - - - - - - Method - - System.Windows.Forms - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(true)] - [<System.ComponentModel.Browsable(true)>] - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] - - - - System.Boolean - - - - - - Places restrictions on which controls have their event raised. - Causes all of the child controls within a control that support validation to validate their data. - - if all of the children validated successfully; otherwise, . If called from the or event handlers, this method will always return . - To be added. - - - - - - - - - - - Property - - 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.DefaultValue(System.Windows.Forms.FormWindowState.Normal)] - [<System.ComponentModel.DefaultValue(System.Windows.Forms.FormWindowState.Normal)>] - - - - System.Windows.Forms.FormWindowState - - - 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 -``` - - ]]> - - The value specified is outside the range of valid values. - - - - - - - - - - - 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] - - - - System.Void - - - - - - The Windows to process. - Processes Windows messages. - 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.Windows.Forms.ContainerControl + + + + + [System.ComponentModel.DefaultEvent("Load")] + [<System.ComponentModel.DefaultEvent("Load")>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))>] + + + [System.ComponentModel.DesignerCategory("Form")] + [<System.ComponentModel.DesignerCategory("Form")>] + + + [System.ComponentModel.DesignTimeVisible(false)] + [<System.ComponentModel.DesignTimeVisible(false)>] + + + [System.ComponentModel.InitializationEvent("Load")] + [<System.ComponentModel.InitializationEvent("Load")>] + + + [System.ComponentModel.ToolboxItem(false)] + [<System.ComponentModel.ToolboxItem(false)>] + + + [System.ComponentModel.ToolboxItemFilter("System.Windows.Forms.Control.TopLevel")] + [<System.ComponentModel.ToolboxItemFilter("System.Windows.Forms.Control.TopLevel")>] + + + [System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)] + [<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>] + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))>] + + + [System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))] + [<System.ComponentModel.Designer("System.Windows.Forms.Design.FormDocumentDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(System.ComponentModel.Design.IRootDesigner))>] + + + + 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"::: + + ]]> + + Multiple-Document Interface (MDI) Applications + + + + + + + + + Constructor + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + 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"::: + + ]]> + + + + + + + + + + + Property + + 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.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + + System.Windows.Forms.IButtonControl + + + 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"::: + + ]]> + + + + + + + + + + + + + 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 + + + + 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"::: + + ]]> + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + 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 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. + + ]]> + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.Form + + + 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 + + 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.Windows.Forms.Form + + + 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"::: + + ]]> + + + + + + + + + + + + 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 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + to show the scroll bars; otherwise, . + Adjusts the scroll bars on the container based on the current control positions and the control currently selected. + To be added. + + + + + + + + + + Property + + 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.Boolean + + + Gets or sets a value indicating whether the opacity of the form can be adjusted. + + 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. + + ]]> + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. http://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. http://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. https://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the ApplyAutoScaling method instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + 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 + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. http://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. https://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This property has been deprecated. Use the AutoScaleMode property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.ComponentModel.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the form adjusts its size to fit the height of the font used on the form and scales its controls. + + 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. + + ]]> + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Drawing.Size + + + 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. + + ]]> + + + + + + + + + + + + + Property + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the form enables autoscrolling. + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Boolean + + + Resize the form according to the setting of . + + 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"::: + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.EventHandler + + + Occurs when the property changes. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DefaultValue(System.Windows.Forms.AutoSizeMode.GrowOnly)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.AutoSizeMode.GrowOnly)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Windows.Forms.AutoSizeMode + + + 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"::: + + ]]> + + The value is not a valid value. + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Windows.Forms.AutoValidate + + + Gets or sets a value that indicates whether controls in this container will be automatically validated when the focus changes. + An enumerated value that indicates whether contained controls are implicitly validated on focus change. The default is Inherit. + To be added. + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.EventHandler + + + Occurs when the property changes. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Color + + + 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. + To be added. + + + + + + + + + + + Property + + 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.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + + System.Windows.Forms.IButtonControl + + + 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"::: + + ]]> + + + + + + + + + + + + + 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 + + + + 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 + + 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 + + + + 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 + + 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.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Size + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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 + + + + 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. + + ]]> + + The form was closed while a handle was being created. + You cannot call this method from the event when is set to . + + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.ComponentModel.CancelEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether a control box is displayed in the caption bar of the form. + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.AccessibleObject + + + + Creates a new accessibility object for the control. + A new accessible object for the control. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Windows.Forms.Control+ControlCollection + + + + Creates a new instance of the control collection for the control. + A new instance of assigned to the control. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + Creates the handle for the form. If a derived class overrides this function, it must call the base implementation. + To be added. + A handle for this has already been created. + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.CreateParams + + + 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. + To be added. + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.ImeMode + + + 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. + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Size + + + Gets the default size of the control. + The default of the control. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + The Windows to process. + Sends the specified message to the default window procedure. + To be added. + + + + + + + + + + + Property + + 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.Drawing.Rectangle + + + 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. + + + + + + + + + + + + + + Property + + 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.Drawing.Point + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + 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)>] + + + [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.Forms.DialogResult + + + 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"::: + + ]]> + + The value specified is outside the range of valid values. + + + + + + + + + + + + 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 + + + + + + + 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. + + ]]> + + + + 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)). + + + + + + + + + + + Event + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.DpiChangedEventHandler + + + Occurs when the DPI setting changes on the display device where the form is currently displayed. + To be added. + + + + + + + + + + Property + + 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.DefaultValue(System.Windows.Forms.FormBorderStyle.Sizable)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.FormBorderStyle.Sizable)>] + + + [System.Runtime.InteropServices.DispId(-504)] + [<System.Runtime.InteropServices.DispId(-504)>] + + + + System.Windows.Forms.FormBorderStyle + + + 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"::: + + ]]> + + The value specified is outside the range of valid values. + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.FormClosedEventHandler + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.FormClosingEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. http://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. http://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. https://go.microsoft.com/fwlink/?linkid=14202")] + [<System.Obsolete("This method has been deprecated. Use the AutoScaleDimensions property instead. https://go.microsoft.com/fwlink/?linkid=14202")>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.SizeF + + + + + + A representing the font to determine the autoscaled base size of the form. + 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. + + ]]> + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Drawing.Rectangle + + + + + + + + A that specifies the area for which to retrieve the display bounds. + The height and width of the control's bounds. + One of the values of that specifies the bounds of the control to use when defining its size and position. + Retrieves the bounds within which the control is scaled. + A representing the bounds within which the control is scaled. + To be added. + + + + + + + + + + + Property + + 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.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + + System.Boolean + + + Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form. + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.ComponentModel.CancelEventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Property + + 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.AmbientValue(null)] + [<System.ComponentModel.AmbientValue(null)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Drawing.Icon + + + 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. + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.InputLanguageChangedEventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.InputLanguageChangingEventHandler + + + 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 + + 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.Boolean + + + Gets a value indicating whether the form is a multiple-document interface (MDI) child form. + + 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. + + ]]> + + + + + + + + + + + + + + Property + + 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.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the form is a container for multiple-document interface (MDI) child forms. + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets a value indicating whether the form can use all windows and user input events without restriction. + + 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 + + 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.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus. + + 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"::: + + ]]> + + + + + + + + + + + + + + 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 + + + + + + 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"::: + + ]]> + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.SettingsBindable(true)] + [<System.ComponentModel.SettingsBindable(true)>] + + + + System.Drawing.Point + + + 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`. + + ]]> + + + + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + [System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))>] + + + + System.Windows.Forms.MenuStrip + + + 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 + + System.Windows.Forms + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Windows.Forms.Padding + + + Gets or sets the space between controls. + A value that represents the space between controls. + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.EventHandler + + + Occurs when the property changes. + To be added. + + + + + + + + + + Property + + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the **Maximize** button is displayed in the caption bar of the form. + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Rectangle + + + 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 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. + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + Property + + 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.DefaultValue(typeof(System.Drawing.Size), "0, 0")] + [<System.ComponentModel.DefaultValue(typeof(System.Drawing.Size), "0, 0")>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] + [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] + + + + System.Drawing.Size + + + 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"::: + + ]]> + + The values of the height or width within the object are less than zero. + + + + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + 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.Windows.Forms.Form[] + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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. + + + + + + + + + + + + + Property + + 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)>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Forms.Form + + + 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"::: + + ]]> + + 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. + + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + [System.ComponentModel.DefaultValue(null)] + [<System.ComponentModel.DefaultValue(null)>] + + + [System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ReferenceConverter))>] + + + + System.Windows.Forms.MainMenu + + + 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"::: + + ]]> + + + + + + + + + + + + + + Event + + 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.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Event + + 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.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.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)>] + + + [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.Forms.MainMenu + + + Gets the merged menu for the form. + A that represents the merged menu of the form. + + assigned to a form, use the property. + + ]]> + + + + + + + + + + + + + + Property + + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the **Minimize** button is displayed in the caption bar of the form. + + 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 + + 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.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)] + [<System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)>] + + + [System.ComponentModel.DefaultValue(typeof(System.Drawing.Size), "0, 0")] + [<System.ComponentModel.DefaultValue(typeof(System.Drawing.Size), "0, 0")>] + + + + System.Drawing.Size + + + 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. + + ]]> + + The values of the height or width within the object are less than zero. + + + + + + + + + + Event + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Property + + 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.Boolean + + + Gets a value indicating whether this form is displayed modally. + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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"::: + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + Raises the event. + + + + + When overriding in a derived class, be sure to call the base class's method. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Visible)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + + + + + + The DPI value for the display device where the form was previously displayed. + The DPI value for the display device where the form will be displayed. + A representing the new size of the form based on the new DPI value. + Raises the GetDpiScaledSize event. + + if successful; otherwise . + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The event data. + Raises the event. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + 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. + + ]]> + + + When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. + + + + + + + + + + + + + + Property + + 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.DefaultValue(1)] + [<System.ComponentModel.DefaultValue(1)>] + + + [System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.OpacityConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.OpacityConverter))>] + + + + System.Double + + + 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 + + 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.Windows.Forms.Form[] + + + 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"::: + + ]]> + + + + + + + + + + + + + + Property + + 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.Windows.Forms.Form + + + 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. + + ]]> + + A top-level window cannot have an owner. + + + + + + + + + + + + + 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.Boolean + + + + + + + A , passed by reference, that represents the Win32 message to process. + One of the values that represents the key to process. + Processes a command key. + + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + + + + The character to process. + Processes a dialog character. + + if the character was processed by the control; otherwise, . + To be added. + + + + + + + + + + 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.Boolean + + + + + + One of the values that represents the key to process. + Processes a dialog box key. + + 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 + + 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 + + + + + + A , passed by reference, that represents the window message to process. + Previews a keyboard message. + + if the message was processed by the control; otherwise, . + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The character to process. + Processes a mnemonic character. + + if the character was processed as a mnemonic by the control; otherwise, . + To be added. + + + + + + + + + + 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.Boolean + + + + + + + to cycle forward through the controls in the ContainerControl; otherwise, . + Selects the next available control and makes it the active control. + + if a control is selected; otherwise, . + To be added. + + + + + + + + + + + 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 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`. + + ]]> + + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.Drawing.Rectangle + + + 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 + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + [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 or sets a value indicating whether right-to-left mirror placement is turned on. + + 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). + + ]]> + + + + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + The factor by which the height and width of the control are scaled. + A value that specifies the bounds of the control to use when defining its size and position. + Scales the location, size, padding, and margin of a control. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + Percentage to scale the form horizontally. + Percentage to scale the form vertically. + Performs scaling of the form. + To be added. + + + + + + + + + + + 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 + + + + + + + If set to true that the active control is changed. + If directed is true, then this controls the direction in which focus is moved. If this is , then the next control is selected; otherwise, the previous control is selected. + Selects this form, and optionally selects the next or previous control. + To be added. + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + + + + The new property value of the control. + The new property value of the control. + The new property value of the control. + The new property value of the control. + A bitwise combination of the values. + Performs the work of setting the specified bounds of this control. + To be added. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + Requested width of the client region. + Requested height of the client region. + Sets the client size of the form. This will adjust the bounds of the form to make the client size the requested size. + To be added. + + + + + + + + + + + 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 x-coordinate of the form's location. + The y-coordinate of the form's location. + The width of the form. + 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 + + 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 x-coordinate of the form's location. + 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 + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + + to make the control visible; otherwise, . + Sets the control to the specified visible state. + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + 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 ). + + + + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Shows the form as a modal dialog box. + + + + + + + + + + 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.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.Windows.Forms.DialogResult + + + + 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"::: + + ]]> + + 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 ). + + + + + + + + + + + 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.Windows.Forms.DialogResult + + + + + + Any object that implements that represents the top-level window that will own the modal dialog box. + 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"::: + + ]]> + + 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 current process is not running in user interactive mode (for more information, see ). + + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether an icon is displayed in the caption bar of the form. + + 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 + + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the form is displayed in the Windows taskbar. + + 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"::: + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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"::: + + ]]> + + + + + + + + + + + + + + + + + + + + + + Property + + System.Windows.Forms + 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.Boolean + + + Gets a value indicating whether the window will be activated when it is shown. + + 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. + + ]]> + + + + + + + + + + + + Property + + 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.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)] + [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>] + + + [System.ComponentModel.Localizable(false)] + [<System.ComponentModel.Localizable(false)>] + + + + System.Drawing.Size + + + 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"::: + + ]]> + + + + + + + + + + + + + + + Property + + 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.DefaultValue(System.Windows.Forms.SizeGripStyle.Auto)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.SizeGripStyle.Auto)>] + + + + System.Windows.Forms.SizeGripStyle + + + 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"::: + + ]]> + + The value specified is outside the range of valid values. + + + + + + + + + + + + Property + + 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.DefaultValue(System.Windows.Forms.FormStartPosition.WindowsDefaultLocation)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.FormStartPosition.WindowsDefaultLocation)>] + + + [System.ComponentModel.Localizable(true)] + [<System.ComponentModel.Localizable(true)>] + + + + System.Windows.Forms.FormStartPosition + + + 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"::: + + ]]> + + The value specified is outside the range of valid values. + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Int32 + + + 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. + + ]]> + + + + + + + + + + + Event + + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.EventHandler + + + Occurs when the value of the property changes. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 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.DefaultValue(true)] + [<System.ComponentModel.DefaultValue(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Runtime.InteropServices.DispId(-516)] + [<System.Runtime.InteropServices.DispId(-516)>] + + + + System.Boolean + + + 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 . + To be added. + + + + + + + + + + Event + + System.Windows.Forms + 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.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.EventHandler + + + Occurs when the property changes. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.SettingsBindable(true)] + [<System.ComponentModel.SettingsBindable(true)>] + + + + System.String + + + Gets or sets the text associated with this control. + The text associated with this control. + To be added. + + + + + + + + + + + Property + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Boolean + + + Gets or sets a value indicating whether to display the form as a top-level window. + + 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"::: + + ]]> + + A Multiple-document interface (MDI) parent form must be a top-level window. + + + + + + + + + + + Property + + 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.DefaultValue(false)] + [<System.ComponentModel.DefaultValue(false)>] + + + + System.Boolean + + + Gets or sets a value indicating whether the form should be displayed as a topmost form. + + 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"::: + + ]]> + + + + + + + + + + + + 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.String + + + + Gets a string representing the current instance of the form. + A string consisting of the fully qualified name of the form object's class, with the property of the form appended to the end. For example, if the form is derived from the class MyForm in the MyNamespace namespace, and the property is set to Hello, World, this method will return MyNamespace.MyForm, Text: Hello, World. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Drawing.Color + + + 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"::: + + ]]> + + + + + + + + + + + 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 + + + + 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. + + ]]> + + + + + + + + System.Windows.Forms + 4.0.0.0 + + + Validates all selectable child controls in the form. + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Boolean + + + + Causes all of the child controls within a control that support validation to validate their data. + + if all of the children validated successfully; otherwise, . If called from the or event handlers, this method will always return . + To be added. + + + + + + + + + + + Method + + System.Windows.Forms + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(true)] + [<System.ComponentModel.Browsable(true)>] + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)>] + + + + System.Boolean + + + + + + Places restrictions on which controls have their event raised. + Causes all of the child controls within a control that support validation to validate their data. + + if all of the children validated successfully; otherwise, . If called from the or event handlers, this method will always return . + To be added. + + + + + + + + + + + Property + + 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.DefaultValue(System.Windows.Forms.FormWindowState.Normal)] + [<System.ComponentModel.DefaultValue(System.Windows.Forms.FormWindowState.Normal)>] + + + + System.Windows.Forms.FormWindowState + + + 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 +``` + + ]]> + + The value specified is outside the range of valid values. + + + + + + + + + + + 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.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>] + + + + System.Void + + + + + + The Windows to process. + Processes Windows messages. + To be added. + + + + + diff --git a/xml/System.Windows.Forms/LinkClickedEventArgs.xml b/xml/System.Windows.Forms/LinkClickedEventArgs.xml index 2d11b61e44e..af1d7c4a85a 100644 --- a/xml/System.Windows.Forms/LinkClickedEventArgs.xml +++ b/xml/System.Windows.Forms/LinkClickedEventArgs.xml @@ -1,206 +1,212 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventArgs - - - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - - 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"::: - - ]]> - - - - - - - - - - - - - - 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 text of the link that is clicked in the control. - Initializes a new instance of the class. - - - - - - - - - - - - - Constructor - - System.Windows.Forms - 6.0.0.0 - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 6.0.0.0 - - - System.Int32 - - - To be added. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 6.0.0.0 - - - System.Int32 - - - To be added. - To be added. - To be added. - - - - - - - - - - - Property - - System.Windows.Forms - 1.0.5000.0 - 2.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.String - - - 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"::: - - ]]> - - - - - + + + + + + + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventArgs + + + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + + 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"::: + + ]]> + + + + + + + + + + + + + + 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 text of the link that is clicked in the control. + Initializes a new instance of the class. + + + + + + + + + + + + + Constructor + + System.Windows.Forms + 6.0.0.0 + + + + + + + + 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. + + + + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + System.Int32 + + + Gets the length of the link span being clicked. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 6.0.0.0 + + + System.Int32 + + + Gets the start of the link span being clicked. + To be added. + To be added. + + + + + + + + + + + Property + + System.Windows.Forms + 1.0.5000.0 + 2.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.String + + + 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"::: + + ]]> + + + + + diff --git a/xml/System.Windows.Forms/MessageBoxButtons.xml b/xml/System.Windows.Forms/MessageBoxButtons.xml index 6e47e88b904..eb2cc46bb20 100644 --- a/xml/System.Windows.Forms/MessageBoxButtons.xml +++ b/xml/System.Windows.Forms/MessageBoxButtons.xml @@ -1,206 +1,206 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Enum - - - 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"::: - - ]]> - - - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 2 - - The message box contains Abort, Retry, and Ignore buttons. - - - - - - - - - - Field - - System.Windows.Forms - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 6 - - To be added. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 0 - - The message box contains an OK button. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 1 - - The message box contains OK and Cancel buttons. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 5 - - The message box contains Retry and Cancel buttons. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 4 - - The message box contains Yes and No buttons. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxButtons - - 3 - - The message box contains Yes, No, and Cancel buttons. - - - - + + + + + + + + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Enum + + + 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"::: + + ]]> + + + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 2 + + The message box contains Abort, Retry, and Ignore buttons. + + + + + + + + + + Field + + System.Windows.Forms + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 6 + + Specifies that the message box contains Cancel, Try Again, and Continue buttons. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 0 + + The message box contains an OK button. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 1 + + The message box contains OK and Cancel buttons. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 5 + + The message box contains Retry and Cancel buttons. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 4 + + The message box contains Yes and No buttons. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxButtons + + 3 + + The message box contains Yes, No, and Cancel buttons. + + + + diff --git a/xml/System.Windows.Forms/MessageBoxDefaultButton.xml b/xml/System.Windows.Forms/MessageBoxDefaultButton.xml index 579be08091e..6901b976732 100644 --- a/xml/System.Windows.Forms/MessageBoxDefaultButton.xml +++ b/xml/System.Windows.Forms/MessageBoxDefaultButton.xml @@ -1,133 +1,133 @@ - - - - - - - - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Enum - - - 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"::: - - ]]> - - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxDefaultButton - - 0 - - The first button on the message box is the default button. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxDefaultButton - - 256 - - The second button on the message box is the default button. - - - - - - - - - - Field - - System.Windows.Forms - 1.0.5000.0 - 2.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.MessageBoxDefaultButton - - 512 - - The third button on the message box is the default button. - - - - - - - - - - Field - - System.Windows.Forms - 6.0.0.0 - - - System.Windows.Forms.MessageBoxDefaultButton - - 768 - - 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.Enum + + + 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"::: + + ]]> + + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxDefaultButton + + 0 + + The first button on the message box is the default button. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxDefaultButton + + 256 + + The second button on the message box is the default button. + + + + + + + + + + Field + + System.Windows.Forms + 1.0.5000.0 + 2.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.MessageBoxDefaultButton + + 512 + + The third button on the message box is the default button. + + + + + + + + + + Field + + System.Windows.Forms + 6.0.0.0 + + + System.Windows.Forms.MessageBoxDefaultButton + + 768 + + Specifies that the Help button on the message box should be the default button. + + + + diff --git a/xml/System.Windows.Forms/TaskDialogButton.xml b/xml/System.Windows.Forms/TaskDialogButton.xml index 7213ea03bc0..4ba18944254 100644 --- a/xml/System.Windows.Forms/TaskDialogButton.xml +++ b/xml/System.Windows.Forms/TaskDialogButton.xml @@ -1,677 +1,677 @@ - - - - - - - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogControl - - - - 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. - - ]]> - - - - - - - - - - Constructor - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - Constructor - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - - - - - - The text of the control. - To be added. - 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. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Abort button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets a value that indicates whether the task dialog should close when this button is clicked. Or, if this button is the button, indicates whether the should be raised. - - if the task dialog should close when this button is clicked; otherwise, . The default value is . - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Cancel button. - To be added. - - ). - - ]]> - - - - - - - - - - - Event - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - 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`. - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Close button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Continue button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets a value indicating whether the button can respond to user interaction. - - 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. - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - To be added. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Help button. - To be added. - - event. - - ]]> - - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Ignore button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the No button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the OK button. - To be added. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - 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. - - or - This button is currently bound to a task dialog, but the dialog has just started navigating to a different page. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Retry button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - 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, . - 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. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.String - - - 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. - - or - The property is set and this button instance is currently bound to a task dialog. - - - - - - - - - - Method - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns a string that represents the current control. - A string that contains the control text. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Try Again button. - To be added. - To be added. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - 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. - - ]]> - - The property is set and this button instance is currently bound to a task dialog. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - Gets a standard instance representing the Yes button. - To be added. - To be added. - - - - + + + + + + + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogControl + + + + 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. + + ]]> + + + + + + + + + + Constructor + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + Constructor + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + + + + + + The text of the control. + 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. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Abort button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value that indicates whether the task dialog should close when this button is clicked. Or, if this button is the button, indicates whether the should be raised. + + if the task dialog should close when this button is clicked; otherwise, . The default value is . + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Cancel button. + To be added. + + ). + + ]]> + + + + + + + + + + + Event + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + 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`. + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Close button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Continue button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value indicating whether the button can respond to user interaction. + + 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. + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Help button. + To be added. + + event. + + ]]> + + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Ignore button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the No button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the OK button. + To be added. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + 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. + - or - This button is currently bound to a task dialog, but the dialog has just started navigating to a different page. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Retry button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + 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, . + 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. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.String + + + 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. + - or - The property is set and this button instance is currently bound to a task dialog. + + + + + + + + + + Method + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns a string that represents the current control. + A string that contains the control text. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Try Again button. + To be added. + To be added. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + 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. + + ]]> + + The property is set and this button instance is currently bound to a task dialog. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + Gets a standard instance representing the Yes button. + To be added. + To be added. + + + + diff --git a/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml b/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml index e7f529322ca..4109fc6439c 100644 --- a/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml +++ b/xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml @@ -1,91 +1,91 @@ - - - - - - - - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Forms.TaskDialogButton - - - - Represents a command link button control of a task dialog. - To be added. - - - - - - - - - Constructor - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - Constructor - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - - - - - - - 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 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. - - - - - - - - - - Property - - System.Windows.Forms - 5.0.0.0 - 6.0.0.0 - - - System.String - - - Gets or sets an additional description text that will be displayed in a separate line. - To be added. - To be added. - The property is set and this button instance is currently bound to a task dialog. - - - - + + + + + + + + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Forms.TaskDialogButton + + + + Represents a command link button control of a task dialog. + To be added. + + + + + + + + + Constructor + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + Constructor + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + + + + + + + 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 ). + 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. + + + + + + + + + + Property + + System.Windows.Forms + 5.0.0.0 + 6.0.0.0 + + + System.String + + + Gets or sets an additional description text that will be displayed in a separate line. + To be added. + To be added. + The property is set and this button instance is currently bound to a task dialog. + + + + diff --git a/xml/System.Windows.Forms/TextRenderer.xml b/xml/System.Windows.Forms/TextRenderer.xml index 63712b7733c..c236e110f44 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. From dfb81f015f67ef6b70fd42be00cd7877a3a412ae Mon Sep 17 00:00:00 2001 From: Natalia Kondratyeva Date: Wed, 8 Sep 2021 21:06:30 +0200 Subject: [PATCH 06/28] Add WebSocket and HttpHeadersNonValidated missing APIs (#7116) * Add WebSocket and HttpHeadersNonValidated missing APIs * Update xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../HttpHeadersNonValidated.xml | 10 +++++----- xml/System.Net.WebSockets/WebSocket.xml | 12 ++++++------ .../WebSocketCreationOptions.xml | 2 +- .../WebSocketDeflateOptions.xml | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml b/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml index e8096ef2a1f..fcfdd637ad3 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,10 @@ 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.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index 2b56223b227..b23c63a8bb0 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -958,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. From 5f12b275d80bce2fa647ea0b1d292ac254070de7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 13:03:05 -0700 Subject: [PATCH 07/28] Port System.Net triple slash to docs (#7105) * Port System.Net triple slash to docs * Address suggestions by gewarren Co-authored-by: carlossanlop --- xml/System.Net.Http/SocketsHttpConnectionContext.xml | 4 ++-- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- .../SocketsHttpPlaintextStreamFilterContext.xml | 12 ++++++------ xml/System.Net.Security/NegotiateStream.xml | 12 ++++++++++++ xml/System.Net.Security/SslStream.xml | 8 ++++++++ xml/System.Net.Sockets/NetworkStream.xml | 12 ++++++------ xml/System.Net/IPAddress.xml | 2 ++ 7 files changed, 37 insertions(+), 15 deletions(-) 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..e02ea1ab279 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. 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.Security/NegotiateStream.xml b/xml/System.Net.Security/NegotiateStream.xml index 0c87966e287..d7fb0b6bc78 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. diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index aa26875468e..590206b90b7 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. 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/IPAddress.xml b/xml/System.Net/IPAddress.xml index e63ef7dbfa8..75edd331706 100644 --- a/xml/System.Net/IPAddress.xml +++ b/xml/System.Net/IPAddress.xml @@ -2177,6 +2177,8 @@ ]]> + + is . From 03001610d9bac8171dc035db96a4503f08627f75 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 13:07:29 -0700 Subject: [PATCH 08/28] Port System.Text.Json triple slash to docs (#7094) * Port System.Text.Json triple slash to docs * fix warnings * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../JsonMetadataServices.xml | 12 +- .../JsonObjectInfoValues`1.xml | 16 +- .../JsonParameterInfoValues.xml | 12 +- .../JsonConverter`1.xml | 38 +- xml/System.Text.Json/JsonSerializer.xml | 451 ++++++++++++------ .../Capture.xml | 4 +- 6 files changed, 361 insertions(+), 172 deletions(-) diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml b/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml index 6f8773d8a18..0a81589ce4b 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml @@ -821,12 +821,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the class or struct. + The to initialize the metadata with. + 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. + + or is . diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml b/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml index 61a8a2534b2..e1b53580340 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml @@ -17,8 +17,8 @@ - To be added. - To be added. + The object type to serialize or deserialize. + Provides serialization metadata about an object type with constructors, properties, and fields. To be added. @@ -55,7 +55,7 @@ System.Func<System.Text.Json.Serialization.Metadata.JsonParameterInfoValues[]> - To be added. + 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. @@ -76,7 +76,7 @@ System.Text.Json.Serialization.JsonNumberHandling - To be added. + 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. @@ -97,7 +97,7 @@ System.Func<T> - To be added. + 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. @@ -118,7 +118,7 @@ System.Func<System.Object[],T> - To be added. + 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. @@ -139,7 +139,7 @@ System.Func<System.Text.Json.Serialization.JsonSerializerContext,System.Text.Json.Serialization.Metadata.JsonPropertyInfo[]> - To be added. + Gets or sets a mechanism to initialize metadata for properties and fields of the class or struct. To be added. To be added. @@ -160,7 +160,7 @@ System.Action<System.Text.Json.Utf8JsonWriter,T> - To be added. + 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 index 47e7f1817ca..bcb9a1c9542 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml @@ -14,7 +14,7 @@ - To be added. + Provides information about a constructor parameter required for JSON deserialization. To be added. @@ -51,7 +51,7 @@ System.Object - To be added. + Gets or sets the default value of the parameter. To be added. To be added. @@ -72,7 +72,7 @@ System.Boolean - To be added. + Gets or sets a value that specifies whether a default value was specified for the parameter. To be added. To be added. @@ -93,7 +93,7 @@ System.String - To be added. + Gets or sets the name of the parameter. To be added. To be added. @@ -114,7 +114,7 @@ System.Type - To be added. + Gets or sets the type of the parameter. To be added. To be added. @@ -135,7 +135,7 @@ System.Int32 - To be added. + 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 df8285f076f..69a97440a78 100644 --- a/xml/System.Text.Json.Serialization/JsonConverter`1.xml +++ b/xml/System.Text.Json.Serialization/JsonConverter`1.xml @@ -184,12 +184,20 @@ For more information, see [How to write custom converters for JSON serialization - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -254,11 +262,19 @@ For more information, see [How to write custom converters for JSON serialization - To be added. - To be added. - To be added. - To be added. - To be added. + 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/JsonSerializer.xml b/xml/System.Text.Json/JsonSerializer.xml index 4e1d5072f7c..c1289d8a61b 100644 --- a/xml/System.Text.Json/JsonSerializer.xml +++ b/xml/System.Text.Json/JsonSerializer.xml @@ -255,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. @@ -300,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. @@ -418,13 +428,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. @@ -455,12 +471,17 @@ Using a is not as efficient as using the - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -484,12 +505,33 @@ Using a is not as efficient as using the - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -518,12 +560,17 @@ Using a is not as efficient as using the - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -547,12 +594,29 @@ Using a is not as efficient as using the - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -581,12 +645,15 @@ Using a is not as efficient as using the - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -610,12 +677,29 @@ Using a is not as efficient as using the - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -973,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. @@ -1020,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. @@ -1133,13 +1227,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. @@ -1172,11 +1272,16 @@ Using a is not as efficient as using the To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -1203,11 +1308,20 @@ Using a is not as efficient as using the To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -1239,11 +1353,14 @@ Using a is not as efficient as using the To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -1270,11 +1387,16 @@ Using a is not as efficient as using the To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -1306,11 +1428,14 @@ Using a is not as efficient as using the To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -1337,11 +1462,16 @@ Using a is not as efficient as using the To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2480,12 +2610,18 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2509,12 +2645,16 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. - To be added. - To be added. - To be added. - To be added. + 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 . @@ -2546,11 +2686,12 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2577,11 +2718,14 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa To be added. - To be added. - To be added. - To be added. - To be added. + 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 . @@ -2610,12 +2754,18 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2639,12 +2789,16 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. - To be added. - To be added. - To be added. - To be added. + 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 . @@ -2676,11 +2830,12 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2707,11 +2862,14 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa To be added. - To be added. - To be added. - To be added. - To be added. + 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 . @@ -2740,12 +2898,17 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2769,12 +2932,16 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa - To be added. - To be added. - To be added. - To be added. - To be added. + 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 . @@ -2806,11 +2973,12 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa To be added. - To be added. - To be added. - To be added. - To be added. + 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. @@ -2837,11 +3005,14 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa To be added. - To be added. - To be added. - To be added. - To be added. + 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 . diff --git a/xml/System.Text.RegularExpressions/Capture.xml b/xml/System.Text.RegularExpressions/Capture.xml index 6f5d8de87b1..04bcbfa785b 100644 --- a/xml/System.Text.RegularExpressions/Capture.xml +++ b/xml/System.Text.RegularExpressions/Capture.xml @@ -335,8 +335,8 @@ System.ReadOnlySpan<System.Char> - To be added. - To be added. + Gets the captured span from the input string. + The span that is captured by the match. To be added. From d4d61a4b6d2e389ba2ef3df617807b63219025cb Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:22:01 -0700 Subject: [PATCH 09/28] Port System.Diagnostics triple slash to docs (#7100) * Port System.Diagnostics triple slash to docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Counter`1.xml | 6 +- .../Histogram`1.xml | 6 +- .../Instrument`1.xml | 6 +- xml/System.Diagnostics/CounterSample.xml | 12 +-- .../EventLogEntryCollection.xml | 2 +- xml/System.Diagnostics/TagList.xml | 94 ++++++++++++------- 6 files changed, 75 insertions(+), 51 deletions(-) diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 371462997b7..4e1c809d91f 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -149,9 +149,9 @@ This class supports only the following generic parameter types: - To be added. - To be added. - To be added. + 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 ca80d8a0f1a..76a3f579713 100644 --- a/xml/System.Diagnostics.Metrics/Histogram`1.xml +++ b/xml/System.Diagnostics.Metrics/Histogram`1.xml @@ -151,9 +151,9 @@ This class supports only the following generic parameter types: - To be added. - To be added. - To be added. + 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 29e306af158..16a06e8a4b0 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -141,9 +141,9 @@ This class supports only the following generic parameter types: - To be added. - To be added. - To be added. + 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/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/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/TagList.xml b/xml/System.Diagnostics/TagList.xml index a745b5729bd..db1df0c94c4 100644 --- a/xml/System.Diagnostics/TagList.xml +++ b/xml/System.Diagnostics/TagList.xml @@ -42,8 +42,18 @@ - To be added. - To be added. + Represents a list of tags that can be accessed by index. Provides methods to search, sort, and manipulate lists. + + + @@ -62,8 +72,8 @@ - To be added. - To be added. + A span of tags to initialize the list with. + Initializes a new instance of using the specified . To be added. @@ -89,8 +99,8 @@ - To be added. - To be added. + The key-value pair of the tag to add to the list. + Adds a tag to the list. To be added. @@ -114,9 +124,9 @@ - To be added. - To be added. - To be added. + The tag key. + The tag value. + Adds a tag with the specified and to the list. To be added. @@ -140,7 +150,7 @@ - To be added. + Removes all elements from the . To be added. @@ -172,9 +182,10 @@ - To be added. - To be added. - To be added. + The tag to locate in the . + Determines whether a tag is in the . + + if item is found in the ; otherwise, . To be added. @@ -203,9 +214,11 @@ - To be added. - To be added. + 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. @@ -237,10 +250,14 @@ - To be added. - To be added. - To be added. + 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. @@ -269,7 +286,7 @@ System.Int32 - To be added. + Gets the number of tags contained in the . To be added. To be added. @@ -300,8 +317,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the . + An enumerator that iterates through the . To be added. @@ -333,8 +350,8 @@ - To be added. - To be added. + The tag to locate in the . + Searches for the specified tag and returns the zero-based index of the first occurrence within the entire . To be added. To be added. @@ -362,10 +379,12 @@ - To be added. - To be added. - To be added. + 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 . @@ -393,7 +412,7 @@ System.Boolean - To be added. + Gets a value indicating whether the is read-only. This property will always return . To be added. To be added. @@ -427,9 +446,11 @@ To be added. - To be added. + Gets or sets the tags at the specified index. To be added. To be added. + + is not a valid index in the . @@ -454,9 +475,10 @@ - To be added. - To be added. - To be added. + 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. @@ -482,9 +504,11 @@ - To be added. - To be added. + 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 . @@ -513,8 +537,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the . + An enumerator that iterates through the . To be added. From 9d2208d83e5334181482c0c3713008dc4c539189 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:22:58 -0700 Subject: [PATCH 10/28] Update symlink documentation (#7118) * Update symlink documentation * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.IO/Directory.xml | 29 +++++++++++++++++++++++------ xml/System.IO/File.xml | 26 ++++++++++++++++++++++---- xml/System.IO/FileSystemInfo.xml | 31 +++++++++++++++++++++++++------ 3 files changed, 70 insertions(+), 16 deletions(-) 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/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 From 673ba603df1bd1a3160fa604346c496c3053e7b7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:23:31 -0700 Subject: [PATCH 11/28] Port System triple slash to docs (#7106) * Port System triple slash to docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * String suggestions Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System/ArgumentNullException.xml | 6 +++--- xml/System/BinaryData.xml | 15 +++++++++++++-- xml/System/HashCode.xml | 15 ++++++++++++--- xml/System/MemoryExtensions.xml | 24 +++++++++++++----------- xml/System/String.xml | 18 +++++++++--------- 5 files changed, 50 insertions(+), 28 deletions(-) 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..624ffbf213a 100644 --- a/xml/System/BinaryData.xml +++ b/xml/System/BinaryData.xml @@ -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/HashCode.xml b/xml/System/HashCode.xml index 1ae58a22abe..a430a50d4cd 100644 --- a/xml/System/HashCode.xml +++ b/xml/System/HashCode.xml @@ -185,9 +185,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. + + + diff --git a/xml/System/MemoryExtensions.xml b/xml/System/MemoryExtensions.xml index ad810445832..36cab203204 100644 --- a/xml/System/MemoryExtensions.xml +++ b/xml/System/MemoryExtensions.xml @@ -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/String.xml b/xml/System/String.xml index 868d0958bfb..71390618215 100644 --- a/xml/System/String.xml +++ b/xml/System/String.xml @@ -4595,10 +4595,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. @@ -4636,11 +4636,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. From 052bfc4a9a9f67c9d88bec97646ce9fdb069e1d0 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:24:08 -0700 Subject: [PATCH 12/28] Port System.Runtime.Versioning.RequiresPreviewFeaturesAttribute triple slash to docs (#7102) * Port System.Runtime.Versioning.RequiresPreviewFeaturesAttribute triple slash to docs * suggestion by pgovind * add link * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../RequiresPreviewFeaturesAttribute.xml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml b/xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml index 1aea749e11e..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 @@ -57,8 +58,8 @@ - To be added. - To be added. + An optional message associated with this attribute instance. + Initializes a new instance of the class with the specified message. To be added. @@ -78,7 +79,7 @@ System.String - To be added. + Gets the optional message associated with this attribute instance. To be added. To be added. @@ -99,7 +100,7 @@ System.String - To be added. + Gets or sets the optional URL associated with this attribute instance. To be added. To be added. From d983c5d6bc64dff50ccf3f7499db8f5b61f89cea Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:25:41 -0700 Subject: [PATCH 13/28] Port System.Reflection triple slash to docs (#7099) * Port System.Reflection triple slash to docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Buyaa Namnan Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Buyaa Namnan --- .../MetadataUpdateHandlerAttribute.xml | 22 +++++++++--- .../MetadataUpdater.xml | 28 ++++++++++----- xml/System.Reflection/NullabilityInfo.xml | 16 ++++----- .../NullabilityInfoContext.xml | 36 +++++++++++-------- xml/System.Reflection/NullabilityState.xml | 8 ++--- 5 files changed, 71 insertions(+), 39 deletions(-) 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..73547ecd942 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,8 @@ 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/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 bdbefb1fb1d..b885f993b95 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. @@ -54,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 . @@ -79,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 . @@ -104,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 . @@ -129,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). From 71c0d665ec90fc61da61a0ce17632bd437fb3587 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:32:23 -0700 Subject: [PATCH 14/28] Port Security.Cryptography.Pkcs, Security.Permissions, Security.Policy triple slash to docs (#7097) Co-authored-by: carlossanlop --- xml/System.Security.Cryptography.Pkcs/SignedCms.xml | 8 ++++---- xml/System.Security.Cryptography.Pkcs/SignerInfo.xml | 4 ++-- xml/System.Security.Permissions/StorePermission.xml | 4 ++-- xml/System.Security.Policy/ApplicationTrust.xml | 2 +- xml/System.Security.Policy/PolicyStatement.xml | 2 +- xml/System.Security.Policy/UrlMembershipCondition.xml | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml index eff46f772b5..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. diff --git a/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml b/xml/System.Security.Cryptography.Pkcs/SignerInfo.xml index f5da60a182a..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. 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. 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 . 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, . diff --git a/xml/System.Security.Policy/UrlMembershipCondition.xml b/xml/System.Security.Policy/UrlMembershipCondition.xml index 4d0e82bc72d..82ff5aeda8f 100644 --- a/xml/System.Security.Policy/UrlMembershipCondition.xml +++ b/xml/System.Security.Policy/UrlMembershipCondition.xml @@ -239,7 +239,7 @@ The object to compare to the current . - To be added. + 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, . From 05641e792267d95809a2342d678e37fe61f8f856 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 15:32:44 -0700 Subject: [PATCH 15/28] Port System.Security.Cryptography.Xml triple slash to docs (#7096) * Port System.Security.Cryptography.Xml triple slash to docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Update xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../CipherReference.xml | 2 +- .../CryptoSignedXmlRecursionException.xml | 3 ++- .../DataReference.xml | 2 +- .../EncryptedReference.xml | 2 +- .../EncryptedXml.xml | 20 +++++++++---------- .../EncryptionMethod.xml | 2 +- .../EncryptionProperty.xml | 2 +- .../KeyInfoEncryptedKey.xml | 2 +- .../KeyInfoRetrievalMethod.xml | 2 +- .../KeyReference.xml | 2 +- 10 files changed, 20 insertions(+), 19 deletions(-) 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. - To be added. + 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. 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. 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. Date: Wed, 8 Sep 2021 20:21:52 -0700 Subject: [PATCH 16/28] Add missing code dom comments (#7124) * Add docs for missing members in System.CodeDom * Add missing return statement * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.CodeDom.Compiler/IndentedTextWriter.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) 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. From f2da24d1affb46dfd2cb2aada54e393589fd92af Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 21:02:30 -0700 Subject: [PATCH 17/28] Port System.Security.Cryptography triple slash to docs (#7098) * Port System.Security.Cryptography triple slash to docs * Fix -or- spacing * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Security.Cryptography/HMACMD5.xml | 2 +- xml/System.Security.Cryptography/HMACSHA1.xml | 2 +- .../HMACSHA512.xml | 2 +- .../SymmetricAlgorithm.xml | 940 +++++++++++++----- 4 files changed, 708 insertions(+), 238 deletions(-) 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/HMACSHA512.xml b/xml/System.Security.Cryptography/HMACSHA512.xml index 903dbe77587..b3b1bcc6f62 100644 --- a/xml/System.Security.Cryptography/HMACSHA512.xml +++ b/xml/System.Security.Cryptography/HMACSHA512.xml @@ -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/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. From 7bc7d204638adfc66185e9c319df128e88b783b0 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 21:49:43 -0700 Subject: [PATCH 18/28] Port System.Security.Cryptography.X509Certificates triple slash to docs (#7095) Co-authored-by: carlossanlop --- .../X509Certificate2.xml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 . ]]> From 336771211434939864bcb5d7a6240eacc485cf07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marie=20P=C3=ADchov=C3=A1?= <11718369+ManickaP@users.noreply.github.com> Date: Thu, 9 Sep 2021 09:40:19 +0200 Subject: [PATCH 19/28] Ported docs from System.Net (#7117) * Ported docs from https://github.com/dotnet/runtime/pull/57855 * Update xml/System.Net.Http/HeaderEncodingSelector`1.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- .../HeaderEncodingSelector`1.xml | 2 +- xml/System.Net.Http/HttpContent.xml | 19 +++++++++++++++---- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- xml/System.Net.Security/NegotiateStream.xml | 4 ++-- .../SslApplicationProtocol.xml | 2 +- 5 files changed, 20 insertions(+), 9 deletions(-) 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/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/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index e02ea1ab279..d0bc27e5f22 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -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.Security/NegotiateStream.xml b/xml/System.Net.Security/NegotiateStream.xml index d7fb0b6bc78..4c27648fb5f 100644 --- a/xml/System.Net.Security/NegotiateStream.xml +++ b/xml/System.Net.Security/NegotiateStream.xml @@ -4143,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. System.Net.Security.SslApplicationProtocol - To be added. + Defines a instance for HTTP 3.0. To be added. From 529dbf0eae8958e78e3947aee02678d0347b7a6d Mon Sep 17 00:00:00 2001 From: Stephen Toub Date: Thu, 9 Sep 2021 11:04:36 -0400 Subject: [PATCH 20/28] Add "To be added" typeparam docs to AppendInterpolatedStringHandler (#7127) --- .../StringBuilder+AppendInterpolatedStringHandler.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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. From 908a206aef1137719e16421d8830f05c781018b6 Mon Sep 17 00:00:00 2001 From: Pavel Savara Date: Thu, 9 Sep 2021 20:28:10 +0200 Subject: [PATCH 21/28] missing doc for HttpRequestOptions, HttpRequestOptionsKey and HttpRequestMessage.Options --- xml/System.Net.Http/HttpRequestMessage.xml | 2 +- xml/System.Net.Http/HttpRequestOptions.xml | 41 +++++++++++-------- .../HttpRequestOptionsKey`1.xml | 10 ++--- 3 files changed, 31 insertions(+), 22 deletions(-) diff --git a/xml/System.Net.Http/HttpRequestMessage.xml b/xml/System.Net.Http/HttpRequestMessage.xml index f5a7adc79f3..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. diff --git a/xml/System.Net.Http/HttpRequestOptions.xml b/xml/System.Net.Http/HttpRequestOptions.xml index 46c17078d18..774671c90a7 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 key parameter. + Strongly typed key to get the value of HTTP request option. For example new HttpRequestOptionsKey<bool>("WebAssemblyEnableStreamingResponse") + The value of the HTTP request option. + Sets the value of a given 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,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. - To be added. + The type of the HTTP value as defined by key parameter. + Strongly typed key to get the value of HTTP request option. For example new HttpRequestOptionsKey<bool>("WebAssemblyEnableStreamingResponse") + Returns the value of HTTP request option. + Gets the value of a given HTTP request option. + True, if an option is retrieved. To be added. diff --git a/xml/System.Net.Http/HttpRequestOptionsKey`1.xml b/xml/System.Net.Http/HttpRequestOptionsKey`1.xml index f6125f767b5..fac25cf3000 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 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 HttpRequestOptionsKey using the supplied 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. From 6e3f5499e3aec96a67b41fd8fa42e8bb5e3e5182 Mon Sep 17 00:00:00 2001 From: Levi Broderick Date: Thu, 9 Sep 2021 12:06:33 -0700 Subject: [PATCH 22/28] Add some missing System.Text docs (#7121) * Correct missing devdoc. * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Text/Rune.xml | 3 +-- xml/System.Text/SpanLineEnumerator.xml | 9 +++++---- 2 files changed, 6 insertions(+), 6 deletions(-) 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. From 9a0cb628a718a6c384f61527ad685bf811f396ed Mon Sep 17 00:00:00 2001 From: Jose Perez Rodriguez Date: Thu, 9 Sep 2021 12:08:51 -0700 Subject: [PATCH 23/28] Add missing documentation for System.CompilerServices namespace (#7130) --- .../CreateNewOnMetadataUpdateAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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. From 74cf0e5ca80d5499794cab71fa733f34b59a0e94 Mon Sep 17 00:00:00 2001 From: Jose Perez Rodriguez Date: Thu, 9 Sep 2021 12:09:05 -0700 Subject: [PATCH 24/28] Add missing documentation for APIs in System.Configuration (#7128) --- xml/System.Configuration/SettingsAttributeDictionary.xml | 6 +++--- xml/System.Configuration/SettingsContext.xml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) 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. From bda5a97031b2c5442f895598edcb4f5c4f43bd9c Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 9 Sep 2021 15:58:12 -0700 Subject: [PATCH 25/28] Port IntPtr and MemoryExtensions triple slash to docs (#7131) * Port IntPtr and MemoryExtensions triple slash to docs * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: carlossanlop Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System/IntPtr.xml | 13 ++-- ...ions+TryWriteInterpolatedStringHandler.xml | 73 ++++++++++--------- 2 files changed, 44 insertions(+), 42 deletions(-) diff --git a/xml/System/IntPtr.xml b/xml/System/IntPtr.xml index 6f11c818544..893532131f2 100644 --- a/xml/System/IntPtr.xml +++ b/xml/System/IntPtr.xml @@ -2193,12 +2193,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. diff --git a/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml b/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml index 0c3b433675b..6f597d16579 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. @@ -135,9 +135,9 @@ - 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 +161,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. 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. @@ -217,11 +217,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. 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 +247,10 @@ - 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,10 +277,10 @@ - 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. To be added. To be added. @@ -308,11 +308,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 format string. + Writes a specified value to the handler using a specified format string. + on success; otherwise. To be added. @@ -340,12 +340,12 @@ - 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 +368,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. From a265def66383e5f4ec26e46063d16c9e578f2990 Mon Sep 17 00:00:00 2001 From: Larry Ewing Date: Thu, 9 Sep 2021 22:58:11 -0500 Subject: [PATCH 26/28] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Net.Http/HttpRequestOptions.xml | 16 ++++++++-------- xml/System.Net.Http/HttpRequestOptionsKey`1.xml | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/xml/System.Net.Http/HttpRequestOptions.xml b/xml/System.Net.Http/HttpRequestOptions.xml index 774671c90a7..1758d8227b9 100644 --- a/xml/System.Net.Http/HttpRequestOptions.xml +++ b/xml/System.Net.Http/HttpRequestOptions.xml @@ -83,10 +83,10 @@ - The type of the HTTP value as defined by key parameter. - Strongly typed key to get the value of HTTP request option. For example new HttpRequestOptionsKey<bool>("WebAssemblyEnableStreamingResponse") + 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 given request option. + Sets the value of a specified HTTP request option. To be added. @@ -693,11 +693,11 @@ This member is an explicit interface member implementation. It can be used only - The type of the HTTP value as defined by key parameter. - Strongly typed key to get the value of HTTP request option. For example new HttpRequestOptionsKey<bool>("WebAssemblyEnableStreamingResponse") - Returns the value of HTTP request option. - Gets the value of a given HTTP request option. - True, if an option is retrieved. + 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 fac25cf3000..4ca1f386f35 100644 --- a/xml/System.Net.Http/HttpRequestOptionsKey`1.xml +++ b/xml/System.Net.Http/HttpRequestOptionsKey`1.xml @@ -25,7 +25,7 @@ The type of the value of the option. - Represents a key in the options for an HTTP request. + Represents a key in the options collection for an HTTP request. To be added. @@ -47,7 +47,7 @@ Name of the HTTP request option. - Initializes a new instance of the HttpRequestOptionsKey using the supplied key name. + Initializes a new instance of the class using the specified key name. To be added. From 901fc58a0d0c3ec7e6ea1ea1e761ec5685adb115 Mon Sep 17 00:00:00 2001 From: Ryland <41491307+ryalanms@users.noreply.github.com> Date: Mon, 13 Sep 2021 12:35:55 -0700 Subject: [PATCH 27/28] Update documentation: PresentationCore: AutomationPeers, Ink, and Input --- .../AutomationPeer.xml | 4598 +++++++++-------- .../ContentElementAutomationPeer.xml | 1908 +++---- .../UIElement3DAutomationPeer.xml | 2272 ++++---- .../UIElementAutomationPeer.xml | 1862 +++---- .../AutomationHeadingLevel.xml | 442 +- .../AutomationProperties.xml | 3916 +++++++------- .../DocumentPaginator.xml | 1294 ++--- .../DynamicDocumentPaginator.xml | 954 ++-- xml/System.Windows.Ink/DrawingAttributes.xml | 2604 +++++----- .../DrawingAttributesReplacedEventArgs.xml | 230 +- xml/System.Windows.Ink/Stroke.xml | 3559 ++++++------- xml/System.Windows.Ink/StrokeCollection.xml | 3652 ++++++------- .../StylusPointsReplacedEventArgs.xml | 230 +- .../StylusPlugInCollection.xml | 305 +- .../CanExecuteRoutedEventArgs.xml | 518 +- xml/System.Windows.Input/Cursor.xml | 556 +- .../ExecutedRoutedEventArgs.xml | 348 +- xml/System.Windows.Input/IManipulator.xml | 289 +- xml/System.Windows.Input/InputGesture.xml | 200 +- xml/System.Windows.Input/InputType.xml | 336 +- .../ManipulationBoundaryFeedbackEventArgs.xml | 266 +- .../ManipulationCompletedEventArgs.xml | 534 +- .../ManipulationDeltaEventArgs.xml | 880 ++-- .../ManipulationInertiaStartingEventArgs.xml | 850 +-- .../ManipulationStartedEventArgs.xml | 390 +- .../ManipulationStartingEventArgs.xml | 670 +-- xml/System.Windows.Input/MouseDevice.xml | 1546 +++--- xml/System.Windows.Input/StylusButton.xml | 459 +- .../StylusPointProperty.xml | 454 +- .../TabletDeviceCollection.xml | 636 +-- xml/System.Windows.Input/TouchDevice.xml | 2038 ++++---- xml/System.Windows.Interop/HwndSource.xml | 3486 ++++++------- 32 files changed, 21273 insertions(+), 21009 deletions(-) diff --git a/xml/System.Windows.Automation.Peers/AutomationPeer.xml b/xml/System.Windows.Automation.Peers/AutomationPeer.xml index 0dd5fa22a28..c5e3e51ff2a 100644 --- a/xml/System.Windows.Automation.Peers/AutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/AutomationPeer.xml @@ -1,2291 +1,2307 @@ - - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Threading.DispatcherObject - - - - Provides a base class that exposes an element to UI Automation. - - - - UI Automation Overview - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - Provides initialization for base class values when they are called by the constructor of a derived class. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Automation.Peers.AutomationPeer - - - Gets or sets an that is reported to the automation client as a source for all the events that come from this . - The that is the source of events. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the accelerator key combinations for the element that is associated with the UI Automation peer. - The accelerator key. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The accelerator key. - - - - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the access key for the element that is associated with the automation peer. - The string that contains the access key. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The string that contains the access key. - - - - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationControlType - - - - Gets the control type for the element that is associated with the UI Automation peer. - The control type. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationControlType - - - - When overridden in a derived class, is called by . - The control type. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the of the element that is associated with the automation peer. - The identifier. - - property. If that property is not set, the value is the property. - - ]]> - - A public call to this method is currently in progress. - - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The string that contains the identifier. - - property. If that property is not set, the value is the property. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Rect - - - - Gets the object that represents the screen coordinates of the element that is associated with the automation peer. - The bounding rectangle. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Rect - - - - When overridden in a derived class, is called by . - The bounding rectangle. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - Gets the collection of elements that are represented in the UI Automation tree as immediate child elements of the automation peer. - The collection of child elements. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - When overridden in a derived class, is called by . - The collection of child elements. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a name that is used with , to differentiate the control that is represented by this . - The class name. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The class name. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - Gets a on the element that is associated with the automation peer that responds to a mouse click. - A point in the clickable area of the element. - - , a clickable point is any point in the visible client area of the that issues the command that the button represents when it is clicked by the mouse. - - ]]> - - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - When overridden in a derived class, is called by . - A point within the clickable area of the element. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - Provides UI Automation with a list of elements affected or controlled by this . - A list of automation peers for the controlled elements. - To be added. - A public call to this method is currently in progress. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - When overridden in a derived class, provides UI Automation with a list of elements affected or controlled by this . - A list of automation peers for the controlled elements. - To be added. - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets text that describes the functionality of the control that is associated with the automation peer. - The help text. - - - - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The help text. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - - System.Windows.Automation.Peers.HostedWindowWrapper - - - - Tells UI Automation where in the UI Automation tree to place the being hosted by a Windows Presentation Foundation (WPF) element. - This method returns the hosted to UI Automation for controls that host objects. - - that is associated with an element that immediately hosts an `hwnd` must override this method. - - If this method is not overridden, UI Automation places the `hwnd` as a child element of the that hosts the whole application. Typically, you want to override this default behavior and set UI Automation to position the hosted `hwnd` parallel to the place where it is located in the Windows Presentation Foundation (WPF) logical tree. - - Except in hosting scenarios, do not allow types to override this method. - - In addition to overriding this method, the types that are associated with an element that immediately hosts an `hwnd` must return the that is cast to in response to WM_GETOBJECT coming to the hosted `hwnd`. - - To get a pointer to , call . - - ]]> - - UI Automation Overview - UI Automation Tree Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets text that conveys the visual status of the element that is associated with this automation peer. - The status. - - - - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The status. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a string that describes what kind of item an object represents. - The kind of item. - - - - A public call to this method is currently in progress. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The kind of item. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Gets the for the that is targeted to the element. - The for the element that is targeted by the . - - control, the method gets the for the that is associated with the . - - In the following image, the "Themes" is targeted to the ; therefore the for the also targets the . When the user presses **ALT**+**T**, the gets focus instead of the . - - ![Display properties shows labeled by usage](~/add/media/labeledby.JPG "Display properties shows labeled by usage") - - The method for returns the for the corresponding . This enables an automation client to get the text string that describes the . - - ]]> - - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - When overridden in a derived class, is called by . - The for the element that is targeted by the . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationLiveSetting - - - - Gets the notification characteristics of a live region that is associated with this automation peer. - The notification characteristics. - - . - -]]> - - A public call to this method is currently in progress. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationLiveSetting - - - - When overridden in a derived class, returns the notification characteristics of a live region. Called by the method. - The notification characteristics of a live region. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a human-readable localized string that represents the value for the control that is associated with this automation peer. - The type of the control. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The type of the control. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets text that describes the element that is associated with this automation peer. - The name. - - . - - ]]> - - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - When overridden in a derived class, is called by . - The string that contains the label. - - control that lets users select a color might return "Colors". - - Make sure that you have assigned a name to all controls in the graphical user interface (GUI) so that accessibility tools such as screen readers can refer to each control in a localized manner. - - ]]> - - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationOrientation - - - - Gets a value that indicates the explicit control orientation, if any. - The orientation of the control. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationOrientation - - - - When overridden in a derived class, is called by . - The orientation of the control. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Gets the that is the parent of this . - The parent automation peer. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - A value from the enumeration. - When overridden in a derived class, gets the control pattern that is associated with the specified . - The object that implements the pattern interface; if this peer does not support this interface. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The position on the screen to get the from. - Gets an from the specified point. - The at the specified point. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The position on the screen to get the from. - When overridden in a derived class, is called from . - The at the specified point. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Attempts to get the value of the property. - The value of the property. - A public call to this method cannot be attempted if another public call is in progress. - A public call to this method is currently in progress. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - When overridden in a derived class, provides UI Automation with a one-based integer value that describes the position this element occupies in a group or set. - A one-based integer value that describes the position this element occupies in a group or set. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Attempts to get the value of the property. - The value of the property. - A public call to this method cannot be attempted if another public call is in progress. - A public call to this method is currently in progress. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - When overridden in a derived class, provides UI Automation with the size of the group or set that this element belongs to. - An integer value that describes the size of the group or set that this element belongs to. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. - - if the element has keyboard focus; otherwise, . - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element has keyboard focus; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Triggers recalculation of the main properties of the and raises the notification to the Automation Client if the properties changed. - - and . - - Typically, updates and notifications happen automatically after the update of the layout in Windows Presentation Foundation (WPF). (The update occurs in response to the event.) Sometimes, however, properties change without raising the event. For example, when the whole moves, the event is not raised. In this example, the set of objects change because the objects are expressed in screen coordinates. Therefore, the must call on its peer on . - - ]]> - - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user. - - if the element is a content element; otherwise, . - - - - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element is a content element; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI. - - if the element is a control; otherwise, . - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element is a control; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Boolean - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Boolean - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element associated with this automation peer supports interaction. - - if the element supports interaction; otherwise, . - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the automation peer can receive and send events; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the element that is associated with this hosts in Windows Presentation Foundation (WPF). - - if the element that is associated with this hosts in Windows Presentation Foundation (WPF); otherwise, . - - and . - - These peers must also override . - - ]]> - - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element can accept keyboard focus. - - if the element can accept keyboard focus; otherwise, . - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element can accept keyboard focus; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether an element is off the screen. - - if the element is not on the screen; otherwise, . - - - - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element is not on the screen; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element contains sensitive content. - - if the element contains sensitive content such as a password; otherwise, . - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element contains sensitive content; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the element that is associated with this peer must be completed on a form. - - if the element must be completed; otherwise, . - To be added. - A public call to this method is currently in progress. - - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - When overridden in a derived class, is called by . - - if the element is must be completed; otherwise, . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - One of the enumeration values. - Gets a value that indicates whether UI Automation is listening for the specified event. - A that indicates whether UI Automation is listening for the event. - - that raises the event. This method is a performance measure because if UI Automation does not listen for the event, it does not make sense to create a peer to raise one. - -> [!NOTE] -> This method is static and only answers if a delegate listens for the specified event in UI Automation, not for an event on a specific element. UI Automation can create broadcast listeners; therefore the per-element information is irrelevant. - - ]]> - - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The class that implements . - Gets an for the specified proxy. - An for the specified proxy. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Provider.IRawElementProviderSimple - - - - - - The automation peer. - Gets the for the specified . - The proxy. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The event data. - Called by the to raise the event. - To be added. - - is . - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The event identifier. - Raises an automation event. - To be added. - UI Automation Overview - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Void - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - - The property that changed. - The previous value of the property. - The new value of the property. - Raises an event to notify the automation client of a changed property value. - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 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.Void - - - - Synchronously resets the tree of child elements by calling . - - , which can change the child elements of the peer by moving the . - - ]]> - - UI Automation Overview - UI Automation Control Patterns Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Sets the keyboard focus on the element that is associated with this automation peer. - To be added. - A public call to this method is currently in progress. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - When overridden in a derived class, is called by . - To be added. - UI Automation Overview - Server-side UI Automation Provider Implementation - - - - + + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Threading.DispatcherObject + + + + Provides a base class that exposes an element to UI Automation. + + + + UI Automation Overview + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + Provides initialization for base class values when they are called by the constructor of a derived class. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Automation.Peers.AutomationPeer + + + Gets or sets an that is reported to the automation client as a source for all the events that come from this . + The that is the source of events. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the accelerator key combinations for the element that is associated with the UI Automation peer. + The accelerator key. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The accelerator key. + + + + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the access key for the element that is associated with the automation peer. + The string that contains the access key. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The string that contains the access key. + + + + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationControlType + + + + Gets the control type for the element that is associated with the UI Automation peer. + The control type. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationControlType + + + + When overridden in a derived class, is called by . + The control type. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the of the element that is associated with the automation peer. + The identifier. + + property. If that property is not set, the value is the property. + + ]]> + + A public call to this method is currently in progress. + + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The string that contains the identifier. + + property. If that property is not set, the value is the property. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Rect + + + + Gets the object that represents the screen coordinates of the element that is associated with the automation peer. + The bounding rectangle. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Rect + + + + When overridden in a derived class, is called by . + The bounding rectangle. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + Gets the collection of elements that are represented in the UI Automation tree as immediate child elements of the automation peer. + The collection of child elements. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + When overridden in a derived class, is called by . + The collection of child elements. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a name that is used with , to differentiate the control that is represented by this . + The class name. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The class name. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + Gets a on the element that is associated with the automation peer that responds to a mouse click. + A point in the clickable area of the element. + + , a clickable point is any point in the visible client area of the that issues the command that the button represents when it is clicked by the mouse. + + ]]> + + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + When overridden in a derived class, is called by . + A point within the clickable area of the element. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + Provides UI Automation with a list of elements affected or controlled by this . + A list of automation peers for the controlled elements. + To be added. + A public call to this method is currently in progress. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + When overridden in a derived class, provides UI Automation with a list of elements affected or controlled by this . + A list of automation peers for the controlled elements. + To be added. + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + + + Attempt to get the value for the HeadingLevel property. + The value for the HeadingLevel property. + + + + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + + + Override this method to provide UIAutomation with the heading level of this element. + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets text that describes the functionality of the control that is associated with the automation peer. + The help text. + + + + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The help text. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + + System.Windows.Automation.Peers.HostedWindowWrapper + + + + Tells UI Automation where in the UI Automation tree to place the being hosted by a Windows Presentation Foundation (WPF) element. + This method returns the hosted to UI Automation for controls that host objects. + + that is associated with an element that immediately hosts an `hwnd` must override this method. + + If this method is not overridden, UI Automation places the `hwnd` as a child element of the that hosts the whole application. Typically, you want to override this default behavior and set UI Automation to position the hosted `hwnd` parallel to the place where it is located in the Windows Presentation Foundation (WPF) logical tree. + + Except in hosting scenarios, do not allow types to override this method. + + In addition to overriding this method, the types that are associated with an element that immediately hosts an `hwnd` must return the that is cast to in response to WM_GETOBJECT coming to the hosted `hwnd`. + + To get a pointer to , call . + + ]]> + + UI Automation Overview + UI Automation Tree Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets text that conveys the visual status of the element that is associated with this automation peer. + The status. + + + + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The status. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a string that describes what kind of item an object represents. + The kind of item. + + + + A public call to this method is currently in progress. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The kind of item. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Gets the for the that is targeted to the element. + The for the element that is targeted by the . + + control, the method gets the for the that is associated with the . + + In the following image, the "Themes" is targeted to the ; therefore the for the also targets the . When the user presses **ALT**+**T**, the gets focus instead of the . + + ![Display properties shows labeled by usage](~/add/media/labeledby.JPG "Display properties shows labeled by usage") + + The method for returns the for the corresponding . This enables an automation client to get the text string that describes the . + + ]]> + + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + When overridden in a derived class, is called by . + The for the element that is targeted by the . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationLiveSetting + + + + Gets the notification characteristics of a live region that is associated with this automation peer. + The notification characteristics. + + . + +]]> + + A public call to this method is currently in progress. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationLiveSetting + + + + When overridden in a derived class, returns the notification characteristics of a live region. Called by the method. + The notification characteristics of a live region. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a human-readable localized string that represents the value for the control that is associated with this automation peer. + The type of the control. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The type of the control. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets text that describes the element that is associated with this automation peer. + The name. + + . + + ]]> + + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + When overridden in a derived class, is called by . + The string that contains the label. + + control that lets users select a color might return "Colors". + + Make sure that you have assigned a name to all controls in the graphical user interface (GUI) so that accessibility tools such as screen readers can refer to each control in a localized manner. + + ]]> + + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationOrientation + + + + Gets a value that indicates the explicit control orientation, if any. + The orientation of the control. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationOrientation + + + + When overridden in a derived class, is called by . + The orientation of the control. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Gets the that is the parent of this . + The parent automation peer. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + A value from the enumeration. + When overridden in a derived class, gets the control pattern that is associated with the specified . + The object that implements the pattern interface; if this peer does not support this interface. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The position on the screen to get the from. + Gets an from the specified point. + The at the specified point. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The position on the screen to get the from. + When overridden in a derived class, is called from . + The at the specified point. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Attempts to get the value of the property. + The value of the property. + A public call to this method cannot be attempted if another public call is in progress. + A public call to this method is currently in progress. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + When overridden in a derived class, provides UI Automation with a one-based integer value that describes the position this element occupies in a group or set. + A one-based integer value that describes the position this element occupies in a group or set. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Attempts to get the value of the property. + The value of the property. + A public call to this method cannot be attempted if another public call is in progress. + A public call to this method is currently in progress. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + When overridden in a derived class, provides UI Automation with the size of the group or set that this element belongs to. + An integer value that describes the size of the group or set that this element belongs to. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. + + if the element has keyboard focus; otherwise, . + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element has keyboard focus; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Triggers recalculation of the main properties of the and raises the notification to the Automation Client if the properties changed. + + and . + + Typically, updates and notifications happen automatically after the update of the layout in Windows Presentation Foundation (WPF). (The update occurs in response to the event.) Sometimes, however, properties change without raising the event. For example, when the whole moves, the event is not raised. In this example, the set of objects change because the objects are expressed in screen coordinates. Therefore, the must call on its peer on . + + ]]> + + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user. + + if the element is a content element; otherwise, . + + + + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element is a content element; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI. + + if the element is a control; otherwise, . + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element is a control; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Boolean + + + + Attempt to get the value for the IsDialog property. + The value for the IsDialog property. + + + + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element associated with this automation peer supports interaction. + + if the element supports interaction; otherwise, . + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the automation peer can receive and send events; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the element that is associated with this hosts in Windows Presentation Foundation (WPF). + + if the element that is associated with this hosts in Windows Presentation Foundation (WPF); otherwise, . + + and . + + These peers must also override . + + ]]> + + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element can accept keyboard focus. + + if the element can accept keyboard focus; otherwise, . + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element can accept keyboard focus; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether an element is off the screen. + + if the element is not on the screen; otherwise, . + + + + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element is not on the screen; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element contains sensitive content. + + if the element contains sensitive content such as a password; otherwise, . + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element contains sensitive content; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the element that is associated with this peer must be completed on a form. + + if the element must be completed; otherwise, . + To be added. + A public call to this method is currently in progress. + + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + When overridden in a derived class, is called by . + + if the element is must be completed; otherwise, . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + One of the enumeration values. + Gets a value that indicates whether UI Automation is listening for the specified event. + A that indicates whether UI Automation is listening for the event. + + that raises the event. This method is a performance measure because if UI Automation does not listen for the event, it does not make sense to create a peer to raise one. + +> [!NOTE] +> This method is static and only answers if a delegate listens for the specified event in UI Automation, not for an event on a specific element. UI Automation can create broadcast listeners; therefore the per-element information is irrelevant. + + ]]> + + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The class that implements . + Gets an for the specified proxy. + An for the specified proxy. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Provider.IRawElementProviderSimple + + + + + + The automation peer. + Gets the for the specified . + The proxy. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The event data. + Called by the to raise the event. + To be added. + + is . + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The event identifier. + Raises an automation event. + To be added. + UI Automation Overview + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Void + + + + + + + + + To be added. + To be added. + To be added. + To be added. + This method is called by implementation of the peer to raise the automation "notification" event + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + + The property that changed. + The previous value of the property. + The new value of the property. + Raises an event to notify the automation client of a changed property value. + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 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.Void + + + + Synchronously resets the tree of child elements by calling . + + , which can change the child elements of the peer by moving the . + + ]]> + + UI Automation Overview + UI Automation Control Patterns Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Sets the keyboard focus on the element that is associated with this automation peer. + To be added. + A public call to this method is currently in progress. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + When overridden in a derived class, is called by . + To be added. + UI Automation Overview + Server-side UI Automation Provider Implementation + + + + diff --git a/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml b/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml index 1b0ca1744c1..2af182f271d 100644 --- a/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml @@ -1,953 +1,955 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Exposes types to UI Automation. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The that is associated with this . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The that is associated with this . - Creates a for the specified . - The for the specified . - - remains in memory until the associated is destroyed. - - The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The that is associated with this . - Gets the for the specified . - The for the specified , or if the has not been created by the method. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the accelerator key for the element associated with this . Called by . - An string. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the access key for the that is associated with this . Called by . - The access key for this . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 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 . Called by . - The enumeration value. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the string that uniquely identifies the that is associated with this . Called by . - A string containing the automation identifier. - - property, and if that isn't set, it's the property. - - ]]> - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Rect - - - - Gets the representing the bounding rectangle of the that is associated with this . Called by . - The bounding rectangle. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - Gets the collection of child elements of the that is associated with this . Called by . - The collection of child elements. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the name of the that is associated with this . Called by . - An string. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - Gets a that represents the clickable space that is on the that is associated with this . Called by . - The point that represents the clickable space that is on the element. - - , the clickable point is any point that is within the visible client area of the that would result in issuing the command that the button represents, when the user clicks the by using the mouse. - - ]]> - - - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the string that describes the functionality of the that is associated with this . Called by . - The string that describes the functionality of the that is associated with this . - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a string that conveys the visual status of the that is associated with this . Called by . - A string containing the status. - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a human-readable string that contains the type of the item that the that is associated with this represents. Called by . - The string that contains the item type. - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Gets the for the that is targeted to the that is associated with this . Called by . - The for the element that is targeted by the . - - control, the method could get the for the that is associated with the . - - ]]> - - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationLiveSetting - - - - Gets the notification characteristics of the live region of the that is associated with this . Called by . - The notification characteristics of the live region. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the text label of the that is associated with this . Called by . - The string that contains the label. - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationOrientation - - - - Gets a value that indicates whether the that is associated with this is laid out in a specific direction. Called by . - The enumeration value. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - One of the enumeration values. - Gets the control pattern for the that is associated with this . - An object that implements the interface if is ; otherwise, . - To be added. - UI Automation Control Patterns - UI Automation Text Pattern - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Reads and returns the value of the PositionInSet attached property. - The value of UI Automation's PositionInSet attached property. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Reads and returns the value of the SizeOfSet attached property. - The value of UI Automation's SizeOfSet attached property. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this currently has keyboard input focus. Called by . - - if the element has keyboard input focus; otherwise, . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this is an element that contains data that is presented to the user. Called by . - - . - To be added. - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this is something that the end user would understand as being interactive or as contributing to the logical structure of the control in the GUI. Called by . - - . - To be added. - - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Boolean - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether this automation peer can receive and send events to the associated element. Called by . - - if the automation peer can receive and send events; otherwise, . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this can accept keyboard focus. Called by . - - . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether that is associated with this is off of the screen. Called by . - - if the element is not on the screen; otherwise, . - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this contains protected content. Called by . - - . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this is required to be filled out on a form. Called by . - - . - To be added. - - - - - - - - - - - Property - - PresentationCore - 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.ContentElement - - - Gets the that is associated with this . - The that is associated with this . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Sets the keyboard input focus on the that is associated with this . Called by . - To be added. - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Exposes types to UI Automation. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The that is associated with this . + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The that is associated with this . + Creates a for the specified . + The for the specified . + + remains in memory until the associated is destroyed. + + The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The that is associated with this . + Gets the for the specified . + The for the specified , or if the has not been created by the method. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the accelerator key for the element associated with this . Called by . + An string. + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the access key for the that is associated with this . Called by . + The access key for this . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 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 . Called by . + The enumeration value. + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the string that uniquely identifies the that is associated with this . Called by . + A string containing the automation identifier. + + property, and if that isn't set, it's the property. + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Rect + + + + Gets the representing the bounding rectangle of the that is associated with this . Called by . + The bounding rectangle. + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + Gets the collection of child elements of the that is associated with this . Called by . + The collection of child elements. + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the name of the that is associated with this . Called by . + An string. + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + Gets a that represents the clickable space that is on the that is associated with this . Called by . + The point that represents the clickable space that is on the element. + + , the clickable point is any point that is within the visible client area of the that would result in issuing the command that the button represents, when the user clicks the by using the mouse. + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + + + Provides a value for UIAutomation's HeadingLevel property Reads and returns the value + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the string that describes the functionality of the that is associated with this . Called by . + The string that describes the functionality of the that is associated with this . + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a string that conveys the visual status of the that is associated with this . Called by . + A string containing the status. + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a human-readable string that contains the type of the item that the that is associated with this represents. Called by . + The string that contains the item type. + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Gets the for the that is targeted to the that is associated with this . Called by . + The for the element that is targeted by the . + + control, the method could get the for the that is associated with the . + + ]]> + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationLiveSetting + + + + Gets the notification characteristics of the live region of the that is associated with this . Called by . + The notification characteristics of the live region. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the text label of the that is associated with this . Called by . + The string that contains the label. + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationOrientation + + + + Gets a value that indicates whether the that is associated with this is laid out in a specific direction. Called by . + The enumeration value. + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + One of the enumeration values. + Gets the control pattern for the that is associated with this . + An object that implements the interface if is ; otherwise, . + To be added. + UI Automation Control Patterns + UI Automation Text Pattern + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Reads and returns the value of the PositionInSet attached property. + The value of UI Automation's PositionInSet attached property. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Reads and returns the value of the SizeOfSet attached property. + The value of UI Automation's SizeOfSet attached property. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this currently has keyboard input focus. Called by . + + if the element has keyboard input focus; otherwise, . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this is an element that contains data that is presented to the user. Called by . + + . + To be added. + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this is something that the end user would understand as being interactive or as contributing to the logical structure of the control in the GUI. Called by . + + . + To be added. + + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Boolean + + + + + + + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether this automation peer can receive and send events to the associated element. Called by . + + if the automation peer can receive and send events; otherwise, . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this can accept keyboard focus. Called by . + + . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether that is associated with this is off of the screen. Called by . + + if the element is not on the screen; otherwise, . + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this contains protected content. Called by . + + . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this is required to be filled out on a form. Called by . + + . + To be added. + + + + + + + + + + + Property + + PresentationCore + 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.ContentElement + + + Gets the that is associated with this . + The that is associated with this . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Sets the keyboard input focus on the that is associated with this . Called by . + To be added. + + + + + diff --git a/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml b/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml index c18061a8c26..ecec8f34684 100644 --- a/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml @@ -1,1136 +1,1136 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Exposes types to UI Automation. - - uses to communicate with UI Automation. - - If you create a class that inherits from , you may want to provide an automation peer to support the functionality of your class. Override the method to return a string that represents the type of the element associated with the . For example, if you create a class called `My3DElement` and an automation peer called `My3DElementAutomationPeer`, override the method to return the string "My3DElement". - - If your class matches one of the known control types, override the method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . - - The behavior of your custom determines what other methods you should override. Each method topic in the describes how the method is used and when it is appropriate to override it. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The that is associated with this . - Initializes a new instance of the class. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The that is associated with this . - Creates a for the specified . - A for the specified . - - remains in memory until the associated is destroyed. - - The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The that is associated with this . - Returns the for the specified . - The , or if the was not created by the method. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the accelerator key for the that is associated with this . This method is called by . - The accelerator key for the that is associated with this . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide the accelerator key in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the access key for the that is associated with this . This method is called by . - The access key for the that is associated with this . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide the access key in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationControlType - - - - Returns the control type for the that is associated with this . This method is called by . - - in all cases. - - method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the string that uniquely identifies the that is associated with this . This method is called by . - The string that uniquely identifies the that is associated with this . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide an identifier in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Rect - - - - Returns the that represents the bounding rectangle of the that is associated with this . This method is called by . - The that contains the coordinates of the element. - - and a , this method returns . - - Classes that inherit from typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - Returns the collection of child elements of the that is associated with this . This method is called by . - The elements than correspond to the child elements of the . - - typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the name of the that is associated with this . This method is called by . - - in all cases. - - must override this method to return the name of the that is associated with the . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - Returns a that represents the clickable space that is on the that is associated with this . This method is called by . - The on the element that allows a click. The point values are (, ) if the element is not both a and a . - - method returns the point that represents the center of the . Override if you want to return a different point. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the string that describes the functionality of the that is associated with this . This method is called by . - A string that describes the functionality of the that is associated with this . - - method returns a string that is the same text that the control provides in the tooltip. This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the help text in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns a string that communicates the status of the that is associated with this . This method is called by . - The status of the that is associated with this . - - is conveying status about an item. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected". - - This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the item status in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns a human-readable string that represents the item type that the for this . This method is called by . - A string that represents the item type that the for this . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide the item type in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Returns the for the element that targets the for this . This method is called by . - The for the element that targets the for this . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide the in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationLiveSetting - - - - Gets the notification characteristics of the live region of the object that is associated with this . This method is called by . - The notification characteristics of the live region. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the string that represents the that is associated with this . This method is called by . - The string that represents the that is associated with this . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide a name in a way that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationOrientation - - - - Returns the orientation of the that is associated with this . This method is called by . - - in all cases. - - can be either horizontally or vertically oriented, override this method to return the current orientation of the . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - One of the enumeration values. - Returns the control pattern for the that is associated with this . - An object that implements the interface if is ; otherwise, . - - method to return control patterns that apply to your . For more information, see [UI Automation Control Patterns Overview](/dotnet/framework/ui-automation/ui-automation-control-patterns-overview). - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Reads and returns the value of the PositionInSet attached property. - The value of UI Automation's PositionInSet attached property. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Provides a value for UI Automation's SizeOfSet property. - Reads and returns the value. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this currently has keyboard input focus. This method is called by . - - if the element has keyboard input focus; otherwise, . - - typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this is an element that contains data that is presented to the user. This method is called by . - - in all cases. - - method if your is not a content element. A content element contains data that is presented to the user. An example of a content element is an item in a list box or a button on a dialog box. You typically use non-content elements, which are also called peripheral elements, to manipulate the content in a composite control. An example of a non-content element is the button on a drop-down control. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this is understood by the end user as interactive. Optionally, the user might understand the as contributing to the logical structure of the control in the GUI. This method is called by . - - in all cases. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Boolean - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this can participate in hit testing or accept focus. This method is called by . - - if the that is associated with this can participate in hit testing or accept focus; otherwise, . - - typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this can accept keyboard focus. This method is called by . - - if the element can receive keyboard focus; otherwise, . - - typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this is off the screen. This method is called by . - - if the element is not on the screen; otherwise, . - - typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this contains protected content. This method is called by . - - in all cases. - - if your contains protected content, such as a password. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Returns a value that indicates whether the that is associated with this is required to be completed on a form. This method is called by . - - if the is required to be completed on a form; otherwise, . - - method to get the value. returns a value only when the property is set. You can override and add logic to provide a value that makes sense for your . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.UIElement3D - - - Gets the that is associated with this . - The that is associated with this . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Sets the keyboard input focus on the that is associated with this . This method is called by . - - typically do not need to override . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - ]]> - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Exposes types to UI Automation. + + uses to communicate with UI Automation. + + If you create a class that inherits from , you may want to provide an automation peer to support the functionality of your class. Override the method to return a string that represents the type of the element associated with the . For example, if you create a class called `My3DElement` and an automation peer called `My3DElementAutomationPeer`, override the method to return the string "My3DElement". + + If your class matches one of the known control types, override the method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . + + The behavior of your custom determines what other methods you should override. Each method topic in the describes how the method is used and when it is appropriate to override it. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The that is associated with this . + Initializes a new instance of the class. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The that is associated with this . + Creates a for the specified . + A for the specified . + + remains in memory until the associated is destroyed. + + The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The that is associated with this . + Returns the for the specified . + The , or if the was not created by the method. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the accelerator key for the that is associated with this . This method is called by . + The accelerator key for the that is associated with this . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide the accelerator key in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the access key for the that is associated with this . This method is called by . + The access key for the that is associated with this . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide the access key in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationControlType + + + + Returns the control type for the that is associated with this . This method is called by . + + in all cases. + + method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the string that uniquely identifies the that is associated with this . This method is called by . + The string that uniquely identifies the that is associated with this . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide an identifier in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Rect + + + + Returns the that represents the bounding rectangle of the that is associated with this . This method is called by . + The that contains the coordinates of the element. + + and a , this method returns . + + Classes that inherit from typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + Returns the collection of child elements of the that is associated with this . This method is called by . + The elements than correspond to the child elements of the . + + typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the name of the that is associated with this . This method is called by . + + in all cases. + + must override this method to return the name of the that is associated with the . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + Returns a that represents the clickable space that is on the that is associated with this . This method is called by . + The on the element that allows a click. The point values are (, ) if the element is not both a and a . + + method returns the point that represents the center of the . Override if you want to return a different point. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + + + Provides a value for UIAutomation's HeadingLevel property Reads and returns the value + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the string that describes the functionality of the that is associated with this . This method is called by . + A string that describes the functionality of the that is associated with this . + + method returns a string that is the same text that the control provides in the tooltip. This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the help text in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns a string that communicates the status of the that is associated with this . This method is called by . + The status of the that is associated with this . + + is conveying status about an item. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected". + + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the item status in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns a human-readable string that represents the item type that the for this . This method is called by . + A string that represents the item type that the for this . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide the item type in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Returns the for the element that targets the for this . This method is called by . + The for the element that targets the for this . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide the in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationLiveSetting + + + + Gets the notification characteristics of the live region of the object that is associated with this . This method is called by . + The notification characteristics of the live region. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the string that represents the that is associated with this . This method is called by . + The string that represents the that is associated with this . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide a name in a way that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationOrientation + + + + Returns the orientation of the that is associated with this . This method is called by . + + in all cases. + + can be either horizontally or vertically oriented, override this method to return the current orientation of the . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + One of the enumeration values. + Returns the control pattern for the that is associated with this . + An object that implements the interface if is ; otherwise, . + + method to return control patterns that apply to your . For more information, see [UI Automation Control Patterns Overview](/dotnet/framework/ui-automation/ui-automation-control-patterns-overview). + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Reads and returns the value of the PositionInSet attached property. + The value of UI Automation's PositionInSet attached property. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Provides a value for UI Automation's SizeOfSet property. + Reads and returns the value. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this currently has keyboard input focus. This method is called by . + + if the element has keyboard input focus; otherwise, . + + typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this is an element that contains data that is presented to the user. This method is called by . + + in all cases. + + method if your is not a content element. A content element contains data that is presented to the user. An example of a content element is an item in a list box or a button on a dialog box. You typically use non-content elements, which are also called peripheral elements, to manipulate the content in a composite control. An example of a non-content element is the button on a drop-down control. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this is understood by the end user as interactive. Optionally, the user might understand the as contributing to the logical structure of the control in the GUI. This method is called by . + + in all cases. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this can participate in hit testing or accept focus. This method is called by . + + if the that is associated with this can participate in hit testing or accept focus; otherwise, . + + typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this can accept keyboard focus. This method is called by . + + if the element can receive keyboard focus; otherwise, . + + typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this is off the screen. This method is called by . + + if the element is not on the screen; otherwise, . + + typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this contains protected content. This method is called by . + + in all cases. + + if your contains protected content, such as a password. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Returns a value that indicates whether the that is associated with this is required to be completed on a form. This method is called by . + + if the is required to be completed on a form; otherwise, . + + method to get the value. returns a value only when the property is set. You can override and add logic to provide a value that makes sense for your . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.UIElement3D + + + Gets the that is associated with this . + The that is associated with this . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Sets the keyboard input focus on the that is associated with this . This method is called by . + + typically do not need to override . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + ]]> + + + + + diff --git a/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml b/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml index 508febe36cd..c0e980ef04b 100644 --- a/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml @@ -1,931 +1,931 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Exposes types to UI Automation. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The that is associated with this . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The that is associated with this . - Creates a for the specified . - The created for the specified . - - remains in memory until the associated is destroyed. - - The same instance of the is returned from subsequent calls to this method and calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created, and this method returns `null`. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - - - The that is associated with this . - Gets the for the specified . - The ; or , if the was not created by the method. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the accelerator key for the that is associated with this . This method is called by . - The that is returned by . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the access key for the that is associated with this . This method is called by . - The access key for the that is associated with this . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 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 - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the string that uniquely identifies the that is associated with this . This method is called by . - The that is returned by . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - - System.Windows.Rect - - - - Gets the that represents the bounding rectangle of the that is associated with this . This method is called by . - The that contains the coordinates of the element. Optionally, if the element is not both a and a , this method returns . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> - - - - Gets the collection of child elements of the that is associated with this . This method is called by . - A list of child elements. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the name of the that is associated with this . This method is called by . - An string. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - - System.Windows.Point - - - - Gets a that represents the clickable space that is on the that is associated with this . This method is called by . - The on the element that allows a click. The point values are (, ) if the element is not both a and a . - To be added. - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the string that describes the functionality of the that is associated with this . This method is called by . - The string that contains the that is returned by . - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a string that communicates the visual status of the that is associated with this . This method is called by . - The string that contains the that is returned by . - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets a human-readable string that contains the item type that the for this represents. This method is called by . - The string that contains the that is returned by . - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationPeer - - - - Gets the for the element that is targeted to the for this . This method is called by . - The for the element that is targeted to the for this . - - can be a , but it does not have to be. If it is a , setting the property will automatically set the property as well. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationLiveSetting - - - - Gets the notification characteristics of the live region of the object that is associated with this . This method is called by . - The notification characteristics of the live region. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Gets the text label of the that is associated with this . This method is called by . - The string that contains the that is returned by . - - property functions similar to a string of text that users use to explain the control they are referring to. Make certain that you have a textual representation for all controls in the graphical user interface (GUI) so that you can programmatically refer to the control in a localized manner. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.Peers.AutomationOrientation - - - - Gets a value that indicates whether the that is associated with this is laid out in a specific direction. This method is called by . - The enumeration value. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - A value from the enumeration. - Gets the control pattern for the that is associated with this . - An object that implements the interface if is ; otherwise, . - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Reads and returns the value of the PositionInSet attached property. - The value of UI Automation's PositionInSet attached property. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Provides a value for UI Automation's SizeOfSet property. - Reads and returns the value. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this currently has keyboard input focus. This method is called by . - - if the element has keyboard input focus; otherwise, . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this is an element that contains data that is presented to the user. This method is called by . - - . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets or sets a value that indicates whether the that is associated with this is understood by the end user as interactive. Optionally, the user might understand the as contributing to the logical structure of the control in the GUI. This method is called by . - - . - To be added. - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Boolean - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this can accept keyboard focus. This method is called by . - A that contains the value of . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this can accept keyboard focus. This method is called by . - - if the element is focusable by the keyboard; otherwise . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this is off the screen. This method is called by . - - if the element is not on the screen; otherwise, . - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this contains protected content. This method is called by . - - . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the that is associated with this is required to be completed on a form. This method is called by . - A that contains the value that is returned by , if it's set; otherwise . - To be added. - - - - - - - - - - Property - - PresentationCore - 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.UIElement - - - Gets the that is associated with this . - The that is associated with this . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Sets the keyboard input focus on the that is associated with this . This method is called by . - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Exposes types to UI Automation. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The that is associated with this . + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The that is associated with this . + Creates a for the specified . + The created for the specified . + + remains in memory until the associated is destroyed. + + The same instance of the is returned from subsequent calls to this method and calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created, and this method returns `null`. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + + + The that is associated with this . + Gets the for the specified . + The ; or , if the was not created by the method. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the accelerator key for the that is associated with this . This method is called by . + The that is returned by . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the access key for the that is associated with this . This method is called by . + The access key for the that is associated with this . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 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 + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the string that uniquely identifies the that is associated with this . This method is called by . + The that is returned by . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + + System.Windows.Rect + + + + Gets the that represents the bounding rectangle of the that is associated with this . This method is called by . + The that contains the coordinates of the element. Optionally, if the element is not both a and a , this method returns . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.List<System.Windows.Automation.Peers.AutomationPeer> + + + + Gets the collection of child elements of the that is associated with this . This method is called by . + A list of child elements. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the name of the that is associated with this . This method is called by . + An string. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + + System.Windows.Point + + + + Gets a that represents the clickable space that is on the that is associated with this . This method is called by . + The on the element that allows a click. The point values are (, ) if the element is not both a and a . + To be added. + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + + + Provides a value for UIAutomation's HeadingLevel property Reads and returns the value + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the string that describes the functionality of the that is associated with this . This method is called by . + The string that contains the that is returned by . + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a string that communicates the visual status of the that is associated with this . This method is called by . + The string that contains the that is returned by . + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets a human-readable string that contains the item type that the for this represents. This method is called by . + The string that contains the that is returned by . + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationPeer + + + + Gets the for the element that is targeted to the for this . This method is called by . + The for the element that is targeted to the for this . + + can be a , but it does not have to be. If it is a , setting the property will automatically set the property as well. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationLiveSetting + + + + Gets the notification characteristics of the live region of the object that is associated with this . This method is called by . + The notification characteristics of the live region. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Gets the text label of the that is associated with this . This method is called by . + The string that contains the that is returned by . + + property functions similar to a string of text that users use to explain the control they are referring to. Make certain that you have a textual representation for all controls in the graphical user interface (GUI) so that you can programmatically refer to the control in a localized manner. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.Peers.AutomationOrientation + + + + Gets a value that indicates whether the that is associated with this is laid out in a specific direction. This method is called by . + The enumeration value. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + A value from the enumeration. + Gets the control pattern for the that is associated with this . + An object that implements the interface if is ; otherwise, . + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Reads and returns the value of the PositionInSet attached property. + The value of UI Automation's PositionInSet attached property. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Provides a value for UI Automation's SizeOfSet property. + Reads and returns the value. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this currently has keyboard input focus. This method is called by . + + if the element has keyboard input focus; otherwise, . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this is an element that contains data that is presented to the user. This method is called by . + + . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets or sets a value that indicates whether the that is associated with this is understood by the end user as interactive. Optionally, the user might understand the as contributing to the logical structure of the control in the GUI. This method is called by . + + . + To be added. + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this can accept keyboard focus. This method is called by . + A that contains the value of . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this can accept keyboard focus. This method is called by . + + if the element is focusable by the keyboard; otherwise . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this is off the screen. This method is called by . + + if the element is not on the screen; otherwise, . + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this contains protected content. This method is called by . + + . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the that is associated with this is required to be completed on a form. This method is called by . + A that contains the value that is returned by , if it's set; otherwise . + To be added. + + + + + + + + + + Property + + PresentationCore + 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.UIElement + + + Gets the that is associated with this . + The that is associated with this . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Sets the keyboard input focus on the that is associated with this . This method is called by . + To be added. + + + + diff --git a/xml/System.Windows.Automation/AutomationHeadingLevel.xml b/xml/System.Windows.Automation/AutomationHeadingLevel.xml index b7a90b3592b..0fcce87bd32 100644 --- a/xml/System.Windows.Automation/AutomationHeadingLevel.xml +++ b/xml/System.Windows.Automation/AutomationHeadingLevel.xml @@ -1,221 +1,221 @@ - - - - - - - - - PresentationCore - 6.0.0.0 - - - System.Enum - - - To be added. - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 1 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 2 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 3 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 4 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 5 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 6 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 7 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 8 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 9 - - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - 0 - - To be added. - - - - + + + + + + + + + PresentationCore + 6.0.0.0 + + + System.Enum + + + Describes the heading level of a control + To be added. + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 1 + + The element has a heading level of 1 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 2 + + The element has a heading level of 2 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 3 + + The element has a heading level of 3 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 4 + + The element has a heading level of 4 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 5 + + The element has a heading level of 5 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 6 + + The element has a heading level of 6 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 7 + + The element has a heading level of 7 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 8 + + The element has a heading level of 8 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 9 + + The element has a heading level of 9 + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + 0 + + The element does not have a heading level + + + + diff --git a/xml/System.Windows.Automation/AutomationProperties.xml b/xml/System.Windows.Automation/AutomationProperties.xml index 9a180b4d5a5..757e3150ed2 100644 --- a/xml/System.Windows.Automation/AutomationProperties.xml +++ b/xml/System.Windows.Automation/AutomationProperties.xml @@ -1,1949 +1,1967 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Provides a means of getting or setting the value of the associated properties of the instance of the element. - To be added. - UI Automation Properties Overview - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the accelerator key for the specified element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the access key for the specified element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or set the string that uniquely identifies the specified element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - A string that contains the accelerator key. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - The access key for the specified element. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - The UI Automation identifier for the specified element. - - property isn't set, this method returns the property. - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Windows.Automation.AutomationHeadingLevel - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - A string containing the help text for the specified element. The string that is returned generally is the same text that is provided in the tooltip for the control. - To be added. - - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The to check. - Gets the attached property for the specified . - A that indicates whether the specified element is a . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.IsOffscreenBehavior - - - - - - The to check. - Gets the attached property for the specified . - A value that specifies how an element determines how the property is determined. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The to check. - Gets the attached property for the specified . - A that indicates whether the specified element is . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The to check. - Gets the attached property for the specified . - A that indicates whether the specified element is a . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - The of the given element. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - The of the given element. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.UIElement - - - - - - The to check. - Gets the attached property for the specified . - The element that is targeted by the label. - To be added. - - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Automation.AutomationLiveSetting - - - - - - The to check. - Gets the attached property for the specified . - The value for the . - To be added. - - is . - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - - - The to check. - Gets the attached property for the specified . - The name of the specified element. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - The dependency object on which to get the property value. - Gets the value of the property for the specified . - The value of the attached property of . - - property defines the ordinal position of the element within a set of elements that are considered to be siblings. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - The dependency object on which to get the property value. - Gets the value of the attached property for the specified . - The value of the attached property of . - - property gets or sets the count of automation elements in a group or set that are considered to be siblings. - - ]]> - - - - - - - - - - AttachedProperty - - PresentationCore - 6.0.0.0 - - - To be added. - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.DependencyProperty - - - To be added. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the help text for the specified element. The help text generally is the same text that is provided in the tooltip for the control. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Support for the ToolTip Control Type - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a value indicating whether the specified element is a column header. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - Expose the Content of a Table Using UI Automation - Implementing the UI Automation Table Control Pattern - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 6.0.0.0 - - - To be added. - To be added. - - - - - - - - - - Field - - PresentationCore - 6.0.0.0 - - - System.Windows.DependencyProperty - - - To be added. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a value that specifies how the property is determined. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - - - - - - - - - - Field - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the dependency property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a value that indicates whether the specified element is required to be filled out on a form. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a value indicating whether the specified element is a row header. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a description of the status of an item within an element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a description of the type of the specified element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the element that contains the text label for the specified element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - UI Automation Support for the Edit Control Type - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets a value that describes the notification characteristics of a particular live region. - - . - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - - - - - - - - - - Field - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the name of the element. - - -## Dependency Property Information - -||| -|-|-| -|Identifier field|| -|Metadata properties set to `true`|None| - - ]]> - - UI Automation Properties Overview - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the attached property. - To be added. - - - - - - - - - AttachedProperty - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the ordinal location of this element within a set of elements that are considered to be siblings. - - dependency property to describe the ordinal position of this element in the set. - - ]]> - - - - - - - - - - - Field - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the PositionInSet attached property. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The accelerator key value to set. - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The access key value to set. - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The UI Automation identifier value to set. - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The help text value to set. - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The value to set; if the element is meant to be a column header, otherwise . - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - A value that specifies how an element determines how the property is determined. - Sets the attached property for the specified . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The value to set; if the element is meant to be required to be filled out on a form, otherwise . - Sets the attached property for the specified . - To be added. - - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The value to set; if the element is meant to be a row header, otherwise . - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The item status value to set. - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The item type value to set. - Sets the attached property for the specified . - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The labeled by value to set. - Sets the attached property. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The to check. - The value to assign to the property. - Sets the attached property for the specified . - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The on which to set the property. - The name value to set. - Sets the attached property. - To be added. - UI Automation Properties Overview - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The dependency object on which to set the property. - The value to set. - Sets the attached property for the specified . - - property gets or sets the ordinal position of the element within a set of elements that are considered to be siblings. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The dependency object on which to set the property. - The value to set. - Sets the attached property for the specified . - - property gets or sets the count of automation elements in a group or set that are considered to be siblings. - - ]]> - - - - - - - - - - AttachedProperty - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - Gets or sets the count of automation elements in a group or set that are considered to be siblings. - - | -|Metadata properties set to `true`|None| - - ]]> - - - - - - - - - - - Field - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.DependencyProperty - - - Identifies the SizeOfSet attached property. - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Provides a means of getting or setting the value of the associated properties of the instance of the element. + To be added. + UI Automation Properties Overview + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the accelerator key for the specified element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the access key for the specified element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or set the string that uniquely identifies the specified element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + A string that contains the accelerator key. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + The access key for the specified element. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + The UI Automation identifier for the specified element. + + property isn't set, this method returns the property. + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Windows.Automation.AutomationHeadingLevel + + + + + + To be added. + Helper for reading HeadingLevel property from a DependencyObject. + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + A string containing the help text for the specified element. The string that is returned generally is the same text that is provided in the tooltip for the control. + To be added. + + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The to check. + Gets the attached property for the specified . + A that indicates whether the specified element is a . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Boolean + + + + + + To be added. + Helper for reading IsDialog property from a DependencyObject. + To be added. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.IsOffscreenBehavior + + + + + + The to check. + Gets the attached property for the specified . + A value that specifies how an element determines how the property is determined. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The to check. + Gets the attached property for the specified . + A that indicates whether the specified element is . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The to check. + Gets the attached property for the specified . + A that indicates whether the specified element is a . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + The of the given element. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + The of the given element. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.UIElement + + + + + + The to check. + Gets the attached property for the specified . + The element that is targeted by the label. + To be added. + + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Automation.AutomationLiveSetting + + + + + + The to check. + Gets the attached property for the specified . + The value for the . + To be added. + + is . + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + + + The to check. + Gets the attached property for the specified . + The name of the specified element. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + The dependency object on which to get the property value. + Gets the value of the property for the specified . + The value of the attached property of . + + property defines the ordinal position of the element within a set of elements that are considered to be siblings. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + The dependency object on which to get the property value. + Gets the value of the attached property for the specified . + The value of the attached property of . + + property gets or sets the count of automation elements in a group or set that are considered to be siblings. + + ]]> + + + + + + + + + + AttachedProperty + + PresentationCore + 6.0.0.0 + + + To be added. + To be added. + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.DependencyProperty + + + To be added. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the help text for the specified element. The help text generally is the same text that is provided in the tooltip for the control. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Support for the ToolTip Control Type + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a value indicating whether the specified element is a column header. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + Expose the Content of a Table Using UI Automation + Implementing the UI Automation Table Control Pattern + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 6.0.0.0 + + + To be added. + To be added. + + + + + + + + + + Field + + PresentationCore + 6.0.0.0 + + + System.Windows.DependencyProperty + + + To be added. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a value that specifies how the property is determined. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + + + + + + + + + + Field + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the dependency property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a value that indicates whether the specified element is required to be filled out on a form. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a value indicating whether the specified element is a row header. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a description of the status of an item within an element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a description of the type of the specified element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the element that contains the text label for the specified element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + UI Automation Support for the Edit Control Type + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets a value that describes the notification characteristics of a particular live region. + + . + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + + + + + + + + + + Field + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the name of the element. + + +## Dependency Property Information + +||| +|-|-| +|Identifier field|| +|Metadata properties set to `true`|None| + + ]]> + + UI Automation Properties Overview + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the attached property. + To be added. + + + + + + + + + AttachedProperty + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the ordinal location of this element within a set of elements that are considered to be siblings. + + dependency property to describe the ordinal position of this element in the set. + + ]]> + + + + + + + + + + + Field + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the PositionInSet attached property. + + + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The accelerator key value to set. + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The access key value to set. + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The UI Automation identifier value to set. + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Helper for setting HeadingLevel property on a DependencyObject. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The help text value to set. + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The value to set; if the element is meant to be a column header, otherwise . + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Helper for setting IsDialog property on a DependencyObject. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + A value that specifies how an element determines how the property is determined. + Sets the attached property for the specified . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The value to set; if the element is meant to be required to be filled out on a form, otherwise . + Sets the attached property for the specified . + To be added. + + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The value to set; if the element is meant to be a row header, otherwise . + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The item status value to set. + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The item type value to set. + Sets the attached property for the specified . + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The labeled by value to set. + Sets the attached property. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The to check. + The value to assign to the property. + Sets the attached property for the specified . + To be added. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The on which to set the property. + The name value to set. + Sets the attached property. + To be added. + UI Automation Properties Overview + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The dependency object on which to set the property. + The value to set. + Sets the attached property for the specified . + + property gets or sets the ordinal position of the element within a set of elements that are considered to be siblings. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The dependency object on which to set the property. + The value to set. + Sets the attached property for the specified . + + property gets or sets the count of automation elements in a group or set that are considered to be siblings. + + ]]> + + + + + + + + + + AttachedProperty + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + Gets or sets the count of automation elements in a group or set that are considered to be siblings. + + | +|Metadata properties set to `true`|None| + + ]]> + + + + + + + + + + + Field + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.DependencyProperty + + + Identifies the SizeOfSet attached property. + + + + ]]> + + + + + diff --git a/xml/System.Windows.Documents/DocumentPaginator.xml b/xml/System.Windows.Documents/DocumentPaginator.xml index 8d6c0590cb7..902383f8dbe 100644 --- a/xml/System.Windows.Documents/DocumentPaginator.xml +++ b/xml/System.Windows.Documents/DocumentPaginator.xml @@ -1,638 +1,656 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Provides an abstract base class that supports creation of multiple-page elements from a single document. - - , then use as your base class. - - ]]> - - - - - - - - - - Constructor - - PresentationCore - 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")>] - - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The original passed to , , or that identifies the asynchronous task to cancel. - Cancels a previous or operation. - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Forces a pagination of the content, updates with the new total, and sets to . - - will be `true` immediately after this is called. If content is modified or is changed after this method is called, will likely revert to `false`. - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Asynchronously, forces a pagination of the content, updates with the new total, and sets to . - - - - - - - - - - Method - - PresentationCore - 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.Void - - - - Asynchronously, forces a pagination of the content, updates with the new total, and sets to . - - . - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A unique identifier for the asynchronous task. - Asynchronously, forces a pagination of the content, updates with the new total, sets to . - - - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.ComponentModel.AsyncCompletedEventHandler - - - Occurs when a operation has finished. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.DocumentPage - - - - - - The zero-based page number of the document page that is needed. - When overridden in a derived class, gets the for the specified page number. - The for the specified , or if the page does not exist. - - provides similar functionality as , but for asynchronous operation. - - ]]> - - - is negative. - - - - - PresentationCore - 4.0.0.0 - - - Asynchronously returns the for the specified page number. - - - - - - - - - - Method - - PresentationCore - 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.Void - - - - - - The zero-based page number of the document page that is needed. - Asynchronously returns (through the event) the for the specified page number. - - . - - This method raises the event. The is passed to the event as one of the event arguments. See for how to use this method to get the page. - - ]]> - - - is negative. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The zero-based page number of the to get. - A unique identifier for the asynchronous task. - Asynchronously returns (through the event) the for the specified page number and assigns the specified ID to the asynchronous task. - - event. The is passed to the event as one of the event arguments. - - The following steps illustrate how to retrieve a asynchronously: - -1. Create a delegate and add it to be notified of events. - -2. Call specifying the `pageNumber` desired and a unique `userState`, which will be used to identify the completion of the asynchronous event. - -3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. (The . property will also match the `pageNumber` specified in the call.) - -4. When the . property matches the original `userState`, the operation is complete and the page is ready. - -5. Call to retrieve the formatted . - - ]]> - - - is negative. - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.GetPageCompletedEventHandler - - - Occurs when has completed. - To be added. - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - When overridden in a derived class, gets a value indicating whether is the total number of pages. - - if pagination is complete and is the total number of pages; otherwise, , if pagination is in process and is the number of pages currently formatted (not the total). - - This value may revert to , after being , if or content changes; because those events would force a repagination. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - When overridden in a derived class, gets a count of the number of pages currently formatted. - A count of the number of pages that have been formatted. - - is `true`, pagination is complete and is the total number of pages in the document. - - If is `false`, pagination is in process and is the number of pages currently formatted (not the total). - - This value may change if or content changes, because those events would force a repagination. - - ]]> - - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.PagesChangedEventHandler - - - Occurs when the document content is changed. - To be added. - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Size - - - When overridden in a derived class, gets or sets the suggested width and height of each page. - A representing the width and height of each page. - - may override the value of this property. Users should check . - - - -## Examples - The following example shows how to set the . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/XpsSave/CSharp/XpfContent.cs" id="Snippetcreatefixeddocument"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpfcontent.vb" id="Snippetcreatefixeddocument"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.IDocumentPaginatorSource - - - When overridden in a derived class, returns the element being paginated. - An representing the element being paginated. - - as the value of its property. It is guaranteed to have such a property because it implements . - - ]]> - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Provides an abstract base class that supports creation of multiple-page elements from a single document. + + , then use as your base class. + + ]]> + + + + + + + + + + Constructor + + PresentationCore + 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")>] + + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The original passed to , , or that identifies the asynchronous task to cancel. + Cancels a previous or operation. + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Forces a pagination of the content, updates with the new total, and sets to . + + will be `true` immediately after this is called. If content is modified or is changed after this method is called, will likely revert to `false`. + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Asynchronously, forces a pagination of the content, updates with the new total, and sets to . + + + + + + + + + + Method + + PresentationCore + 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.Void + + + + Asynchronously, forces a pagination of the content, updates with the new total, and sets to . + + . + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A unique identifier for the asynchronous task. + Asynchronously, forces a pagination of the content, updates with the new total, sets to . + + + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.ComponentModel.AsyncCompletedEventHandler + + + Occurs when a operation has finished. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.DocumentPage + + + + + + The zero-based page number of the document page that is needed. + When overridden in a derived class, gets the for the specified page number. + The for the specified , or if the page does not exist. + + provides similar functionality as , but for asynchronous operation. + + ]]> + + + is negative. + + + + + PresentationCore + 4.0.0.0 + + + Asynchronously returns the for the specified page number. + + + + + + + + + + Method + + PresentationCore + 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.Void + + + + + + The zero-based page number of the document page that is needed. + Asynchronously returns (through the event) the for the specified page number. + + . + + This method raises the event. The is passed to the event as one of the event arguments. See for how to use this method to get the page. + + ]]> + + + is negative. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The zero-based page number of the to get. + A unique identifier for the asynchronous task. + Asynchronously returns (through the event) the for the specified page number and assigns the specified ID to the asynchronous task. + + event. The is passed to the event as one of the event arguments. + + The following steps illustrate how to retrieve a asynchronously: + +1. Create a delegate and add it to be notified of events. + +2. Call specifying the `pageNumber` desired and a unique `userState`, which will be used to identify the completion of the asynchronous event. + +3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. (The . property will also match the `pageNumber` specified in the call.) + +4. When the . property matches the original `userState`, the operation is complete and the page is ready. + +5. Call to retrieve the formatted . + + ]]> + + + is negative. + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.GetPageCompletedEventHandler + + + Occurs when has completed. + To be added. + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + When overridden in a derived class, gets a value indicating whether is the total number of pages. + + if pagination is complete and is the total number of pages; otherwise, , if pagination is in process and is the number of pages currently formatted (not the total). + + This value may revert to , after being , if or content changes; because those events would force a repagination. + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + When overridden in a derived class, gets a count of the number of pages currently formatted. + A count of the number of pages that have been formatted. + + is `true`, pagination is complete and is the total number of pages in the document. + + If is `false`, pagination is in process and is the number of pages currently formatted (not the total). + + This value may change if or content changes, because those events would force a repagination. + + ]]> + + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.PagesChangedEventHandler + + + Occurs when the document content is changed. + + + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Size + + + When overridden in a derived class, gets or sets the suggested width and height of each page. + A representing the width and height of each page. + + may override the value of this property. Users should check . + + + +## Examples + The following example shows how to set the . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/XpsSave/CSharp/XpfContent.cs" id="Snippetcreatefixeddocument"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpfcontent.vb" id="Snippetcreatefixeddocument"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.IDocumentPaginatorSource + + + When overridden in a derived class, returns the element being paginated. + An representing the element being paginated. + + as the value of its property. It is guaranteed to have such a property because it implements . + + ]]> + + + + + diff --git a/xml/System.Windows.Documents/DynamicDocumentPaginator.xml b/xml/System.Windows.Documents/DynamicDocumentPaginator.xml index 1f9176548a1..27837915b74 100644 --- a/xml/System.Windows.Documents/DynamicDocumentPaginator.xml +++ b/xml/System.Windows.Documents/DynamicDocumentPaginator.xml @@ -1,473 +1,481 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.DocumentPaginator - - - - Provides an abstract base class that supports automatic background pagination and tracking content positions across repaginations in addition to the methods and properties of its own base class. - - will automatically pre-paginate content in the background (this process begins when is `true`, which is the default setting). - - When is `true`, the layout will also be repaginated due to changes in content or changes in . - - The event occurs upon completion of pagination (or repagination) of one or more pages, such as in the following situations: - -- events occur as content is paginated in the background. Depending on the implementation, the event may occur upon paginating one or multiple pages ( specifies which pages have been paginated). - -- Calls to or may cause an event to occur if the page specified has not been paginated. For example, if background pagination is enabled ( = `true`) but pagination has only been completed up to the third page, a call of with an argument of 6 will cause pages four, five, six, and seven to be paginated. Upon completion, a event will be raised with settings of = 4 and = 4. - -- With background pagination enabled ( = `true`), a change in on flow-format content, such as a , may cause repagination and associated events. Note that has no effect in repagination on fixed-format content, such as , where the visual page size does not affect the layout. - - A event also occurs when background pagination is disabled. For example, if there is only one page of content and = `false`), calling with an argument of 0 will result in two events: - -1. A event with settings of = 0 and = 1. - -2. A event. - - ]]> - - - - - - - - - - Constructor - - PresentationCore - 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")>] - - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.ContentPosition - - - - - - The object to return the of. - When overridden in a derived class, returns a for the specified . - The of the given object. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - The content position whose page number is needed. - When overridden in a derived class, returns the zero-based page number of the specified . - An representing zero-based page number where the specified appears. - - provides similar functionality as , but with asynchronous operation. - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Returns the zero-based page number of the specified . - - - - - - - - - - Method - - PresentationCore - 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.Void - - - - - - The content position whose page number is needed. - Asynchronously, returns (through the This method raises the event) the zero-based page number of the specified . - - . - - This method raises the event. The page number is passed to the event as one of the event arguments. See for how to use this method to get the page number. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The content position element to return the page number of. - A unique identifier for the asynchronous task. - Asynchronously, returns (through the This method raises the event) the zero-based page number of the specified . - - event. - - The following steps illustrate how to retrieve the page number of a given `contentPosition` asynchronously. - -1. Create a delegate and add it to be notified of events. - -2. Call specifying the `contentPosition` desired and a unique `userState` object that will be used to identify the asynchronous task. - -3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. - -4. When the . property matches the original `userState`, the operation is complete and the page number is ready. (The . property will also match the original `contentPosition` parameter.) - -5. The . property contains the zero-based page number of the specified `contentPosition`. - - provides similar functionality as , but for synchronous operation. - - ]]> - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.GetPageNumberCompletedEventHandler - - - Occurs when has completed. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.ContentPosition - - - - - - The page whose position is needed. - When overridden in a derived class, gets the position of the specified page in the document's content. - A representing the position of . - To be added. - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets a value indicating whether pagination is performed automatically in the background in response to certain events, such as a change in page size. - - if background pagination is enabled; otherwise, . The default is . - - and events as appropriate. - - Pagination of content, as distinct from a is not affected by changes to the visual . - - ]]> - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when all document content has been paginated. - - occurs, is `true` until a new pagination is initiated. - - ]]> - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Documents.PaginationProgressEventHandler - - - Occurs when one or more content pages have been paginated. - - properties and identify the range of pages paginated. - - ]]> - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.DocumentPaginator + + + + Provides an abstract base class that supports automatic background pagination and tracking content positions across repaginations in addition to the methods and properties of its own base class. + + will automatically pre-paginate content in the background (this process begins when is `true`, which is the default setting). + + When is `true`, the layout will also be repaginated due to changes in content or changes in . + + The event occurs upon completion of pagination (or repagination) of one or more pages, such as in the following situations: + +- events occur as content is paginated in the background. Depending on the implementation, the event may occur upon paginating one or multiple pages ( specifies which pages have been paginated). + +- Calls to or may cause an event to occur if the page specified has not been paginated. For example, if background pagination is enabled ( = `true`) but pagination has only been completed up to the third page, a call of with an argument of 6 will cause pages four, five, six, and seven to be paginated. Upon completion, a event will be raised with settings of = 4 and = 4. + +- With background pagination enabled ( = `true`), a change in on flow-format content, such as a , may cause repagination and associated events. Note that has no effect in repagination on fixed-format content, such as , where the visual page size does not affect the layout. + + A event also occurs when background pagination is disabled. For example, if there is only one page of content and = `false`), calling with an argument of 0 will result in two events: + +1. A event with settings of = 0 and = 1. + +2. A event. + + ]]> + + + + + + + + + + Constructor + + PresentationCore + 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")>] + + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.ContentPosition + + + + + + The object to return the of. + When overridden in a derived class, returns a for the specified . + The of the given object. + To be added. + Throws ArgumentException if the object does not exist within this element's tree. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + The content position whose page number is needed. + When overridden in a derived class, returns the zero-based page number of the specified . + An representing zero-based page number where the specified appears. + + provides similar functionality as , but with asynchronous operation. + + ]]> + + Throws ArgumentException if the ContentPosition does not exist within + this element's tree. + + + + + PresentationCore + 4.0.0.0 + + + Returns the zero-based page number of the specified . + + + + + + + + + + Method + + PresentationCore + 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.Void + + + + + + The content position whose page number is needed. + Asynchronously, returns (through the This method raises the event) the zero-based page number of the specified . + + . + + This method raises the event. The page number is passed to the event as one of the event arguments. See for how to use this method to get the page number. + + ]]> + + Throws ArgumentException if the ContentPosition does not exist within + this element's tree. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The content position element to return the page number of. + A unique identifier for the asynchronous task. + Asynchronously, returns (through the This method raises the event) the zero-based page number of the specified . + + event. + + The following steps illustrate how to retrieve the page number of a given `contentPosition` asynchronously. + +1. Create a delegate and add it to be notified of events. + +2. Call specifying the `contentPosition` desired and a unique `userState` object that will be used to identify the asynchronous task. + +3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. + +4. When the . property matches the original `userState`, the operation is complete and the page number is ready. (The . property will also match the original `contentPosition` parameter.) + +5. The . property contains the zero-based page number of the specified `contentPosition`. + + provides similar functionality as , but for synchronous operation. + + ]]> + + Throws ArgumentException if the ContentPosition does not exist within + this element’s tree. + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.GetPageNumberCompletedEventHandler + + + Occurs when has completed. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.ContentPosition + + + + + + The page whose position is needed. + When overridden in a derived class, gets the position of the specified page in the document's content. + A representing the position of . + To be added. + Throws ArgumentException if the page is not valid. + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value indicating whether pagination is performed automatically in the background in response to certain events, such as a change in page size. + + if background pagination is enabled; otherwise, . The default is . + + and events as appropriate. + + Pagination of content, as distinct from a is not affected by changes to the visual . + + ]]> + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when all document content has been paginated. + + occurs, is `true` until a new pagination is initiated. + + ]]> + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Documents.PaginationProgressEventHandler + + + Occurs when one or more content pages have been paginated. + + properties and identify the range of pages paginated. + + ]]> + + + + + diff --git a/xml/System.Windows.Ink/DrawingAttributes.xml b/xml/System.Windows.Ink/DrawingAttributes.xml index 0c3c9f52e87..6ba8fe5b4f3 100644 --- a/xml/System.Windows.Ink/DrawingAttributes.xml +++ b/xml/System.Windows.Ink/DrawingAttributes.xml @@ -1,1298 +1,1306 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.ComponentModel.INotifyPropertyChanged - - - - Specifies the appearance of a . - - property to specify settings such as color, width, transparency, and the shape of the stylus tip for a . - - Use the property to specify the drawing attributes for the strokes added to an . Only strokes that are added after the undergo change show the updated attributes. The appearance of the strokes that are already on the does not change. - - For a list of initial property values for an instance of the class, see the constructor. - - -## XAML Text Usage - This class is not typically used in XAML. - - - -## Examples - The following example demonstrates how to use two objects to simulate using a pen and a highlighter on the same . The example assumes the root element in the XAML file is a called `root`. It also assumes that there is a called `switchHighlighter` and that the event is connected to the event handler defined in this example. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet3"::: - - ]]> - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - Initializes a new instance of the class. - - class. - -|Property|Initial Value| -|--------------|-------------------| -||Black| -||`false`| -||2 device independent pixels (DIP)| -||`false`| -||`false`| -||| -||| -||2 DIP| - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The to associate with the custom property. - The value of the custom property. must be of type , , , , , , , , , , , , , or an array of these data types; however it cannot be an array of type . - Adds a custom property to the object. - - method enables you to add custom properties to a object. This is useful when you render your own strokes and want to provide extra information. - - - -## Examples - The following example demonstrates how to add and retrieve a custom property from the object. The example adds a property that indicates whether the object is a pen or a highlighter. The code in the `ChangeColors_Click` event handler renders a new color for strokes on the that use the object, `inkDA`. This example assumes that there is an named `inkCanvas1`, and that there are two objects named `inkDA`, and `highlighterDA.` - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet5"::: - - ]]> - - - is . - - is an empty . - - -or- - - is not one of the allowed data types listed in the section. - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.PropertyDataChangedEventHandler - - - Occurs when a property in the object changes. - - event. This example assumes that there is a object called `inkDA` and that the event is connected to the event handler defined in this example. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet6"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet6"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.DrawingAttributes - - - - Copies the object. - A copy of the object. - - method creates a new object and populates it with the same values as the current object. Any custom properties are also copied. - - - -## Examples - The following example demonstrates how to copy a object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet8"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet8"::: - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Media.Color - - - Gets or sets the color of a . - The color of a . - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The to locate in the object . - Returns a value that indicates whether the specified property data identifier is in the object. - - if the specified property data identifier is in the object; otherwise, . - - object. The example adds a property that indicates whether the object is a pen or a highlighter. The `ChangeColors_Click` event handler changes all the strokes that were put on the with a called `inkDA` to a new color. This example assumes that there is an named `inkCanvas1`, and that there are two objects named `inkDA`, and `highlighterDA.` - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet5"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The object to compare to the current object. - Determines whether the specified object is equal to the current object. - - if the objects are equal; otherwise, . - - objects are equal if the following properties are equal: - -- - -- - -- - -- - -- - -- - -- - -- - -> [!NOTE] -> The method does not check the custom properties for equality. - - - -## Examples - The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet10"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet12"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet12"::: - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets a value that indicates whether Bezier smoothing is used to render the . - - to use Bezier smoothing to render the ; otherwise . The default is . - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - Serves as a hash function for a particular type. - A hash code for the current . - To be added. - - - - - - - - - - - Method - - PresentationCore - 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 associated with the custom property to get. - Gets the value of the custom property associated with the specified . - The value of the custom property associated with the specified . - - method to access custom properties you added to a object. returns the default value for the built-in property if a value has not been set. - - - -## Examples - The following example demonstrates how to add and retrieve a custom property from the object. The example adds a property that indicates whether the object is a pen or a highlighter. The code in the `ChangeColors_Click` event handler renders a new color for strokes on the that use the object, `inkDA`. This example assumes that there is an named `inkCanvas1`, and that there are two objects named `inkDA`, and `highlighterDA.` - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet5"::: - - ]]> - - - is not associated with a custom property of the object. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Guid[] - - - - Returns the GUIDs of any custom properties associated with the . - An array of type that represents the property data identifiers. - - class are in the class. - - - -## Examples - The following example demonstrates how to get the property data identifiers from the object. This example assumes that a called `inkDA` has been declared. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet7"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet7"::: - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Double - - - Gets or sets the height of the stylus used to draw the . - The value that indicates the height of the stylus used to draw the . - - when it is rendered, but not the value of the property. - -- The amount of pressure applied to the stylus when the is drawn. - -- The value of the property. - - If you set the property to 0 device independent pixels (DIP), it is changed to 2 DIP. - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - The property is less than or . - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets a value that indicates whether the thickness of a rendered changes according the amount of pressure applied. - - to indicate that the thickness of the stroke is uniform; to indicate that the thickness of a rendered increases when pressure is increased. The default is . - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets a value that indicates whether the looks like a highlighter. - - to render the as a highlighter; otherwise, . The default is . - - property is set to `true`, the is slightly transparent, which allows the strokes underneath to appear. - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Double - - - Specifies the largest value allowed for the property. - - field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. - - - -## Examples - The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet14"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet14"::: - - ]]> - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Double - - - Specifies the largest value allowed for the property. - - field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. - - - -## Examples - The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet15"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet15"::: - - ]]> - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Double - - - Specifies the smallest value allowed for the property. - - field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. - - - -## Examples - The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet14"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet14"::: - - ]]> - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Double - - - Specifies the smallest value allowed for the property. - - field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. - - - -## Examples - The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet15"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet15"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - is . - - When overriding in a derived class, call the method for the base class to ensure that registered delegates receive the event. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The event data. - Occurs when any property changes. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - 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. - - ]]> - - - is . - - When overriding in a derived class, call the method for the base class to ensure registered delegates receive the event. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The first object to compare. - The second object to compare. - Determines whether the specified objects are equal. - - if the objects are equal; otherwise, . - - objects are equal if the following properties are equal: - -- - -- - -- - -- - -- - -- - -- - -- - -> [!NOTE] -> The method does not check the custom properties for equality. - - The equivalent method for this operator is . - -## Examples - The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet10"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet11"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet11"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The first object to compare. - The second object to compare. - Determines whether the specified objects are not equal. - - if the objects are not equal; otherwise, . - - objects are not equal if the following properties are not equal: - -- - -- - -- - -- - -- - -- - -- - -- - -> [!NOTE] -> The method does not check the custom properties for equality. - - The equivalent method for this operator is the negation of . - -## Examples - The following example compares two objects for inequality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet10"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet13"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet13"::: - - ]]> - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.PropertyDataChangedEventHandler - - - Occurs when property data is added or removed from the . - - . When the `Shadowed` property changes, the event handler calls the method, which causes the stroke to be redrawn. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionShadow/CSharp/CustomRenderedStroke.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionShadow/VisualBasic/CustomRenderedStroke.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The associated with the custom property to remove. - Removes the custom property associated with the specified . - - object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet9"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet9"::: - - ]]> - - - is not associated with a custom property of the object. - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StylusTip - - - Gets or sets the shape of the stylus used to draw the . - One of the values. - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Media.Matrix - - - Gets or sets the that specifies the transformation to perform on the stylus' tip. - A that specifies the transformation to perform on the stylus' tip. - - property to rotate, skew, or scale the stylus tip. - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - The matrix set to is not an invertible matrix. - - -or- - - The or property of the matrix is not zero. - - - - - - - - - Event - - E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.ComponentModel.PropertyChangedEventHandler - - - Occurs when the value of any property has changed. - To be added. - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Double - - - Gets or sets the width of the stylus used to draw the . - The width of the stylus used to draw the . - - when it is rendered, but not the value of the property. - -- The amount of pressure applied to the stylus when the is drawn. - -- The value of the property. - - If you set the property to 0 device independent pixels (DIP), it is changed to 2 DIP. - - -## XAML Text Usage - This property is not typically used in XAML. - - - -## Examples - The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: - - ]]> - - The property is less than or . - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.ComponentModel.INotifyPropertyChanged + + + + Specifies the appearance of a . + + property to specify settings such as color, width, transparency, and the shape of the stylus tip for a . + + Use the property to specify the drawing attributes for the strokes added to an . Only strokes that are added after the undergo change show the updated attributes. The appearance of the strokes that are already on the does not change. + + For a list of initial property values for an instance of the class, see the constructor. + + +## XAML Text Usage + This class is not typically used in XAML. + + + +## Examples + The following example demonstrates how to use two objects to simulate using a pen and a highlighter on the same . The example assumes the root element in the XAML file is a called `root`. It also assumes that there is a called `switchHighlighter` and that the event is connected to the event handler defined in this example. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet3"::: + + ]]> + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + Initializes a new instance of the class. + + class. + +|Property|Initial Value| +|--------------|-------------------| +||Black| +||`false`| +||2 device independent pixels (DIP)| +||`false`| +||`false`| +||| +||| +||2 DIP| + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The to associate with the custom property. + The value of the custom property. must be of type , , , , , , , , , , , , , or an array of these data types; however it cannot be an array of type . + Adds a custom property to the object. + + method enables you to add custom properties to a object. This is useful when you render your own strokes and want to provide extra information. + + + +## Examples + The following example demonstrates how to add and retrieve a custom property from the object. The example adds a property that indicates whether the object is a pen or a highlighter. The code in the `ChangeColors_Click` event handler renders a new color for strokes on the that use the object, `inkDA`. This example assumes that there is an named `inkCanvas1`, and that there are two objects named `inkDA`, and `highlighterDA.` + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet5"::: + + ]]> + + + is . + + is an empty . + + -or- + + is not one of the allowed data types listed in the section. + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.PropertyDataChangedEventHandler + + + Occurs when a property in the object changes. + + event. This example assumes that there is a object called `inkDA` and that the event is connected to the event handler defined in this example. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet6"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet6"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.DrawingAttributes + + + + Copies the object. + A copy of the object. + + method creates a new object and populates it with the same values as the current object. Any custom properties are also copied. + + + +## Examples + The following example demonstrates how to copy a object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet8"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet8"::: + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Media.Color + + + Gets or sets the color of a . + The color of a . + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The to locate in the object . + Returns a value that indicates whether the specified property data identifier is in the object. + + if the specified property data identifier is in the object; otherwise, . + + object. The example adds a property that indicates whether the object is a pen or a highlighter. The `ChangeColors_Click` event handler changes all the strokes that were put on the with a called `inkDA` to a new color. This example assumes that there is an named `inkCanvas1`, and that there are two objects named `inkDA`, and `highlighterDA.` + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet5"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The object to compare to the current object. + Determines whether the specified object is equal to the current object. + + if the objects are equal; otherwise, . + + objects are equal if the following properties are equal: + +- + +- + +- + +- + +- + +- + +- + +- + +> [!NOTE] +> The method does not check the custom properties for equality. + + + +## Examples + The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet10"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet12"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet12"::: + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value that indicates whether Bezier smoothing is used to render the . + + to use Bezier smoothing to render the ; otherwise . The default is . + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + Serves as a hash function for a particular type. + A hash code for the current . + To be added. + + + + + + + + + + + Method + + PresentationCore + 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 associated with the custom property to get. + Gets the value of the custom property associated with the specified . + The value of the custom property associated with the specified . + + method to access custom properties you added to a object. returns the default value for the built-in property if a value has not been set. + + + +## Examples + The following example demonstrates how to add and retrieve a custom property from the object. The example adds a property that indicates whether the object is a pen or a highlighter. The code in the `ChangeColors_Click` event handler renders a new color for strokes on the that use the object, `inkDA`. This example assumes that there is an named `inkCanvas1`, and that there are two objects named `inkDA`, and `highlighterDA.` + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet5"::: + + ]]> + + + is not associated with a custom property of the object. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Guid[] + + + + Returns the GUIDs of any custom properties associated with the . + An array of type that represents the property data identifiers. + + class are in the class. + + + +## Examples + The following example demonstrates how to get the property data identifiers from the object. This example assumes that a called `inkDA` has been declared. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet7"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet7"::: + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Double + + + Gets or sets the height of the stylus used to draw the . + The value that indicates the height of the stylus used to draw the . + + when it is rendered, but not the value of the property. + +- The amount of pressure applied to the stylus when the is drawn. + +- The value of the property. + + If you set the property to 0 device independent pixels (DIP), it is changed to 2 DIP. + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + The property is less than or . + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value that indicates whether the thickness of a rendered changes according the amount of pressure applied. + + to indicate that the thickness of the stroke is uniform; to indicate that the thickness of a rendered increases when pressure is increased. The default is . + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets a value that indicates whether the looks like a highlighter. + + to render the as a highlighter; otherwise, . The default is . + + property is set to `true`, the is slightly transparent, which allows the strokes underneath to appear. + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Double + + + Specifies the largest value allowed for the property. + + field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. + + + +## Examples + The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet14"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet14"::: + + ]]> + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Double + + + Specifies the largest value allowed for the property. + + field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. + + + +## Examples + The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet15"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet15"::: + + ]]> + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Double + + + Specifies the smallest value allowed for the property. + + field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. + + + +## Examples + The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet14"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet14"::: + + ]]> + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Double + + + Specifies the smallest value allowed for the property. + + field to check whether a value is within the limits allowed for the property. Do this when the value comes from an unknown source, such as unconstrained user input. + + + +## Examples + The following example ensures the property of the is set to a legal value. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet15"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet15"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + is . + + When overriding in a derived class, call the method for the base class to ensure that registered delegates receive the event. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The event data. + Occurs when any property changes. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + 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. + + ]]> + + + is . + + When overriding in a derived class, call the method for the base class to ensure registered delegates receive the event. + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The first object to compare. + The second object to compare. + Determines whether the specified objects are equal. + + if the objects are equal; otherwise, . + + objects are equal if the following properties are equal: + +- + +- + +- + +- + +- + +- + +- + +- + +> [!NOTE] +> The method does not check the custom properties for equality. + + The equivalent method for this operator is . + +## Examples + The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet10"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet11"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet11"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The first object to compare. + The second object to compare. + Determines whether the specified objects are not equal. + + if the objects are not equal; otherwise, . + + objects are not equal if the following properties are not equal: + +- + +- + +- + +- + +- + +- + +- + +- + +> [!NOTE] +> The method does not check the custom properties for equality. + + The equivalent method for this operator is the negation of . + +## Examples + The following example compares two objects for inequality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet10"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet13"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet13"::: + + ]]> + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.PropertyDataChangedEventHandler + + + Occurs when property data is added or removed from the . + + . When the `Shadowed` property changes, the event handler calls the method, which causes the stroke to be redrawn. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionShadow/CSharp/CustomRenderedStroke.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionShadow/VisualBasic/CustomRenderedStroke.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The associated with the custom property to remove. + Removes the custom property associated with the specified . + + object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet9"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet9"::: + + ]]> + + + is not associated with a custom property of the object. + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StylusTip + + + Gets or sets the shape of the stylus used to draw the . + One of the values. + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Media.Matrix + + + Gets or sets the that specifies the transformation to perform on the stylus' tip. + A that specifies the transformation to perform on the stylus' tip. + + property to rotate, skew, or scale the stylus tip. + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + The matrix set to is not an invertible matrix. + + -or- + + The or property of the matrix is not zero. + + + + + + + + + Event + + E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.ComponentModel.PropertyChangedEventHandler + + + Occurs when the value of any property has changed. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Double + + + Gets or sets the width of the stylus used to draw the . + The width of the stylus used to draw the . + + when it is rendered, but not the value of the property. + +- The amount of pressure applied to the stylus when the is drawn. + +- The value of the property. + + If you set the property to 0 device independent pixels (DIP), it is changed to 2 DIP. + + +## XAML Text Usage + This property is not typically used in XAML. + + + +## Examples + The following example demonstrates how to set the property. The example assumes that your application has an called `inkCanvas1`, and two objects called `inkDA` and `highlighterDA`. For the complete example, see the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet1"::: + + ]]> + + The property is less than or . + + + + diff --git a/xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml b/xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml index 46449e7c563..470ca61b790 100644 --- a/xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml +++ b/xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml @@ -1,111 +1,119 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventArgs - - - - Provides data for the event. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The new . - The old . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Ink.DrawingAttributes - - - Gets the new . - The new . - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Ink.DrawingAttributes - - - Gets the old . - The old . - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventArgs + + + + Provides data for the event. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The new . + The old . + Initializes a new instance of the class. + + + + + + + + + + + + + Property + + PresentationCore + 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.Ink.DrawingAttributes + + + Gets the new . + The new . + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Ink.DrawingAttributes + + + Gets the old . + The old . + To be added. + + + + diff --git a/xml/System.Windows.Ink/Stroke.xml b/xml/System.Windows.Ink/Stroke.xml index ff3f195e559..d67ff652773 100644 --- a/xml/System.Windows.Ink/Stroke.xml +++ b/xml/System.Windows.Ink/Stroke.xml @@ -1,1771 +1,1788 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.ComponentModel.INotifyPropertyChanged - - - - Represents a single ink stroke. - - is the data object that is collected from a pointing device, such as a tablet pen or a mouse. The can be created and manipulated programmatically, and can be represented visually on an ink-enabled element, such as the . A contains information about both its position and appearance. The property is a collection of objects that specifies the position of the . The property specifies a stroke's appearance. - - ]]> - - - - - - - PresentationCore - 4.0.0.0 - - - Initializes a new instance of the class. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - A that represents the . - Initializes a new instance of the class. - - from a and object. This example assumes that there is an called `myInkPresenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet2"::: - - ]]> - - - is . - - is empty. - - - - - - - - - - Constructor - - PresentationCore - 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")>] - - - - - - - - A that represents the . - A object that specifies the appearance of the . - Initializes a new instance of the class. - - from a and object. This example assumes that there is an called `myInkPresenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet2"::: - - ]]> - - - is . - - -or- - - is . - - is empty. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The unique identifier for the property. - The value of the custom property. must be of type , , , , , , , , , , , , , or an array of these data types, except , which is not allowed. - Adds a custom property to the object. - - . - - - -## Examples - The following example demonstrates how to add a custom property to a object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet3"::: - - ]]> - - The argument is not one of the allowed data types listed in the section. - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.Stroke - - - - Returns a deep copy of the existing object. - The new object. - - object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet5"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The unique identifier for the property. - Returns a value that indicates whether the object contains the specified custom property. - Returns if the custom property exists; otherwise, returns . - - object has a custom property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet3"::: - - ]]> - - - - - - - - - PresentationCore - 4.0.0.0 - - - Renders the object based upon a . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The object onto which the stroke will be rendered. - Renders the object based upon the specified . - - object by using a . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawTransform/CSharp/Program.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawTransform/VisualBasic/Module1.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The object onto which the stroke will be rendered. - The object defining the attributes of the stroke that is drawn. - Renders the object based upon the specified and . - - object by using a and . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawTransform/CSharp/Program.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawTransform/VisualBasic/Module1.vb" id="Snippet2"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The object onto which the stroke will be rendered. - The object defining the attributes of the stroke that is drawn. - Renders the on the specified using the specified . - - method to perform custom drawing when you inherit from the class. - - - -## Examples - The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Ink.DrawingAttributes - - - Gets or sets the for the object. - To be added. - - object as it is drawn. - - Changing causes the event to fire. - - - -## Examples - The following example sets the to make a stroke green. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet7"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet7"::: - - ]]> - - The set value is . - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.PropertyDataChangedEventHandler - - - Occurs when the associated with the object change. - - contains information about the property that changed. You can compare the property against the members of to see which value changed. - - - -## Examples - The following example demonstrates how to add a handler for this event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet8"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet8"::: - - ]]> - - - - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.DrawingAttributesReplacedEventHandler - - - Occurs when the drawing attributes of a object are replaced. - - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.StylusPointCollection - - - - Returns the stylus points the uses when is . - A that contains the stylus points along the spine of a when is . - - method returns a new that contains the stylus points that the uses when the property on the property is set to `true`. To get the stylus points that are used when is set to `false`, use the property. - - - -## Examples - The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Rect - - - - Retrieves the bounding box for the object. - A structure defining the bounding box for the object. - - object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet11"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet11"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Returns segments of the current that are within the specified area. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - The points that specify the line which defines where to clip. - Returns segments of the current that are within the specified bounds. - A that contains copies of the segments of the current that are within the specified bounds. - - method returns a that contains strokes that represent the segments of the that is within `lassoPoints`. does not change the original . - - The method connects the first and last points in `lassoPoints` to create the lasso. - - - -## Examples - The following example removes the ink that is outside of the specified bounds. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet6"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet6"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - A that specifies the area to clip. - Returns segments of the current that are within the specified rectangle. - A that contains copies of the segments of the current that are within the bounds of . - - method returns a that contains strokes that represent the segments of the that is within `bounds`. does not change the original . - - - -## Examples - The following example removes the ink that is outside of the specified bounds. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet5"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Returns the segments of the current after part of the is erased. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - An array of type that specifies the area to erase. - Returns segments of the current that are outside the specified bounds. - A that contains the segments of the current that are outside the specified bounds. - - method returns a that contains strokes that represent the segments of the that are outside of `lassoPoints`. does not change the original . - - The method connects the first and last points in `lassoPoints` to create the lasso. - - - -## Examples - The following example removes the ink that is within the specified bounds. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet1"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - A that specifies the area to erase. - Returns segments of the current that are outside the specified rectangle. - A that contains the segments of the current that are outside the bounds of the specified . - - method returns a that contains strokes that represent the segments of the that are outside of `bounds`. does not change the original . - - - -## Examples - The following example removes the ink that is within the specified bounds. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet4"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - - An array of type that specifies the path that dissects the . - A that specifies the shape of the eraser. - Returns the segments of the current after it is dissected by the designated path using the specified . - A that contains copies of the segments of the current after it is dissected by the specified path. - - method uses `eraserShape` to hit test the stroke along `eraserPath` and returns a that represent dissected segments. does not change the original . - - - -## Examples - The following example demonstrates how to erase the ink that intersects a specified path. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet2"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Gets the of the current . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Media.Geometry - - - - Gets the of the current . - A that represents the . - - method to get a to customize the shape of the . Consider caching the to avoid calling multiple times, which may impact performance. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Media.Geometry - - - - - - The that determines the of the . - Gets the of the current using the specified . - A that represents the . - - method uses the , , , and properties of `drawingAttributes` to determine the . Consider caching the to avoid calling multiple times, which may impact performance. - - - -## Examples - The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - The unique identifier for the property. - Retrieves the property data for the specified GUID. - An containing the property data. - - object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet3"::: - - ]]> - - - is not associated with a custom property of the . - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Guid[] - - - - Retrieves the GUIDs of any custom properties associated with the object. - An array of objects. - - - - - - - - - - - - PresentationCore - 4.0.0.0 - - - Returns whether the intersects or is within a certain area. - - methods to determine whether a intersects a certain point or is within specified bounds. - - The following methods check whether the is intersected. - -- - -- - -- - - The following methods check whether the is surrounded. - -- - -- - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The to hit test. - Returns a value that indicates whether current intersects the specified point. - - if intersects the current stroke; otherwise, . - - method does when `diameter` is 1. - - - -## Examples - The following example changes the color of a if it intersects a certain area. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet3"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - An array of type that represents the bounds of the area to hit test. - The percentage of the length of the , that must be in for the to be considered hit. - Returns a value that indicates whether the current is within the specified bounds. - - if the current stroke is within the specified bounds; otherwise . - - method connects the first and last points in `lassoPoints` to create the lasso. - - - -## Examples - The following example renders a stroke purple if at least 80% of the stroke is within the bounds of `myPoints`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet7"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet7"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The path that follows for hit testing. - The shape of with which to hit test. - Returns whether the specified path intersects the using the specified . - - if intersects the current stroke; otherwise, . - - method uses `stylusShape` to hit test the stroke along `eraserPath`. - - - -## Examples - The following code renders a stroke purple if the stroke intersects the path of `myPoints`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet9"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet9"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The that defines the center of the area to hit test. - The diameter of the area to hit test. - Returns a value that indicates whether current intersects the specified area. - - if the specified area intersects the current stroke; otherwise, . - - if it intersects a certain area. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet3"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - A that represents the bounds of the area to hit test. - The percentage of the length of the , that must be in for the to be considered hit. - Returns a value that indicates whether the is within the bounds of the specified rectangle. - - if the current stroke is within the bounds of ; otherwise, . - - . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet8"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet8"::: - - ]]> - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the appearance of the changes. - - handles the event and calls the method. If you inherit from the class and your stroke's appearance is based on a custom state, you must call the method to raise the event. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The object that contains the event data. - Allows derived classes to modify the default behavior of the event. - - method of the base class so that registered delegates receive the event. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The object that contains the event data. - Allows derived classes to modify the default behavior of the event. - - method of the base class so that registered delegates receive the event. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An that contains the event data. - Raises the event. - - class and your stroke's appearance is based on a custom state, you must call the method to raise the event. The handles the event and calls the method. - - - -## Examples - The following example draws a either as a solid stroke or as a series of objects, depending on the `Mode` property. The example calls the method, which in turn calls the where the stroke is drawn. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/CustomRenderedStroke.cs" id="Snippet24"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/CustomRenderedStroke.vb" id="Snippet24"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/CustomRenderedStroke.cs" id="Snippet25"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/CustomRenderedStroke.vb" id="Snippet25"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The event data that describes the property that changed, as well as old and new values. - Occurs when any property changes. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The object that contains the event data. - Allows derived classes to modify the default behavior of the event. - - method of the base class so that registered delegates receive the event. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.PropertyDataChangedEventHandler - - - Occurs when the custom properties on a object changes. - - - - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The unique identifier for the property. - Deletes a custom property from the object. - - object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet30"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet30"::: - - ]]> - - - - - - - - - - - - - - Property - - PresentationCore - 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.Input.StylusPointCollection - - - Returns the stylus points of the . - The that contains the stylus points that represent the current . - - property on the property is set to `true`, use the method. - -> [!NOTE] -> The assigned to the property must have at least one in it. If you try to assign an empty to , or remove all the objects from , an exception occurs. - - - -## Examples - The following example is part of an overridden that draws a circle at each . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: - - ]]> - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the property changes. - - event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet28"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet28"::: - - ]]> - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StylusPointsReplacedEventHandler - - - Occurs when the property is assigned a new . - - event. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet29"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet29"::: - - ]]> - - - - - - - - - - Event - - E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.ComponentModel.PropertyChangedEventHandler - - - Occurs when the value of any property has changed. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The object defining the transformation. - - to apply the transformation to the tip of the stylus; otherwise, . - Performs a transformation based upon the specified object. - - object represents a 3x3 matrix used for transformations in two-dimensional space. Each point of the Stroke object is transformed by the supplied Matrix. For example if the original Point.X value is 100, the original Point.Y value is 55, and the transformation Matrix.Scale(0.5, 0.5), the new Point.X value is 50 and the new Point.Y value is 27.5. - - - -## Examples - The following example demonstrates how to transform a object. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawTransform/CSharp/Program.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawTransform/VisualBasic/Module1.vb" id="Snippet1"::: - - ]]> - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.ComponentModel.INotifyPropertyChanged + + + + Represents a single ink stroke. + + is the data object that is collected from a pointing device, such as a tablet pen or a mouse. The can be created and manipulated programmatically, and can be represented visually on an ink-enabled element, such as the . A contains information about both its position and appearance. The property is a collection of objects that specifies the position of the . The property specifies a stroke's appearance. + + ]]> + + + + + + + PresentationCore + 4.0.0.0 + + + Initializes a new instance of the class. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + A that represents the . + Initializes a new instance of the class. + + from a and object. This example assumes that there is an called `myInkPresenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet2"::: + + ]]> + + + is . + + is empty. + + + + + + + + + + Constructor + + PresentationCore + 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")>] + + + + + + + + A that represents the . + A object that specifies the appearance of the . + Initializes a new instance of the class. + + from a and object. This example assumes that there is an called `myInkPresenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet2"::: + + ]]> + + + is . + + -or- + + is . + + is empty. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The unique identifier for the property. + The value of the custom property. must be of type , , , , , , , , , , , , , or an array of these data types, except , which is not allowed. + Adds a custom property to the object. + + . + + + +## Examples + The following example demonstrates how to add a custom property to a object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet3"::: + + ]]> + + The argument is not one of the allowed data types listed in the section. + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.Stroke + + + + Returns a deep copy of the existing object. + The new object. + + object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet5"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The unique identifier for the property. + Returns a value that indicates whether the object contains the specified custom property. + Returns if the custom property exists; otherwise, returns . + + object has a custom property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet3"::: + + ]]> + + + + + + + + + PresentationCore + 4.0.0.0 + + + Renders the object based upon a . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The object onto which the stroke will be rendered. + Renders the object based upon the specified . + + object by using a . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawTransform/CSharp/Program.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawTransform/VisualBasic/Module1.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The object onto which the stroke will be rendered. + The object defining the attributes of the stroke that is drawn. + Renders the object based upon the specified and . + + object by using a and . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawTransform/CSharp/Program.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawTransform/VisualBasic/Module1.vb" id="Snippet2"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The object onto which the stroke will be rendered. + The object defining the attributes of the stroke that is drawn. + Renders the on the specified using the specified . + + method to perform custom drawing when you inherit from the class. + + + +## Examples + The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Ink.DrawingAttributes + + + Gets or sets the for the object. + The drawing attributes associated with the current stroke. + + object as it is drawn. + + Changing causes the event to fire. + + + +## Examples + The following example sets the to make a stroke green. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet7"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet7"::: + + ]]> + + The set value is . + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.PropertyDataChangedEventHandler + + + Occurs when the associated with the object change. + + contains information about the property that changed. You can compare the property against the members of to see which value changed. + + + +## Examples + The following example demonstrates how to add a handler for this event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet8"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet8"::: + + ]]> + + + + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.DrawingAttributesReplacedEventHandler + + + Occurs when the drawing attributes of a object are replaced. + + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.StylusPointCollection + + + + Returns the stylus points the uses when is . + A that contains the stylus points along the spine of a when is . + + method returns a new that contains the stylus points that the uses when the property on the property is set to `true`. To get the stylus points that are used when is set to `false`, use the property. + + + +## Examples + The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Rect + + + + Retrieves the bounding box for the object. + A structure defining the bounding box for the object. + + object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet11"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet11"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Returns segments of the current that are within the specified area. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + The points that specify the line which defines where to clip. + Returns segments of the current that are within the specified bounds. + A that contains copies of the segments of the current that are within the specified bounds. + + method returns a that contains strokes that represent the segments of the that is within `lassoPoints`. does not change the original . + + The method connects the first and last points in `lassoPoints` to create the lasso. + + + +## Examples + The following example removes the ink that is outside of the specified bounds. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet6"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet6"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + A that specifies the area to clip. + Returns segments of the current that are within the specified rectangle. + A that contains copies of the segments of the current that are within the bounds of . + + method returns a that contains strokes that represent the segments of the that is within `bounds`. does not change the original . + + + +## Examples + The following example removes the ink that is outside of the specified bounds. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet5"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Returns the segments of the current after part of the is erased. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + An array of type that specifies the area to erase. + Returns segments of the current that are outside the specified bounds. + A that contains the segments of the current that are outside the specified bounds. + + method returns a that contains strokes that represent the segments of the that are outside of `lassoPoints`. does not change the original . + + The method connects the first and last points in `lassoPoints` to create the lasso. + + + +## Examples + The following example removes the ink that is within the specified bounds. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet1"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + A that specifies the area to erase. + Returns segments of the current that are outside the specified rectangle. + A that contains the segments of the current that are outside the bounds of the specified . + + method returns a that contains strokes that represent the segments of the that are outside of `bounds`. does not change the original . + + + +## Examples + The following example removes the ink that is within the specified bounds. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet4"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + + An array of type that specifies the path that dissects the . + A that specifies the shape of the eraser. + Returns the segments of the current after it is dissected by the designated path using the specified . + A that contains copies of the segments of the current after it is dissected by the specified path. + + method uses `eraserShape` to hit test the stroke along `eraserPath` and returns a that represent dissected segments. does not change the original . + + + +## Examples + The following example demonstrates how to erase the ink that intersects a specified path. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet2"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Gets the of the current . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Media.Geometry + + + + Gets the of the current . + A that represents the . + + method to get a to customize the shape of the . Consider caching the to avoid calling multiple times, which may impact performance. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Media.Geometry + + + + + + The that determines the of the . + Gets the of the current using the specified . + A that represents the . + + method uses the , , , and properties of `drawingAttributes` to determine the . Consider caching the to avoid calling multiple times, which may impact performance. + + + +## Examples + The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + The unique identifier for the property. + Retrieves the property data for the specified GUID. + An containing the property data. + + object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet3"::: + + ]]> + + + is not associated with a custom property of the . + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Guid[] + + + + Retrieves the GUIDs of any custom properties associated with the object. + An array of objects. + + + + + + + + + + + + PresentationCore + 4.0.0.0 + + + Returns whether the intersects or is within a certain area. + + methods to determine whether a intersects a certain point or is within specified bounds. + + The following methods check whether the is intersected. + +- + +- + +- + + The following methods check whether the is surrounded. + +- + +- + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The to hit test. + Returns a value that indicates whether current intersects the specified point. + + if intersects the current stroke; otherwise, . + + method does when `diameter` is 1. + + + +## Examples + The following example changes the color of a if it intersects a certain area. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet3"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + An array of type that represents the bounds of the area to hit test. + The percentage of the length of the , that must be in for the to be considered hit. + Returns a value that indicates whether the current is within the specified bounds. + + if the current stroke is within the specified bounds; otherwise . + + method connects the first and last points in `lassoPoints` to create the lasso. + + + +## Examples + The following example renders a stroke purple if at least 80% of the stroke is within the bounds of `myPoints`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet7"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet7"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The path that follows for hit testing. + The shape of with which to hit test. + Returns whether the specified path intersects the using the specified . + + if intersects the current stroke; otherwise, . + + method uses `stylusShape` to hit test the stroke along `eraserPath`. + + + +## Examples + The following code renders a stroke purple if the stroke intersects the path of `myPoints`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet9"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet9"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The that defines the center of the area to hit test. + The diameter of the area to hit test. + Returns a value that indicates whether current intersects the specified area. + + if the specified area intersects the current stroke; otherwise, . + + if it intersects a certain area. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet3"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + A that represents the bounds of the area to hit test. + The percentage of the length of the , that must be in for the to be considered hit. + Returns a value that indicates whether the is within the bounds of the specified rectangle. + + if the current stroke is within the bounds of ; otherwise, . + + . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestSample/CSharp/Program.cs" id="Snippet8"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestSample/VisualBasic/Module1.vb" id="Snippet8"::: + + ]]> + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the appearance of the changes. + + handles the event and calls the method. If you inherit from the class and your stroke's appearance is based on a custom state, you must call the method to raise the event. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The object that contains the event data. + Allows derived classes to modify the default behavior of the event. + + method of the base class so that registered delegates receive the event. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The object that contains the event data. + Allows derived classes to modify the default behavior of the event. + + method of the base class so that registered delegates receive the event. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An that contains the event data. + Raises the event. + + class and your stroke's appearance is based on a custom state, you must call the method to raise the event. The handles the event and calls the method. + + + +## Examples + The following example draws a either as a solid stroke or as a series of objects, depending on the `Mode` property. The example calls the method, which in turn calls the where the stroke is drawn. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/CustomRenderedStroke.cs" id="Snippet24"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/CustomRenderedStroke.vb" id="Snippet24"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/CustomRenderedStroke.cs" id="Snippet25"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/CustomRenderedStroke.vb" id="Snippet25"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The event data that describes the property that changed, as well as old and new values. + Occurs when any property changes. + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The object that contains the event data. + Allows derived classes to modify the default behavior of the event. + + method of the base class so that registered delegates receive the event. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + To be added. + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.PropertyDataChangedEventHandler + + + Occurs when the custom properties on a object changes. + + + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The unique identifier for the property. + Deletes a custom property from the object. + + object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet30"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet30"::: + + ]]> + + + + + + + + + + + + + + Property + + PresentationCore + 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.Input.StylusPointCollection + + + Returns the stylus points of the . + The that contains the stylus points that represent the current . + + property on the property is set to `true`, use the method. + +> [!NOTE] +> The assigned to the property must have at least one in it. If you try to assign an empty to , or remove all the objects from , an exception occurs. + + + +## Examples + The following example is part of an overridden that draws a circle at each . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyStroke.cs" id="Snippet23"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyStroke.vb" id="Snippet23"::: + + ]]> + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the property changes. + + event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet28"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet28"::: + + ]]> + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StylusPointsReplacedEventHandler + + + Occurs when the property is assigned a new . + + event. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeSnippets/CSharp/MyBorder.cs" id="Snippet29"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeSnippets/VisualBasic/MyBorder.vb" id="Snippet29"::: + + ]]> + + + + + + + + + + Event + + E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.ComponentModel.PropertyChangedEventHandler + + + Occurs when the value of any property has changed. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The object defining the transformation. + + to apply the transformation to the tip of the stylus; otherwise, . + Performs a transformation based upon the specified object. + + object represents a 3x3 matrix used for transformations in two-dimensional space. Each point of the Stroke object is transformed by the supplied Matrix. For example if the original Point.X value is 100, the original Point.Y value is 55, and the transformation Matrix.Scale(0.5, 0.5), the new Point.X value is 50 and the new Point.Y value is 27.5. + + + +## Examples + The following example demonstrates how to transform a object. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawTransform/CSharp/Program.cs" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawTransform/VisualBasic/Module1.vb" id="Snippet1"::: + + ]]> + + + + + diff --git a/xml/System.Windows.Ink/StrokeCollection.xml b/xml/System.Windows.Ink/StrokeCollection.xml index 85682f94c1f..0308cbd3345 100644 --- a/xml/System.Windows.Ink/StrokeCollection.xml +++ b/xml/System.Windows.Ink/StrokeCollection.xml @@ -1,1809 +1,1843 @@ - - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.ObjectModel.Collection<System.Windows.Ink.Stroke> - - System.Windows.Ink.Stroke - - - - - System.Collections.Specialized.INotifyCollectionChanged - - - System.ComponentModel.INotifyPropertyChanged - - - - - [System.ComponentModel.TypeConverter(typeof(System.Windows.StrokeCollectionConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.Windows.StrokeCollectionConverter))>] - - - - Represents a collection of objects. - - enables you to perform functions such as hit testing, clipping, and erasing strokes. The control performs many of these functions, but if you need more control than the provides, the offers more options. - - The following table lists where to learn about managing digital ink on a custom control. - -|To do this…|See this article| -|-----------------|----------------------| -|Create a control that collects digital ink|[Creating an Ink Input Control](/dotnet/framework/wpf/advanced/creating-an-ink-input-control)| -|Create a control that enables the user to select ink|[How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control)| -|Create a control that enables the user to point-erase ink|[How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control)| - - -## XAML Attribute Usage - -``` - -``` - - -## XAML Object Element Usage - -``` -isfString -``` - - -## XAML Values - -|Term|Definition| -|----------|----------------| -|`isfString`|A string that represents the stroke in base-64, encoded Ink Serialized Format (ISF).| - - - -## Examples - The following example demonstrates how to copy the ink in one onto another . This example assumes: - -- There are two objects called `inkCanvas1` and `inkCanvas2`. - -- The event has been connected to the event handler. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet21"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet21"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Initializes a new instance of the class. - - - - - - - - - Constructor - - PresentationCore - 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")>] - - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The strokes to add to the . - Initializes a new instance of the class that contains the specified strokes. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - A stream that contains ink data. - Initializes a from the specified of Ink Serialized Format (ISF). - - . This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet10"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet11"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet11"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The to add to the collection. - Adds the specified strokes to the . - - method raises the event. - - - -## Examples - The following example demonstrates how to copy the ink in one onto another . This example assumes: - -- There are two objects called `inkCanvas1` and `inkCanvas2`. - -- The event has been connected to the event handler. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet21"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet21"::: - - ]]> - - A in is already a member of the . - - is . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The to associate with the custom property. - The value of the custom property. must be of type , , , , , , , , , , , , , or an array of these data types, except , which is not allowed. - Adds a custom property to the . - - method enables you to add custom properties to a . You can then include extra information with a . - - - -## Examples - The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet12"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet12"::: - - ]]> - - - is an empty . - - -or- - - is not one of the allowed data types listed in the section. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Clears all strokes from the . - To be added. - - - - - PresentationCore - 4.0.0.0 - - - Removes all strokes in the that are outside the specified bounds. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An array of type that specifies the area to be clipped. - Removes all strokes in the that are outside the bounds of the specified array. - - method connects the first and last points in `lassoPoints` to create the lasso. - - The method raises the event for each it clips. - - - -## Examples - The following example demonstrates how to clip the strokes in a . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet13"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet13"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that specifies the area to be clipped. - Replaces all strokes that are clipped by the specified rectangle with new strokes that do not extend beyond the specified rectangle. - - . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet35"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet35"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - Copies the . - A copy of the . - - method copies each in the collection and the new references the new strokes. - - - -## Examples - The following example demonstrates how to copy the ink in one onto another . This example assumes: - -- There are two objects called `inkCanvas1` and `inkCanvas2.` - -- The event has been connected to the event handler. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet21"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet21"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - The to locate in the . - Returns whether the specified custom property identifier is in the . - - if the specified custom property identifier is in the ; otherwise, . - - . If a custom property has been associated with `timestamp`, the example gets that custom property and shows when the was saved. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet12"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet12"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The on which to draw the . - Draws the strokes in the . - - . The custom element keeps a reference to an and redraws itself when the event occurs. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window3.xaml.cs" id="Snippet33"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window3.xaml.vb" id="Snippet33"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Removes the ink that is within the bounds of the specified area. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - An array of type that specifies the area to be erased. - Removes the ink that is within the bounds of the specified area. - - method connects the first and last points in `lassoPoints` to create the lasso. - - The might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. - - The method raises the event for each it erases. - - - -## Examples - The following example demonstrates how to erase strokes in a . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet2"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that specifies the area to be erased. - Replaces all strokes that are clipped by the specified rectangle with new strokes that do not enter the bounds of the specified rectangle. - - might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. All strokes that are entirely inside the specified rectangle are removed. - - The method raises the event for each it erases. - - - -## Examples - The following example demonstrates how to erase the ink within the . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet34"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet34"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - An array of type that specifies the path to be erased. - A that specifies the shape of the eraser. - Replaces all strokes that are clipped by the region created by the specified along the specified path with new Strokes that are not clipped by the region. - - might contain new strokes after the method is called. For example, if `path` intersects the middle of a , the erase method removes that and creates two new strokes. - - The method raises the event for each it erases. - - - -## Examples - The following example demonstrates how to erase ink along a specific path. This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet14"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet14"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Rect - - - - Returns the bounds of the strokes in the collection. - A that contains the bounds of the strokes in the . - - method returns a that takes the appearance of the rendered . For example, if is 10 display independent pixels (DIP) wide, the includes the entire width of the . - - - -## Examples - The following example demonstrates how to get the bounds of the and draw them on the control. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet20"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet20"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.IncrementalLassoHitTester - - - - - - The minimum percentage of each that must be contained within the lasso for it to be considered hit. - Creates an that hit tests the with a lasso (freehand) path. - An that hit tests the . - - method returns an that considers a to be "hit" when the lasso path surrounds it. This is useful for implementing features, such as the ability to select a stroke with a lasso tool. The uses an to implement the lasso selection tool. - - - -## Examples - The following example demonstrates how to get an that enables a user to select strokes with a lasso tool. To create a control that enables a user to select ink, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/InkSelector.cs" id="Snippet17"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/InkSelector.vb" id="Snippet17"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.IncrementalStrokeHitTester - - - - - - A that specifies the tip of the stylus. - Creates an that hit tests the with an erasing path. - An that hit tests the . - - method returns an that considers a to be "hit" when the eraser path intersects it. This is useful for implementing features, such as the ability to erase part of a . The uses an when the property is set to . - - - -## Examples - The following example demonstrates how to get an that can be used to erase part of a . To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/InkEraser/CSharp/InkEraser.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/InkEraser/VisualBasic/InkEraser.vb" id="Snippet4"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - - - The associated with the custom property to get. - Returns the value of the custom property associated with the specified . - The value of the custom property associated with the specified . - - and methods enable you to add custom properties to a . You can then include extra information with a . - - - -## Examples - The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet12"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet12"::: - - ]]> - - - is not associated with a custom property of the . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Guid[] - - - - Returns the GUIDs of any custom properties associated with the . - An array of type that represent the custom property identifiers. - - . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet27"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet27"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Returns a collection of strokes contained within the specified area. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - The point to hit test. - Returns a collection of strokes that intersect the specified point. - A collection of objects that intersect the specified point. - - . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet15"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet15"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - - An array of type that represents the bounds of the area to be hit tested. - The acceptable length of the , as a percentage, for to contain. - Returns a collection of strokes that have at least the specified percentage of length within the specified area. - A that has strokes with at least the specified percentage within the array. - - . This is useful when a custom control enables the user to select ink with a lasso. To create a control that enables a user to select ink with a lasso, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet16"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet16"::: - - ]]> - - - is . - - -or- - - is . - - contains an empty array. - - is less than 0 or greater than 100. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - - An array to type that represents the path to be hit tested. - The that specifies the shape of . - Returns a collection of strokes that intersect with the specified path. - A of strokes that intersect with . - - array. This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet37"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet37"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - - The to hit test. - The size of the area around the to hit test. - Returns a collection of strokes that intersect the specified area. - A collection of objects that intersect the specified point. - - . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet15"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet15"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollection - - - - - - - A that specifies the bounds to be hit tested. - The minimum required length of a Stroke that must exist within bounds for it to be considered hit. - Returns a collection of strokes that have at least the specified percentage of length within the specified rectangle. - A that has strokes with at least the specified percentage within the . - - . This example assumes that there is an called `presenter`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet36"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet36"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - - - - The stroke whose position is required. - Returns the index of the specified in the . - The index of the stroke. - - method returns -1 if `stroke` is not a member of the . - - ]]> - - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - Represents the native persistence format for ink data. - - field to specify the format of the when you transfer data, such as when you copy the to the Clipboard. - - - -## Examples - The following example demonstrates how to copy a to the Clipboard. The example specifies that the is in Ink Serialized Format (ISF), so that other programs, such as Microsoft Office Word can accept the copied data. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet5"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The specified index. - The specified stroke. - Inserts a stroke into the at the specified index. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - Event data. - Occurs when any property changes. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - A that contains the event data. - Raises the event. - - method also allows derived classes to handle the event without attaching a delegate, which is the preferred technique for handling the event in a derived class. - - ]]> - - - When overriding in a derived class, be sure to call the method for the base class so that registered delegates receive the event. - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.PropertyDataChangedEventHandler - - - Occurs when custom property is added or removed from the . - - event. This example assumes that there is a called `dateTimeGuid` and the event is connected to the event handler defined in this example. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet29"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet29"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The to remove from the collection. - Removes the specified strokes from the collection. - - method raises the event for each it removes. - - - -## Examples - The following example demonstrates how to remove all strokes that are at least 80 percent within the specified lasso from a . This is useful when a custom control enables the user to select ink with a lasso. To create a control that enables a user to select ink with a lasso, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet16"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet16"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The specified index. - Removes the stroke at the specified index from the . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The associated with the custom property to remove. - Removes the custom property associated with the specified . - - . This example assumes that there is an called `inkCanvas1` and a called `timestamp`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet28"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet28"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Replaces the strokes in the collection. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The to replace. - The source . - Replaces the specified with the specified . - - method raises the event. - - - -## Examples - The following example demonstrates how to replace the selected strokes on an with another . This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet7"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet7"::: - - ]]> - - - is empty. - - -or- - - is empty. - - -or- - - A in is already in . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The destination . - The source . - Replaces the specified with a new . - - method raises the event for each it replaces. - - - -## Examples - The following example demonstrates how to replace the selected strokes on an with another . This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet7"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet7"::: - - ]]> - - - is empty. - - -or- - - is empty. - - -or- - - A in is already in . - - -or- - - The strokes in are not continuous. - - - - - PresentationCore - 4.0.0.0 - - - Saves the . - - - - - - - - - - Method - - PresentationCore - 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.Void - - - - - - The to which to save the . - Saves the to the specified . - - method saves the as Ink Serialized Format (ISF). - - - -## Examples - The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet10"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The to which to save the . - - to compress the ; otherwise, . - Saves the to the specified and compresses it, when specified. - - method saves the as Ink Serialized Format (ISF). - - - -## Examples - The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet10"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The position at which to replace the stroke. - The stroke to replace the current stroke. - Replaces the stroke at the specified index. - To be added. - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Ink.StrokeCollectionChangedEventHandler - - - Occurs when a in the collection changes. - - event handler. The example assumes that the event is connected to the event handler defined in this example. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet4"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet4"::: - - ]]> - - - - - - - - - - Event - - E:System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Specialized.NotifyCollectionChangedEventHandler - - - Occurs when the changes. - To be added. - - - - - - - - - - Event - - E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.ComponentModel.PropertyChangedEventHandler - - - Occurs when the value of any property has changed. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - A which specifies the transformation to perform on the . - - to apply the transformation to the tip of the stylus; otherwise, . - Modifies each of the and optionally the for each stroke in the according to the specified . - - method affects the shape of the stylus tip, as well as the position of the strokes. For example, if you rotate a 90 degrees, the strokes move around an axis and the height and width of the strokes appear to be inverted. - - - -## Examples - The following example demonstrates how to move all the strokes on an . This example assumes that there is an called `inkCanvas1`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet9"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet9"::: - - ]]> - - - - - + + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.ObjectModel.Collection<System.Windows.Ink.Stroke> + + System.Windows.Ink.Stroke + + + + + System.Collections.Specialized.INotifyCollectionChanged + + + System.ComponentModel.INotifyPropertyChanged + + + + + [System.ComponentModel.TypeConverter(typeof(System.Windows.StrokeCollectionConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.Windows.StrokeCollectionConverter))>] + + + + Represents a collection of objects. + + enables you to perform functions such as hit testing, clipping, and erasing strokes. The control performs many of these functions, but if you need more control than the provides, the offers more options. + + The following table lists where to learn about managing digital ink on a custom control. + +|To do this…|See this article| +|-----------------|----------------------| +|Create a control that collects digital ink|[Creating an Ink Input Control](/dotnet/framework/wpf/advanced/creating-an-ink-input-control)| +|Create a control that enables the user to select ink|[How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control)| +|Create a control that enables the user to point-erase ink|[How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control)| + + +## XAML Attribute Usage + +``` + +``` + + +## XAML Object Element Usage + +``` +isfString +``` + + +## XAML Values + +|Term|Definition| +|----------|----------------| +|`isfString`|A string that represents the stroke in base-64, encoded Ink Serialized Format (ISF).| + + + +## Examples + The following example demonstrates how to copy the ink in one onto another . This example assumes: + +- There are two objects called `inkCanvas1` and `inkCanvas2`. + +- The event has been connected to the event handler. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet21"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet21"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Initializes a new instance of the class. + + + + + + + + + Constructor + + PresentationCore + 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")>] + + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The strokes to add to the . + Initializes a new instance of the class that contains the specified strokes. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + A stream that contains ink data. + Initializes a from the specified of Ink Serialized Format (ISF). + + . This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet10"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet11"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet11"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The to add to the collection. + Adds the specified strokes to the . + + method raises the event. + + + +## Examples + The following example demonstrates how to copy the ink in one onto another . This example assumes: + +- There are two objects called `inkCanvas1` and `inkCanvas2`. + +- The event has been connected to the event handler. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet21"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet21"::: + + ]]> + + A in is already a member of the . + + is . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The to associate with the custom property. + The value of the custom property. must be of type , , , , , , , , , , , , , or an array of these data types, except , which is not allowed. + Adds a custom property to the . + + method enables you to add custom properties to a . You can then include extra information with a . + + + +## Examples + The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet12"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet12"::: + + ]]> + + + is an empty . + + -or- + + is not one of the allowed data types listed in the section. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Clears all strokes from the . + To be added. + + + + + PresentationCore + 4.0.0.0 + + + Removes all strokes in the that are outside the specified bounds. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An array of type that specifies the area to be clipped. + Removes all strokes in the that are outside the bounds of the specified array. + + method connects the first and last points in `lassoPoints` to create the lasso. + + The method raises the event for each it clips. + + + +## Examples + The following example demonstrates how to clip the strokes in a . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet13"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet13"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that specifies the area to be clipped. + Replaces all strokes that are clipped by the specified rectangle with new strokes that do not extend beyond the specified rectangle. + + . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet35"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet35"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + Copies the . + A copy of the . + + method copies each in the collection and the new references the new strokes. + + + +## Examples + The following example demonstrates how to copy the ink in one onto another . This example assumes: + +- There are two objects called `inkCanvas1` and `inkCanvas2.` + +- The event has been connected to the event handler. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet21"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet21"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + The to locate in the . + Returns whether the specified custom property identifier is in the . + + if the specified custom property identifier is in the ; otherwise, . + + . If a custom property has been associated with `timestamp`, the example gets that custom property and shows when the was saved. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet12"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet12"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The on which to draw the . + Draws the strokes in the . + + . The custom element keeps a reference to an and redraws itself when the event occurs. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window3.xaml.cs" id="Snippet33"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window3.xaml.vb" id="Snippet33"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Removes the ink that is within the bounds of the specified area. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + An array of type that specifies the area to be erased. + Removes the ink that is within the bounds of the specified area. + + method connects the first and last points in `lassoPoints` to create the lasso. + + The might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. + + The method raises the event for each it erases. + + + +## Examples + The following example demonstrates how to erase strokes in a . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet2"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that specifies the area to be erased. + Replaces all strokes that are clipped by the specified rectangle with new strokes that do not enter the bounds of the specified rectangle. + + might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. All strokes that are entirely inside the specified rectangle are removed. + + The method raises the event for each it erases. + + + +## Examples + The following example demonstrates how to erase the ink within the . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet34"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet34"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + An array of type that specifies the path to be erased. + A that specifies the shape of the eraser. + Replaces all strokes that are clipped by the region created by the specified along the specified path with new Strokes that are not clipped by the region. + + might contain new strokes after the method is called. For example, if `path` intersects the middle of a , the erase method removes that and creates two new strokes. + + The method raises the event for each it erases. + + + +## Examples + The following example demonstrates how to erase ink along a specific path. This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet14"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet14"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Rect + + + + Returns the bounds of the strokes in the collection. + A that contains the bounds of the strokes in the . + + method returns a that takes the appearance of the rendered . For example, if is 10 display independent pixels (DIP) wide, the includes the entire width of the . + + + +## Examples + The following example demonstrates how to get the bounds of the and draw them on the control. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet20"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet20"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.IncrementalLassoHitTester + + + + + + The minimum percentage of each that must be contained within the lasso for it to be considered hit. + Creates an that hit tests the with a lasso (freehand) path. + An that hit tests the . + + method returns an that considers a to be "hit" when the lasso path surrounds it. This is useful for implementing features, such as the ability to select a stroke with a lasso tool. The uses an to implement the lasso selection tool. + + + +## Examples + The following example demonstrates how to get an that enables a user to select strokes with a lasso tool. To create a control that enables a user to select ink, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/InkSelector.cs" id="Snippet17"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/InkSelector.vb" id="Snippet17"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.IncrementalStrokeHitTester + + + + + + A that specifies the tip of the stylus. + Creates an that hit tests the with an erasing path. + An that hit tests the . + + method returns an that considers a to be "hit" when the eraser path intersects it. This is useful for implementing features, such as the ability to erase part of a . The uses an when the property is set to . + + + +## Examples + The following example demonstrates how to get an that can be used to erase part of a . To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/InkEraser/CSharp/InkEraser.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/InkEraser/VisualBasic/InkEraser.vb" id="Snippet4"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + + + The associated with the custom property to get. + Returns the value of the custom property associated with the specified . + The value of the custom property associated with the specified . + + and methods enable you to add custom properties to a . You can then include extra information with a . + + + +## Examples + The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet12"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet12"::: + + ]]> + + + is not associated with a custom property of the . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Guid[] + + + + Returns the GUIDs of any custom properties associated with the . + An array of type that represent the custom property identifiers. + + . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet27"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet27"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Returns a collection of strokes contained within the specified area. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + The point to hit test. + Returns a collection of strokes that intersect the specified point. + A collection of objects that intersect the specified point. + + . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet15"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet15"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + + An array of type that represents the bounds of the area to be hit tested. + The acceptable length of the , as a percentage, for to contain. + Returns a collection of strokes that have at least the specified percentage of length within the specified area. + A that has strokes with at least the specified percentage within the array. + + . This is useful when a custom control enables the user to select ink with a lasso. To create a control that enables a user to select ink with a lasso, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet16"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet16"::: + + ]]> + + + is . + + -or- + + is . + + contains an empty array. + + is less than 0 or greater than 100. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + + An array to type that represents the path to be hit tested. + The that specifies the shape of . + Returns a collection of strokes that intersect with the specified path. + A of strokes that intersect with . + + array. This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet37"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet37"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + + The to hit test. + The size of the area around the to hit test. + Returns a collection of strokes that intersect the specified area. + A collection of objects that intersect the specified point. + + . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet15"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet15"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollection + + + + + + + A that specifies the bounds to be hit tested. + The minimum required length of a Stroke that must exist within bounds for it to be considered hit. + Returns a collection of strokes that have at least the specified percentage of length within the specified rectangle. + A that has strokes with at least the specified percentage within the . + + . This example assumes that there is an called `presenter`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet36"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet36"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + + + + The stroke whose position is required. + Returns the index of the specified in the . + The index of the stroke. + + method returns -1 if `stroke` is not a member of the . + + ]]> + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + Represents the native persistence format for ink data. + + field to specify the format of the when you transfer data, such as when you copy the to the Clipboard. + + + +## Examples + The following example demonstrates how to copy a to the Clipboard. The example specifies that the is in Ink Serialized Format (ISF), so that other programs, such as Microsoft Office Word can accept the copied data. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet5"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The specified index. + The specified stroke. + Inserts a stroke into the at the specified index. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + Event data. + Occurs when any property changes. + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + A that contains the event data. + Raises the event. + + method also allows derived classes to handle the event without attaching a delegate, which is the preferred technique for handling the event in a derived class. + + ]]> + + + When overriding in a derived class, be sure to call the method for the base class so that registered delegates receive the event. + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.PropertyDataChangedEventHandler + + + Occurs when custom property is added or removed from the . + + event. This example assumes that there is a called `dateTimeGuid` and the event is connected to the event handler defined in this example. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet29"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet29"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The to remove from the collection. + Removes the specified strokes from the collection. + + method raises the event for each it removes. + + + +## Examples + The following example demonstrates how to remove all strokes that are at least 80 percent within the specified lasso from a . This is useful when a custom control enables the user to select ink with a lasso. To create a control that enables a user to select ink with a lasso, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/StrokeCollectionDemo.cs" id="Snippet16"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/StrokeCollectionDemo.vb" id="Snippet16"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The specified index. + Removes the stroke at the specified index from the . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The associated with the custom property to remove. + Removes the custom property associated with the specified . + + . This example assumes that there is an called `inkCanvas1` and a called `timestamp`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet28"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet28"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Replaces the strokes in the collection. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The to replace. + The source . + Replaces the specified with the specified . + + method raises the event. + + + +## Examples + The following example demonstrates how to replace the selected strokes on an with another . This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet7"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet7"::: + + ]]> + + + is empty. + + -or- + + is empty. + + -or- + + A in is already in . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The destination . + The source . + Replaces the specified with a new . + + method raises the event for each it replaces. + + + +## Examples + The following example demonstrates how to replace the selected strokes on an with another . This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet7"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet7"::: + + ]]> + + + is empty. + + -or- + + is empty. + + -or- + + A in is already in . + + -or- + + The strokes in are not continuous. + + + + + PresentationCore + 4.0.0.0 + + + Saves the . + + + + + + + + + + Method + + PresentationCore + 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.Void + + + + + + The to which to save the . + Saves the to the specified . + + method saves the as Ink Serialized Format (ISF). + + + +## Examples + The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet10"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The to which to save the . + + to compress the ; otherwise, . + Saves the to the specified and compresses it, when specified. + + method saves the as Ink Serialized Format (ISF). + + + +## Examples + The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet10"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet10"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The position at which to replace the stroke. + The stroke to replace the current stroke. + Replaces the stroke at the specified index. + To be added. + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Ink.StrokeCollectionChangedEventHandler + + + Occurs when a in the collection changes. + + event handler. The example assumes that the event is connected to the event handler defined in this example. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/DrawingAttributes/CSharp/Window1.xaml.cs" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/DrawingAttributes/VisualBasic/Window1.xaml.vb" id="Snippet4"::: + + ]]> + + + + + + + + + + Event + + E:System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Specialized.NotifyCollectionChangedEventHandler + + + Occurs when the changes. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Event + + E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.ComponentModel.PropertyChangedEventHandler + + + Occurs when the value of any property has changed. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + A which specifies the transformation to perform on the . + + to apply the transformation to the tip of the stylus; otherwise, . + Modifies each of the and optionally the for each stroke in the according to the specified . + + method affects the shape of the stylus tip, as well as the position of the strokes. For example, if you rotate a 90 degrees, the strokes move around an axis and the height and width of the strokes appear to be inverted. + + + +## Examples + The following example demonstrates how to move all the strokes on an . This example assumes that there is an called `inkCanvas1`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StrokeCollectionMethods/CSharp/Window2.xaml.cs" id="Snippet9"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StrokeCollectionMethods/VisualBasic/Window2.xaml.vb" id="Snippet9"::: + + ]]> + + + + + diff --git a/xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml b/xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml index 2359f255085..7760807052c 100644 --- a/xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml +++ b/xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml @@ -1,111 +1,119 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventArgs - - - - Provides data for the event. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The new for the . - The replaced . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.StylusPointCollection - - - Gets the new for the . - The new for the . - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.StylusPointCollection - - - Gets the replaced . - The replaced . - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventArgs + + + + Provides data for the event. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The new for the . + The replaced . + Initializes a new instance of the class. + + + + + + + + + + + + + Property + + PresentationCore + 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.Input.StylusPointCollection + + + Gets the new for the . + The new for the . + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.StylusPointCollection + + + Gets the replaced . + The replaced . + To be added. + + + + diff --git a/xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml b/xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml index 2a920a4c4d0..2db27239620 100644 --- a/xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml +++ b/xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml @@ -1,152 +1,153 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.ObjectModel.Collection<System.Windows.Input.StylusPlugIns.StylusPlugIn> - - System.Windows.Input.StylusPlugIns.StylusPlugIn - - - - - Represent a collection of objects. - - has a property that is a . Add a to the element's property to manipulate ink on the real-time thread. The order of the objects in the affects the appearance of the ink when it is rendered. Suppose you have a called `dynamicRenderer` and a custom called `translatePlugin` that offsets the ink from the tablet pen. If `translatePlugin` is the first in the , and `dynamicRenderer` is the second, the ink that "flows" will be offset as the user moves the pen. If `dynamicRenderer` is first, and `translatePlugin` is second, the ink will seem to "flow" underneath the pen, and when the user lifts the pen, the ink will move. - - - -## Examples - The following example demonstrates how to add a to a custom control. To create a control that collects ink, see [Creating an Ink Input Control](/dotnet/framework/wpf/advanced/creating-an-ink-input-control). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusPluginSamples/CSharp/StylusControl.cs" id="Snippet3"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/StylusControl.vb" id="Snippet3"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.ObjectModel.Collection<System.Windows.Input.StylusPlugIns.StylusPlugIn> + + System.Windows.Input.StylusPlugIns.StylusPlugIn + + + + + Represent a collection of objects. + + has a property that is a . Add a to the element's property to manipulate ink on the real-time thread. The order of the objects in the affects the appearance of the ink when it is rendered. Suppose you have a called `dynamicRenderer` and a custom called `translatePlugin` that offsets the ink from the tablet pen. If `translatePlugin` is the first in the , and `dynamicRenderer` is the second, the ink that "flows" will be offset as the user moves the pen. If `dynamicRenderer` is first, and `translatePlugin` is second, the ink will seem to "flow" underneath the pen, and when the user lifts the pen, the ink will move. + + + +## Examples + The following example demonstrates how to add a to a custom control. To create a control that collects ink, see [Creating an Ink Input Control](/dotnet/framework/wpf/advanced/creating-an-ink-input-control). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusPluginSamples/CSharp/StylusControl.cs" id="Snippet3"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/StylusControl.vb" id="Snippet3"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Remove all the StylusPlugIn objects from the collection. + This method should be called from the application context only. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + index at which to insert the StylusPlugIn object + StylusPlugIn object to insert, downcast to an object + Insert a StylusPlugIn in the collection at a specific index. This method should be called from the application context only + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + To be added. + Remove the StylusPlugIn in the collection at the specified index. This method should be called from the application context only. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Indexer to retrieve/set a StylusPlugIn at a given index in the collection Accessible from both the real time context and application context. + To be added. + + + + diff --git a/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml b/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml index 84106212eac..0cefe169b9e 100644 --- a/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml +++ b/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml @@ -1,259 +1,259 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.RoutedEventArgs - - - - Provides data for the and routed events. - - , will call the method on a to determine if the command can or cannot execute on the current command target. If is set to `false` from an event handler, the command source will disable itself. For example, if a is acting as the command source for a command and the command cannot execute on the current command target, then the will gray itself out. - - The event notifies a command source when the ability of a command to execute may have changed. - - - -## Examples - The follow example creates a that returns `true` only if the command target is a control. First, is cast to a . If is a , is set to `true`; otherwise, it is set to `false`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewcanexecute"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewcanexecute"::: - - ]]> - - - - - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets a value that indicates whether the associated with this event can be executed on the command target. - - if the event can be executed on the command target; otherwise, . The default value is . - - and , are disabled when is `false` and enabled when the is `true`. - - - -## Examples - The follow example creates a that only returns true if the command target is a control. First the event data is cast to a . If it is a , is set to `true`; otherwise, it is set to `false`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewcanexecute"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewcanexecute"::: - - ]]> - - - - - - - - - - - - - - Property - - PresentationCore - 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.Input.ICommand - - - Gets the command associated with this event. - The command. Unless the command is a custom command, this is generally a . There is no default value. - - which handles multiple commands. If the property is equal to the command and the method `IsPlaying` returns `false`, is set to `true`; otherwise, is set to `false`. If the property is equal to the command and the method `IsPlaying` returns `true`, is set to `true`; otherwise, is set to `false`. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewmultiplecanexecute"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewmultiplecanexecute"::: - - ]]> - - - - - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Determines whether the input routed event that invoked the command should continue to route through the element tree. - - if the routed event should continue to route through element tree; otherwise, . The default value is . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Object - - - Gets the command specific data. - The command data. The default value is . - - can be `null`. Many commands do not process or expect command parameters. - - - -## Examples - The following example shows up to use a as the command source for a custom command. The property of the is set to the custom called `customCommand` and the is used to pass the value of the property of a control. This is accomplishment by using databinding to bind the to the property. The converter in the binding expression is a custom which converts into an before binding it to the . - - :::code language="xaml" source="~/samples/snippets/csharp/VS_Snippets_Wpf/InvalidateRequeryWithDispatcherTimer/CSharp/Window1.xaml" id="Snippetinvalidatesampleslidercommandparameter"::: - - ]]> - - - - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.RoutedEventArgs + + + + Provides data for the and routed events. + + , will call the method on a to determine if the command can or cannot execute on the current command target. If is set to `false` from an event handler, the command source will disable itself. For example, if a is acting as the command source for a command and the command cannot execute on the current command target, then the will gray itself out. + + The event notifies a command source when the ability of a command to execute may have changed. + + + +## Examples + The follow example creates a that returns `true` only if the command target is a control. First, is cast to a . If is a , is set to `true`; otherwise, it is set to `false`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewcanexecute"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewcanexecute"::: + + ]]> + + + + + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets a value that indicates whether the associated with this event can be executed on the command target. + + if the event can be executed on the command target; otherwise, . The default value is . + + and , are disabled when is `false` and enabled when the is `true`. + + + +## Examples + The follow example creates a that only returns true if the command target is a control. First the event data is cast to a . If it is a , is set to `true`; otherwise, it is set to `false`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewcanexecute"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewcanexecute"::: + + ]]> + + + + + + + + + + + + + + Property + + PresentationCore + 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.Input.ICommand + + + Gets the command associated with this event. + The command. Unless the command is a custom command, this is generally a . There is no default value. + + which handles multiple commands. If the property is equal to the command and the method `IsPlaying` returns `false`, is set to `true`; otherwise, is set to `false`. If the property is equal to the command and the method `IsPlaying` returns `true`, is set to `true`; otherwise, is set to `false`. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewmultiplecanexecute"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewmultiplecanexecute"::: + + ]]> + + + + + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Determines whether the input routed event that invoked the command should continue to route through the element tree. + + if the routed event should continue to route through element tree; otherwise, . The default value is . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + Handler delegate to invoke + Target element + Calls the handler. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Object + + + Gets the command specific data. + The command data. The default value is . + + can be `null`. Many commands do not process or expect command parameters. + + + +## Examples + The following example shows up to use a as the command source for a custom command. The property of the is set to the custom called `customCommand` and the is used to pass the value of the property of a control. This is accomplishment by using databinding to bind the to the property. The converter in the binding expression is a custom which converts into an before binding it to the . + + :::code language="xaml" source="~/samples/snippets/csharp/VS_Snippets_Wpf/InvalidateRequeryWithDispatcherTimer/CSharp/Window1.xaml" id="Snippetinvalidatesampleslidercommandparameter"::: + + ]]> + + + + + + + + diff --git a/xml/System.Windows.Input/Cursor.xml b/xml/System.Windows.Input/Cursor.xml index 7e53089eecb..d4fcec901a3 100644 --- a/xml/System.Windows.Input/Cursor.xml +++ b/xml/System.Windows.Input/Cursor.xml @@ -1,274 +1,282 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.IDisposable - - - - - [System.ComponentModel.TypeConverter(typeof(System.Windows.Input.CursorConverter))] - [<System.ComponentModel.TypeConverter(typeof(System.Windows.Input.CursorConverter))>] - - - [System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)] - [<System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)>] - - - - Represents the image used for the mouse pointer. - - class contains a set of default cursors. - - When running in Partial Trust, only the default cursors defined in the class are allowed. - - -## XAML Attribute Usage - -``` - -``` - - -## XAML Values - *cursorName* - The name of one of the predefined cursors in the class. - - - -## Examples - [How to: Change the Cursor Type](/dotnet/framework/wpf/advanced/how-to-change-the-cursor-type) - - ]]> - - - - - - - PresentationCore - 4.0.0.0 - - - Initializes a new instance of the class. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The that contains the cursor. - Initializes a new instance of the class from the specified . - - , WPF writes the data to a temporary file and then loads the from the file. If this constructor is unable to create a temporary file, an might be thrown. For example, an might be thrown if a unique temporary file is not available. To resolve this error, try deleting unneeded temporary files. - - ]]> - - - is . - This constructor was unable to create a temporary file. - - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The file that contains the cursor. - Initializes a new instance of the class from the specified *.ani* or a *.cur* file. - To be added. - - is . - - is not an *.ani* or *.cur* file name. - - - - - - - - - - - Constructor - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The that contains the cursor. - - if to scale with dpi; otherwise, . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Constructor - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The that contains the cursor. - - if to scale with dpi; otherwise, . - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Releases the resources used by the class. - - is called, the cursor object is no longer valid. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Finalizes the object to free resources and perform other cleanup operations. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns the string representation of the . - The name of the cursor. - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.IDisposable + + + + + [System.ComponentModel.TypeConverter(typeof(System.Windows.Input.CursorConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.Windows.Input.CursorConverter))>] + + + [System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)] + [<System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)>] + + + + Represents the image used for the mouse pointer. + + class contains a set of default cursors. + + When running in Partial Trust, only the default cursors defined in the class are allowed. + + +## XAML Attribute Usage + +``` + +``` + + +## XAML Values + *cursorName* + The name of one of the predefined cursors in the class. + + + +## Examples + [How to: Change the Cursor Type](/dotnet/framework/wpf/advanced/how-to-change-the-cursor-type) + + ]]> + + + + + + + PresentationCore + 4.0.0.0 + + + Initializes a new instance of the class. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The that contains the cursor. + Initializes a new instance of the class from the specified . + + , WPF writes the data to a temporary file and then loads the from the file. If this constructor is unable to create a temporary file, an might be thrown. For example, an might be thrown if a unique temporary file is not available. To resolve this error, try deleting unneeded temporary files. + + ]]> + + + is . + This constructor was unable to create a temporary file. + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The file that contains the cursor. + Initializes a new instance of the class from the specified *.ani* or a *.cur* file. + To be added. + + is . + + is not an *.ani* or *.cur* file name. + + + + + + + + + + + Constructor + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The that contains the cursor. + + if to scale with dpi; otherwise, . + Initializes a new instance of the class. + To be added. + + + + + + + + + + Constructor + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The that contains the cursor. + + if to scale with dpi; otherwise, . + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Releases the resources used by the class. + + is called, the cursor object is no longer valid. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Finalizes the object to free resources and perform other cleanup operations. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns the string representation of the . + The name of the cursor. + + + + + + + diff --git a/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml b/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml index 0ef81f46da3..181432d4970 100644 --- a/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml +++ b/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml @@ -1,174 +1,174 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.RoutedEventArgs - - - - Provides data for the and routed events. - - represents the method that implements the command logic of a . Separating the implementation logic from the command allows the command to be invoked from different sources and types and enables the centralization of command logic. - - This event data class is also used for and . But most practical handlers will handle the events from a particular , rather than work at the level. - - For more information on commanding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). - - - -## Examples - The following example creates an that opens a when the command is executed. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/commandWithHandler/CSharp/Window1.xaml.cs" id="Snippetcommandhandlerexecutedhandler"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/commandWithHandler/VisualBasic/Window1.xaml.vb" id="Snippetcommandhandlerexecutedhandler"::: - - ]]> - - - - - - - - - - - - - - Property - - PresentationCore - 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.Input.ICommand - - - Gets the command that was invoked. - The command associated with this event. - - , such as a , if the type is known. - - - -## Examples - The following example creates an that handles multiple commands. The handler checks the property on the to determine which method to call. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewmultiplecmdhandler"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewmultiplecmdhandler"::: - - ]]> - - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Object - - - Gets data parameter of the command. - The command-specific data. The default value is . - - is used to pass specific information to the command when it is executed. The type of the data is defined by the command. - - - -## Examples - The following example creates an for a custom . The handler updates a with the current time and the property of a control that is passed to the handler through the . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/InvalidateRequeryWithDispatcherTimer/CSharp/Window1.xaml.cs" id="Snippetinvalidatesampleexecuted"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/InvalidateRequeryWithDispatcherTimer/visualbasic/window1.xaml.vb" id="Snippetinvalidatesampleexecuted"::: - - ]]> - - - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.RoutedEventArgs + + + + Provides data for the and routed events. + + represents the method that implements the command logic of a . Separating the implementation logic from the command allows the command to be invoked from different sources and types and enables the centralization of command logic. + + This event data class is also used for and . But most practical handlers will handle the events from a particular , rather than work at the level. + + For more information on commanding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). + + + +## Examples + The following example creates an that opens a when the command is executed. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/commandWithHandler/CSharp/Window1.xaml.cs" id="Snippetcommandhandlerexecutedhandler"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/commandWithHandler/VisualBasic/Window1.xaml.vb" id="Snippetcommandhandlerexecutedhandler"::: + + ]]> + + + + + + + + + + + + + + Property + + PresentationCore + 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.Input.ICommand + + + Gets the command that was invoked. + The command associated with this event. + + , such as a , if the type is known. + + + +## Examples + The following example creates an that handles multiple commands. The handler checks the property on the to determine which method to call. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/CommandingOverviewSnippets/CSharp/Window1.xaml.cs" id="Snippetcommandingoverviewmultiplecmdhandler"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/CommandingOverviewSnippets/visualbasic/window1.xaml.vb" id="Snippetcommandingoverviewmultiplecmdhandler"::: + + ]]> + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + Handler delegate to invoke + Target element + Calls the handler. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Object + + + Gets data parameter of the command. + The command-specific data. The default value is . + + is used to pass specific information to the command when it is executed. The type of the data is defined by the command. + + + +## Examples + The following example creates an for a custom . The handler updates a with the current time and the property of a control that is passed to the handler through the . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/InvalidateRequeryWithDispatcherTimer/CSharp/Window1.xaml.cs" id="Snippetinvalidatesampleexecuted"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/InvalidateRequeryWithDispatcherTimer/visualbasic/window1.xaml.vb" id="Snippetinvalidatesampleexecuted"::: + + ]]> + + + + + + + diff --git a/xml/System.Windows.Input/IManipulator.xml b/xml/System.Windows.Input/IManipulator.xml index 80b4d228cdd..bc84f527023 100644 --- a/xml/System.Windows.Input/IManipulator.xml +++ b/xml/System.Windows.Input/IManipulator.xml @@ -1,140 +1,149 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - Provides the position of input that is needed to create a manipulation. - - object. For example, if you use two fingers to resize an object, a , which implements , is created for each finger. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - - - The element to use as the frame of reference for calculating the position of the . - Returns the position of the object. - The position of the object. - To be added. - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - Gets or sets a unique identifier for the object. - A unique identifier for the object. - - property should be unique for each object of a certain type. For example, if the types `Manipulator1` and `Manipulator2` implement , all of the objects of type `Maniplulator1` must have unique values, but an object of type `Manipulator1` might have the same as an object of type `Manipulator2`. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - - - - if the manipulation is canceled; otherwise, . - Called when the manipulation ends. - To be added. - - - - - - - - - - Event - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the object changes position. - To be added. - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + Provides the position of input that is needed to create a manipulation. + + object. For example, if you use two fingers to resize an object, a , which implements , is created for each finger. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + + + The element to use as the frame of reference for calculating the position of the . + Returns the position of the object. + The position of the object. + To be added. + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + Gets or sets a unique identifier for the object. + A unique identifier for the object. + + property should be unique for each object of a certain type. For example, if the types `Manipulator1` and `Manipulator2` implement , all of the objects of type `Maniplulator1` must have unique values, but an object of type `Manipulator1` might have the same as an object of type `Manipulator2`. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + + + + if the manipulation is canceled; otherwise, . + Called when the manipulation ends. + To be added. + + + + + + + + + + Event + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the object changes position. + + + + + + + diff --git a/xml/System.Windows.Input/InputGesture.xml b/xml/System.Windows.Input/InputGesture.xml index c1fb03dce74..784333e7e1a 100644 --- a/xml/System.Windows.Input/InputGesture.xml +++ b/xml/System.Windows.Input/InputGesture.xml @@ -1,95 +1,105 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Abstract class that describes input device gestures. - - in Windows Presentation Foundation are and . - - An input gesture can be associated with a command so that when the gesture is performed the command is invoked. For more information, see and the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). - - ]]> - - - - - - - - - - - - Constructor - - PresentationCore - 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")>] - - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The target of the command. - The input event data to compare this gesture to. - When overridden in a derived class, determines whether the specified matches the input associated with the specified object. - - if the gesture matches the input; otherwise, . - To be added. - - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Abstract class that describes input device gestures. + + in Windows Presentation Foundation are and . + + An input gesture can be associated with a command so that when the gesture is performed the command is invoked. For more information, see and the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). + + ]]> + + + + + + + + + + + + Constructor + + PresentationCore + 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")>] + + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The target of the command. + The input event data to compare this gesture to. + When overridden in a derived class, determines whether the specified matches the input associated with the specified object. + + if the gesture matches the input; otherwise, . + + + + + + + + + diff --git a/xml/System.Windows.Input/InputType.xml b/xml/System.Windows.Input/InputType.xml index 81604c349a4..552b4afc4bd 100644 --- a/xml/System.Windows.Input/InputType.xml +++ b/xml/System.Windows.Input/InputType.xml @@ -1,162 +1,174 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Enum - - - Specifies the possible types of input being reported. - To be added. - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputType - - 5 - - Input was provided by a command. - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputType - - 3 - - Input was provided a Human Interface Device that was not a keyboard, a mouse, or a stylus. - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputType - - 0 - - Input was provided by a keyboard. - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputType - - 1 - - Input was provided by a mouse. - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputType - - 2 - - Input was provided by a stylus. - - - - - - - - - - Field - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputType - - 4 - - Input was provided by text. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Enum + + + Specifies the possible types of input being reported. + + + HID indicates that the input was provided by a Human Interface + Device that was not a keyboard, a mouse, or a stylus. + + ]]> + + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputType + + 5 + + Input was provided by a command. + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputType + + 3 + + Input was provided a Human Interface Device that was not a keyboard, a mouse, or a stylus. + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputType + + 0 + + Input was provided by a keyboard. + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputType + + 1 + + Input was provided by a mouse. + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputType + + 2 + + Input was provided by a stylus. + + + + + + + + + + Field + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputType + + 4 + + Input was provided by text. + + + + diff --git a/xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml b/xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml index 0ca7776375f..180bb448ef4 100644 --- a/xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml @@ -1,133 +1,133 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputEventArgs - - - - Provides data for the event. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationDelta - - - Gets the unused portion of the direct manipulation. - The unused portion of the direct manipulation. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the container that the property is relative to. - The container that the property is relative to. - To be added. - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> - - - Gets a collection of objects that represents the touch contacts for the manipulation. - A collection of objects that represents the touch contacts for the manipulation. - To be added. - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputEventArgs + + + + Provides data for the event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationDelta + + + Gets the unused portion of the direct manipulation. + The unused portion of the direct manipulation. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Invokes a handler of this event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the container that the property is relative to. + The container that the property is relative to. + To be added. + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> + + + Gets a collection of objects that represents the touch contacts for the manipulation. + A collection of objects that represents the touch contacts for the manipulation. + To be added. + + + + diff --git a/xml/System.Windows.Input/ManipulationCompletedEventArgs.xml b/xml/System.Windows.Input/ManipulationCompletedEventArgs.xml index bc7fa1622c3..dc2f08fb95d 100644 --- a/xml/System.Windows.Input/ManipulationCompletedEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationCompletedEventArgs.xml @@ -1,267 +1,267 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputEventArgs - - - - Provides data for the event. - - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Cancels the manipulation. - - if the manipulation was successfully canceled; otherwise, . - - sends previous touch events as mouse down, mouse move, or mouse up events to the element. Touch cannot be promoted to mouse events if the event occurs during inertia. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationVelocities - - - Gets the velocities that are used for the manipulation. - The velocities that are used for the manipulation. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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 a value that indicates whether the event occurs during inertia. - - if the event occurs during inertia; if the event occurs while the user has contact with the . - To be added. - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the container that defines the coordinates for the manipulation. - The container that defines the coordinates for the manipulation. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Point - - - Gets the point from which the manipulation originated. - The point from which the manipulation originated. - - property is the point between the two points of contact. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> - - - Gets a collection of objects that represents the touch contacts for the manipulation. - A collection of objects that represents the touch contacts for the manipulation. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationDelta - - - Gets the total transformation that occurs during the current manipulation. - The total transformation that occurs during the current manipulation. - To be added. - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputEventArgs + + + + Provides data for the event. + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Cancels the manipulation. + + if the manipulation was successfully canceled; otherwise, . + + sends previous touch events as mouse down, mouse move, or mouse up events to the element. Touch cannot be promoted to mouse events if the event occurs during inertia. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationVelocities + + + Gets the velocities that are used for the manipulation. + The velocities that are used for the manipulation. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Invokes a handler of this event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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 a value that indicates whether the event occurs during inertia. + + if the event occurs during inertia; if the event occurs while the user has contact with the . + To be added. + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the container that defines the coordinates for the manipulation. + The container that defines the coordinates for the manipulation. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Point + + + Gets the point from which the manipulation originated. + The point from which the manipulation originated. + + property is the point between the two points of contact. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> + + + Gets a collection of objects that represents the touch contacts for the manipulation. + A collection of objects that represents the touch contacts for the manipulation. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationDelta + + + Gets the total transformation that occurs during the current manipulation. + The total transformation that occurs during the current manipulation. + To be added. + + + + diff --git a/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml b/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml index 2f93d0cfa67..1a7cc75e322 100644 --- a/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml @@ -1,440 +1,440 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputEventArgs - - - - Provides data for the event. - - class contains data about changes in the position of a manipulation. The property contains the changes that occurred since the last event occurred. The property contains the total changes that occurred for the current manipulation. You use one of those properties to transform the manipulated object. - - You can end a manipulation by calling the method or force the manipulation into inertia by calling the method. - - - -## Examples - The following example shows an event handler for the event. The example uses the property to move, resize, and rotate a . The example also checks whether the event occurred during inertia and whether the rectangle is touching the edge of a window. If those cases are true, the application stops the manipulation to prevent the rectangle from leaving the visible area of the application. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Cancels the manipulation. - - if the manipulation was successfully canceled; otherwise, . - - sends previous touch events as mouse down or mouse move events to the element and future manipulation events do not occur. Touch cannot be promoted to mouse events if the event occurs during inertia. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Completes the manipulation without inertia. - - method to end the manipulation. For example, when an object reaches the edge of a window, you can call to prevent the object from going off the screen. - - - -## Examples - The following example shows an event handler for the event. The example checks whether the event occurred during inertia and whether the rectangle is touching the edge of a window. If those cases are true, the application stops the manipulation to prevent the rectangle from leaving the visible area of the application. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationDelta - - - Gets the cumulated changes of the current manipulation. - The cumulated changes of the current manipulation. - - property contains the total changes that occurred for the current manipulation. You can use to transform the manipulated object. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationDelta - - - Gets the most recent changes of the current manipulation. - The most recent changes of the current manipulation. - - property contains the changes that occurred since the last event occurred. You can use this property to transform the manipulated object. - - - -## Examples - The following example shows an event handler for the event. The example uses the property to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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 a value that indicates whether the event occurs during inertia. - - if the event occurs during inertia; if the event occurs while the user has contact with the . - - event occurs during inertia or while the user has contact with the element that receives the event. - - - -## Examples - The following example shows an event handler for the event. The example checks whether the event occurred during inertia and whether the rectangle is touching the edge of a window. If those cases are true, the application stops the manipulation to prevent the rectangle from leaving the visible area of the application. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the container that defines the coordinates for the manipulation. - The container that defines the coordinates for the manipulation. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Point - - - Gets the point from which the manipulation originated. - The point from which the manipulation originated. - To be added. - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> - - - Gets a collection of objects that represents the touch contacts for the manipulation. - A collection of objects that represents the touch contacts for the manipulation. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - The portion of the manipulation that represents moving beyond the boundary. - Specifies that the manipulation has gone beyond certain boundaries. - - method to indicate that an element has moved beyond a certain boundary. For example, if a user moves an element outside of the bounds of a , you can call this method to report that to the window. When you call , the event occurs. By default, the subscribes to the event to provide visual feedback to the user that a boundary has been reached. You can subscribe to to implement custom behavior. - - - -## Examples - The following example shows an event handler for the event that calls the method when the user moves the element over the edge of its container. To test this example, follow the steps in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application) and replace the code in step 5 with this code. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/reportboundaryfeedbackexample.xaml.cs" id="Snippetreportboundaryfeedback"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/reportboundaryfeedbackexample.xaml.vb" id="Snippetreportboundaryfeedback"::: - - ]]> - - - is . - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Starts inertia on the manipulation by ignoring subsequent contact movements and raising the event. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationVelocities - - - Gets the rates of the most recent changes to the manipulation. - The rates of the most recent changes to the manipulation. - To be added. - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputEventArgs + + + + Provides data for the event. + + class contains data about changes in the position of a manipulation. The property contains the changes that occurred since the last event occurred. The property contains the total changes that occurred for the current manipulation. You use one of those properties to transform the manipulated object. + + You can end a manipulation by calling the method or force the manipulation into inertia by calling the method. + + + +## Examples + The following example shows an event handler for the event. The example uses the property to move, resize, and rotate a . The example also checks whether the event occurred during inertia and whether the rectangle is touching the edge of a window. If those cases are true, the application stops the manipulation to prevent the rectangle from leaving the visible area of the application. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Cancels the manipulation. + + if the manipulation was successfully canceled; otherwise, . + + sends previous touch events as mouse down or mouse move events to the element and future manipulation events do not occur. Touch cannot be promoted to mouse events if the event occurs during inertia. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Completes the manipulation without inertia. + + method to end the manipulation. For example, when an object reaches the edge of a window, you can call to prevent the object from going off the screen. + + + +## Examples + The following example shows an event handler for the event. The example checks whether the event occurred during inertia and whether the rectangle is touching the edge of a window. If those cases are true, the application stops the manipulation to prevent the rectangle from leaving the visible area of the application. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationDelta + + + Gets the cumulated changes of the current manipulation. + The cumulated changes of the current manipulation. + + property contains the total changes that occurred for the current manipulation. You can use to transform the manipulated object. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationDelta + + + Gets the most recent changes of the current manipulation. + The most recent changes of the current manipulation. + + property contains the changes that occurred since the last event occurred. You can use this property to transform the manipulated object. + + + +## Examples + The following example shows an event handler for the event. The example uses the property to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Invokes a handler of this event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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 a value that indicates whether the event occurs during inertia. + + if the event occurs during inertia; if the event occurs while the user has contact with the . + + event occurs during inertia or while the user has contact with the element that receives the event. + + + +## Examples + The following example shows an event handler for the event. The example checks whether the event occurred during inertia and whether the rectangle is touching the edge of a window. If those cases are true, the application stops the manipulation to prevent the rectangle from leaving the visible area of the application. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the container that defines the coordinates for the manipulation. + The container that defines the coordinates for the manipulation. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Point + + + Gets the point from which the manipulation originated. + The point from which the manipulation originated. + To be added. + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> + + + Gets a collection of objects that represents the touch contacts for the manipulation. + A collection of objects that represents the touch contacts for the manipulation. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + The portion of the manipulation that represents moving beyond the boundary. + Specifies that the manipulation has gone beyond certain boundaries. + + method to indicate that an element has moved beyond a certain boundary. For example, if a user moves an element outside of the bounds of a , you can call this method to report that to the window. When you call , the event occurs. By default, the subscribes to the event to provide visual feedback to the user that a boundary has been reached. You can subscribe to to implement custom behavior. + + + +## Examples + The following example shows an event handler for the event that calls the method when the user moves the element over the edge of its container. To test this example, follow the steps in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application) and replace the code in step 5 with this code. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/reportboundaryfeedbackexample.xaml.cs" id="Snippetreportboundaryfeedback"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/reportboundaryfeedbackexample.xaml.vb" id="Snippetreportboundaryfeedback"::: + + ]]> + + + is . + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Starts inertia on the manipulation by ignoring subsequent contact movements and raising the event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationVelocities + + + Gets the rates of the most recent changes to the manipulation. + The rates of the most recent changes to the manipulation. + To be added. + + + + diff --git a/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml b/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml index 83e4ca92bdc..a81626ce2cf 100644 --- a/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml @@ -1,425 +1,425 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputEventArgs - - - - Provides data for the event. - - object to specify the inertial behavior of a manipulation. You can specify the inertial behavior for each type of manipulation separately by using the , , and properties. Each property is a type of object that represents the inertial behavior and in each case, you can specify the following: - -- The initial velocity of the inertia when it begins. - -- The desired position of the manipulation when inertia ends. - -- The desired deceleration of the inertia. - - You typically specify either the desired position of the manipulation when inertia ends or the desired deceleration of the inertia, but not both. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - - - -## Examples - The following example shows the event handler and sets the desired deceleration for translation, expansion, and rotation that is used during inertia. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationinertiastarting"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationinertiastarting"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Cancels the manipulation. - - if the manipulation was successfully canceled; otherwise, . - - sends previous touch events as mouse down, mouse move, or mouse up events to the element and future manipulation events do not occur. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Input.InertiaExpansionBehavior - - - Get or sets the rate of slowdown of expansion inertial movement. - The rate of slowdown of expansion inertial movement. - - property to do the following: - -- Specify the initial velocity of the inertia when it begins by setting the property. - -- Specify the desired expansion of the manipulation when inertia ends by setting the property. - -- Specify the desired deceleration of the inertia by setting the property. - - You typically set either the or the , but not both. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationVelocities - - - Gets the rates of changes to the manipulation that occur before inertia starts. - The rates of changes to the manipulation that occur before inertia starts. - - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the container that the property is relative to. - The container that the property is relative to. - - - - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Point - - - Gets or sets the point from which the manipulation originated. - The point from which the manipulation originated. - - property is the point between all of the points of contact. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - ]]> - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> - - - Gets a collection of objects that represents the touch contacts for the manipulation. - A collection of objects that represents the touch contacts for the manipulation. - To be added. - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Input.InertiaRotationBehavior - - - Gets or sets the rate of slowdown of rotational inertial movement. - The rate of slowdown of rotational inertial movement. - - property to do the following: - -- Specify the initial velocity of the inertia when it begins by setting the property. - -- Specify the desired rotation of the manipulation when inertia ends by setting the property. - -- Specify the desired deceleration of the inertia by setting the property. - - You typically set either the or the , but not both. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - - System.Void - - - - - - The object that specifies the behavior of a manipulation during inertia. - Specifies the behavior of a manipulation during inertia. - - instead. - - ]]> - - - is . - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Input.InertiaTranslationBehavior - - - Gets or sets the rate of slowdown of linear inertial movement. - The rate of slowdown of linear inertial movement. - - property to do the following: - -- Specify the initial velocity of the inertia when it begins by setting the property. - -- Specify the desired position of the manipulation when inertia ends by setting the property. - -- Specify the desired deceleration of the inertia by setting the property. - - You typically set either the or the , but not both. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - ]]> - - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputEventArgs + + + + Provides data for the event. + + object to specify the inertial behavior of a manipulation. You can specify the inertial behavior for each type of manipulation separately by using the , , and properties. Each property is a type of object that represents the inertial behavior and in each case, you can specify the following: + +- The initial velocity of the inertia when it begins. + +- The desired position of the manipulation when inertia ends. + +- The desired deceleration of the inertia. + + You typically specify either the desired position of the manipulation when inertia ends or the desired deceleration of the inertia, but not both. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + + + +## Examples + The following example shows the event handler and sets the desired deceleration for translation, expansion, and rotation that is used during inertia. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/mainwindow.xaml.cs" id="Snippetmanipulationinertiastarting"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationinertiastarting"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Cancels the manipulation. + + if the manipulation was successfully canceled; otherwise, . + + sends previous touch events as mouse down, mouse move, or mouse up events to the element and future manipulation events do not occur. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Input.InertiaExpansionBehavior + + + Get or sets the rate of slowdown of expansion inertial movement. + The rate of slowdown of expansion inertial movement. + + property to do the following: + +- Specify the initial velocity of the inertia when it begins by setting the property. + +- Specify the desired expansion of the manipulation when inertia ends by setting the property. + +- Specify the desired deceleration of the inertia by setting the property. + + You typically set either the or the , but not both. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationVelocities + + + Gets the rates of changes to the manipulation that occur before inertia starts. + The rates of changes to the manipulation that occur before inertia starts. + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Invokes a handler of this event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the container that the property is relative to. + The container that the property is relative to. + + + + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Point + + + Gets or sets the point from which the manipulation originated. + The point from which the manipulation originated. + + property is the point between all of the points of contact. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + ]]> + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> + + + Gets a collection of objects that represents the touch contacts for the manipulation. + A collection of objects that represents the touch contacts for the manipulation. + To be added. + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Input.InertiaRotationBehavior + + + Gets or sets the rate of slowdown of rotational inertial movement. + The rate of slowdown of rotational inertial movement. + + property to do the following: + +- Specify the initial velocity of the inertia when it begins by setting the property. + +- Specify the desired rotation of the manipulation when inertia ends by setting the property. + +- Specify the desired deceleration of the inertia by setting the property. + + You typically set either the or the , but not both. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + + System.Void + + + + + + The object that specifies the behavior of a manipulation during inertia. + Specifies the behavior of a manipulation during inertia. + + instead. + + ]]> + + + is . + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Input.InertiaTranslationBehavior + + + Gets or sets the rate of slowdown of linear inertial movement. + The rate of slowdown of linear inertial movement. + + property to do the following: + +- Specify the initial velocity of the inertia when it begins by setting the property. + +- Specify the desired position of the manipulation when inertia ends by setting the property. + +- Specify the desired deceleration of the inertia by setting the property. + + You typically set either the or the , but not both. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + ]]> + + + + + diff --git a/xml/System.Windows.Input/ManipulationStartedEventArgs.xml b/xml/System.Windows.Input/ManipulationStartedEventArgs.xml index c39caba6544..1a5c733c950 100644 --- a/xml/System.Windows.Input/ManipulationStartedEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationStartedEventArgs.xml @@ -1,195 +1,195 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputEventArgs - - - - Provides data for the event. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Cancels the manipulation. - - if manipulation was successfully, otherwise, . - - sends previous touch down events as mouse down events and future manipulation events do not occur. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Completes the manipulation without inertia. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the container that the property is relative to. - The container that the property is relative to. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Point - - - Gets the point from which the manipulation originated. - The point from which the manipulation originated. - - property is the point between the two points of contact. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> - - - Gets a collection of objects that represents the touch contacts for the manipulation. - A collection of objects that represents the touch contacts for the manipulation. - To be added. - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputEventArgs + + + + Provides data for the event. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Cancels the manipulation. + + if manipulation was successfully, otherwise, . + + sends previous touch down events as mouse down events and future manipulation events do not occur. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Completes the manipulation without inertia. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Invokes a handler of this event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the container that the property is relative to. + The container that the property is relative to. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Point + + + Gets the point from which the manipulation originated. + The point from which the manipulation originated. + + property is the point between the two points of contact. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> + + + Gets a collection of objects that represents the touch contacts for the manipulation. + A collection of objects that represents the touch contacts for the manipulation. + To be added. + + + + diff --git a/xml/System.Windows.Input/ManipulationStartingEventArgs.xml b/xml/System.Windows.Input/ManipulationStartingEventArgs.xml index 41c3860916c..9419c421cd5 100644 --- a/xml/System.Windows.Input/ManipulationStartingEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationStartingEventArgs.xml @@ -1,335 +1,335 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputEventArgs - - - - Provides data for the , event. - - enable you to specify the behavior of a manipulation. Use the to do the following: - -- Specify that the position should be relative to an element by setting the property. - -- Specify whether single-finger manipulation are enabled by setting the property. - -- Specify which types of manipulation are enabled by setting the property to a enumeration. - -- Specify the center of a single-finger rotation by setting the property. - -- Cancel the manipulation by setting the property to `true`. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Cancels the manipulation and promotes touch to mouse events. - - if touch was successfully promoted to mouse events, otherwise, . - - sends previous touch down events as mouse down events and future manipulation events do not occur. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Boolean - - - Gets or sets whether one finger can start a manipulation. - - one finger can start a manipulation; otherwise, . The default is . - - - - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.IInputElement - - - Gets or sets the container that all manipulation events and calculations are relative to. - The container that all manipulation events and calculations are relative to. The default is the element on which the event occurred. - - property. For example, you can make the manipulation positions relative to the parent of the element that receives the manipulation events. The event handler is the only place in which you can set the . - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - ]]> - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> - - - Gets a collection of objects that represents the touch contacts for the manipulation. - A collection of objects that represents the touch contacts for the manipulation. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.ManipulationModes - - - Gets or sets which types of manipulations are possible. - One of the enumeration values. The default is . - - - - The property is set to a value other than one or more of the enumerations value - - - - - - - - - - Property - - PresentationCore - 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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Input.ManipulationPivot - - - Gets or sets an object that describes the pivot for a single-point manipulation. - An object that describes the pivot for a single-point manipulation. - - property, the manipulation will contain rotation data when the user uses one finger during a manipulation. This is to simulate real-world situations where you can use one finger to rotate an object, such as a piece of paper on a table. If the is `null`, the user must use two fingers to cause rotation. - - For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - - - -## Examples - The following example shows an event handler for the event and sets the property. To test this example, follow the steps in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application) and replace the code in step 4 with this code. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/reportboundaryfeedbackexample.xaml.cs" id="Snippetmanipulationpivot"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/reportboundaryfeedbackexample.xaml.vb" id="Snippetmanipulationpivot"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.ComponentModel.Browsable(false)] - [<System.ComponentModel.Browsable(false)>] - - - - System.Void - - - - - - The parameter to add. - Adds parameters to the current manipulation of the specified element. - - instead. - - ]]> - - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputEventArgs + + + + Provides data for the , event. + + enable you to specify the behavior of a manipulation. Use the to do the following: + +- Specify that the position should be relative to an element by setting the property. + +- Specify whether single-finger manipulation are enabled by setting the property. + +- Specify which types of manipulation are enabled by setting the property to a enumeration. + +- Specify the center of a single-finger rotation by setting the property. + +- Cancel the manipulation by setting the property to `true`. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Cancels the manipulation and promotes touch to mouse events. + + if touch was successfully promoted to mouse events, otherwise, . + + sends previous touch down events as mouse down events and future manipulation events do not occur. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + To be added. + To be added. + Invokes a handler of this event. + To be added. + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Boolean + + + Gets or sets whether one finger can start a manipulation. + + one finger can start a manipulation; otherwise, . The default is . + + + + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.IInputElement + + + Gets or sets the container that all manipulation events and calculations are relative to. + The container that all manipulation events and calculations are relative to. The default is the element on which the event occurred. + + property. For example, you can make the manipulation positions relative to the parent of the element that receives the manipulation events. The event handler is the only place in which you can set the . + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + ]]> + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.Generic.IEnumerable<System.Windows.Input.IManipulator> + + + Gets a collection of objects that represents the touch contacts for the manipulation. + A collection of objects that represents the touch contacts for the manipulation. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.ManipulationModes + + + Gets or sets which types of manipulations are possible. + One of the enumeration values. The default is . + + + + The property is set to a value other than one or more of the enumerations value + + + + + + + + + + Property + + PresentationCore + 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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Input.ManipulationPivot + + + Gets or sets an object that describes the pivot for a single-point manipulation. + An object that describes the pivot for a single-point manipulation. + + property, the manipulation will contain rotation data when the user uses one finger during a manipulation. This is to simulate real-world situations where you can use one finger to rotate an object, such as a piece of paper on a table. If the is `null`, the user must use two fingers to cause rotation. + + For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + + + +## Examples + The following example shows an event handler for the event and sets the property. To test this example, follow the steps in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application) and replace the code in step 4 with this code. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/basicmanipulation/csharp/reportboundaryfeedbackexample.xaml.cs" id="Snippetmanipulationpivot"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/reportboundaryfeedbackexample.xaml.vb" id="Snippetmanipulationpivot"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.ComponentModel.Browsable(false)] + [<System.ComponentModel.Browsable(false)>] + + + + System.Void + + + + + + The parameter to add. + Adds parameters to the current manipulation of the specified element. + + instead. + + ]]> + + + + + diff --git a/xml/System.Windows.Input/MouseDevice.xml b/xml/System.Windows.Input/MouseDevice.xml index 775ad10c7c0..6d5b91dd512 100644 --- a/xml/System.Windows.Input/MouseDevice.xml +++ b/xml/System.Windows.Input/MouseDevice.xml @@ -1,769 +1,777 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputDevice - - - - Represents a mouse device. - - supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. - - For mouse related input, use the class. The class represents the mouse to an application and provides methods, properties, and events that reflect the state of the mouse. - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - - System.Windows.PresentationSource - - - Gets the that is reporting input for this device. - The source of input for this device. - To be added. - - - - - PresentationCore - 4.0.0.0 - - - Captures mouse input to the specified element. - - is not specified, the default is . - - To release mouse capture, call passing `null` as the element to capture. - - If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 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.Boolean - - - - - - The element to capture the mouse. - Captures mouse events to the specified element. - - if the element was able to capture the mouse; otherwise, . - - is not specified, the default is . - - To release mouse capture, call passing `null` as the element to capture. - - If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. - - ]]> - - - is not a or . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Boolean - - - - - - - The element to capture the mouse. - The capture policy to use. - Captures mouse input to the specified element using the specified . - - if the element was able to capture the mouse; otherwise, . - - passing `null` as the element to capture. - - If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. - - ]]> - - - is not a or . - - is not a valid . - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the that is captured by the mouse. - The element which is captured by the mouse. - - - - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the element that the mouse pointer is directly over. - The element the mouse pointer is over. - - reports the specific element in the composite control the mouse pointer is over and not the control itself. For example, depending on which part of a the pointer is over, the property could report the of the property or the . - - Use the property on and to determine whether the mouse is over an element, which includes its visual child elements or control compositing elements. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.MouseButtonState - - - - - - The button which is being queried. - Gets the state of the specified mouse button. - The state of the button. - To be added. - - - - - PresentationCore - 4.0.0.0 - - - Calculates the position of the mouse pointer, in client coordinates. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - - System.Windows.Point - - - - Calculates the position of the mouse pointer, in client coordinates. - The position of the mouse pointer, in client coordinates. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - - - The source in which to obtain the mouse position. - Calculates the position of the mouse pointer, in client coordinates, in the specified . - The position of the mouse pointer, in client coordinates, in the specified . - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Windows.Point - - - - - - The frame of reference in which to calculate the position of the mouse. - Gets the position of the mouse relative to a specified element. - The position of the mouse relative to the parameter . - - with the upper-left corner of element being the point of origin, 0,0. - - ]]> - - - is or is not a or . - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - Calculates the screen position of the mouse pointer. - The position of the mouse pointer. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.MouseButtonState - - - Gets the state of the left mouse button of this mouse device. - The state of the button. - To be added. - - - - - - - - - - - Property - - PresentationCore - 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.Input.MouseButtonState - - - The state of the middle button of this mouse device. - The state of the button. - To be added. - - - - - - - - - - - Property - - PresentationCore - 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.Input.Cursor - - - Gets or sets the cursor for the entire application. - The override cursor or if is not set. - - that is set to will be applied to the whole application. - - To clear the override , set to `null`. - - Setting to will force the mouse cursor not to be displayed, but mouse events are still processed. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.MouseButtonState - - - Gets the state of the right button of this mouse device. - The state of the button. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Boolean - - - - - - The cursor to set the mouse pointer to. - Sets the mouse pointer to the specified . - - if the mouse cursor is set; otherwise, . - - , but rather it applies to the whole application. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - Forces the mouse to resynchronize. - - monitors layout changes and calls . There are cases in which the mouse input system must be forced to update for it to respond to changes. For example, you must resynchronize the mouse on a timer. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the that the input from this mouse device is sent to. - The element that receives the input. - - is the object the mouse is over or the object with mouse capture. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Forces the mouse cursor to update. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.MouseButtonState - - - Gets the state of the first extended button on this mouse device. - The state of the button. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Input.MouseButtonState - - - Gets the state of the second extended button of this mouse device. - The state of the button. - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputDevice + + + + Represents a mouse device. + + supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. + + For mouse related input, use the class. The class represents the mouse to an application and provides methods, properties, and events that reflect the state of the mouse. + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + + System.Windows.PresentationSource + + + Gets the that is reporting input for this device. + The source of input for this device. + + + + + + + + PresentationCore + 4.0.0.0 + + + Captures mouse input to the specified element. + + is not specified, the default is . + + To release mouse capture, call passing `null` as the element to capture. + + If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 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.Boolean + + + + + + The element to capture the mouse. + Captures mouse events to the specified element. + + if the element was able to capture the mouse; otherwise, . + + is not specified, the default is . + + To release mouse capture, call passing `null` as the element to capture. + + If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. + + ]]> + + + is not a or . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Boolean + + + + + + + The element to capture the mouse. + The capture policy to use. + Captures mouse input to the specified element using the specified . + + if the element was able to capture the mouse; otherwise, . + + passing `null` as the element to capture. + + If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. + + ]]> + + + is not a or . + + is not a valid . + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the that is captured by the mouse. + The element which is captured by the mouse. + + + + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the element that the mouse pointer is directly over. + The element the mouse pointer is over. + + reports the specific element in the composite control the mouse pointer is over and not the control itself. For example, depending on which part of a the pointer is over, the property could report the of the property or the . + + Use the property on and to determine whether the mouse is over an element, which includes its visual child elements or control compositing elements. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.MouseButtonState + + + + + + The button which is being queried. + Gets the state of the specified mouse button. + The state of the button. + To be added. + + + + + PresentationCore + 4.0.0.0 + + + Calculates the position of the mouse pointer, in client coordinates. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + + System.Windows.Point + + + + Calculates the position of the mouse pointer, in client coordinates. + The position of the mouse pointer, in client coordinates. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + + + The source in which to obtain the mouse position. + Calculates the position of the mouse pointer, in client coordinates, in the specified . + The position of the mouse pointer, in client coordinates, in the specified . + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Windows.Point + + + + + + The frame of reference in which to calculate the position of the mouse. + Gets the position of the mouse relative to a specified element. + The position of the mouse relative to the parameter . + + with the upper-left corner of element being the point of origin, 0,0. + + ]]> + + + is or is not a or . + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + Calculates the screen position of the mouse pointer. + The position of the mouse pointer. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.MouseButtonState + + + Gets the state of the left mouse button of this mouse device. + The state of the button. + To be added. + + + + + + + + + + + Property + + PresentationCore + 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.Input.MouseButtonState + + + The state of the middle button of this mouse device. + The state of the button. + To be added. + + + + + + + + + + + Property + + PresentationCore + 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.Input.Cursor + + + Gets or sets the cursor for the entire application. + The override cursor or if is not set. + + that is set to will be applied to the whole application. + + To clear the override , set to `null`. + + Setting to will force the mouse cursor not to be displayed, but mouse events are still processed. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.MouseButtonState + + + Gets the state of the right button of this mouse device. + The state of the button. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Boolean + + + + + + The cursor to set the mouse pointer to. + Sets the mouse pointer to the specified . + + if the mouse cursor is set; otherwise, . + + , but rather it applies to the whole application. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + Forces the mouse to resynchronize. + + monitors layout changes and calls . There are cases in which the mouse input system must be forced to update for it to respond to changes. For example, you must resynchronize the mouse on a timer. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the that the input from this mouse device is sent to. + The element that receives the input. + + is the object the mouse is over or the object with mouse capture. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Forces the mouse cursor to update. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.MouseButtonState + + + Gets the state of the first extended button on this mouse device. + The state of the button. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Input.MouseButtonState + + + Gets the state of the second extended button of this mouse device. + The state of the button. + To be added. + + + + diff --git a/xml/System.Windows.Input/StylusButton.xml b/xml/System.Windows.Input/StylusButton.xml index d9098fe4622..7015e646ebb 100644 --- a/xml/System.Windows.Input/StylusButton.xml +++ b/xml/System.Windows.Input/StylusButton.xml @@ -1,229 +1,230 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Represents a button on a stylus. - - - - - - - - - - - - - Property - - PresentationCore - 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.Guid - - - Gets the that represents the stylus button. - The property that represents the stylus button. - - - - - - - - - - - - - Property - - PresentationCore - 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.String - - - Gets the name of the stylus button. - The name of the stylus button. - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet25"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet25"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.StylusButtonState - - - Gets the state of the stylus button. - One of the values. - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet26"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet26"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.StylusDevice - - - Gets the stylus that this button belongs to. - A that represents the stylus of the current . - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet27"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet27"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Creates a string representation of the . - To be added. - - method. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet28"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet28"::: - - ]]> - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Represents a button on a stylus. + + + + + + + + + + + + + Property + + PresentationCore + 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.Guid + + + Gets the that represents the stylus button. + The property that represents the stylus button. + + + + + + + + + + + + + Property + + PresentationCore + 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.String + + + Gets the name of the stylus button. + The name of the stylus button. + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet25"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet25"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.StylusButtonState + + + Gets the state of the stylus button. + One of the values. + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet26"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet26"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.StylusDevice + + + Gets the stylus that this button belongs to. + A that represents the stylus of the current . + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet27"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet27"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Creates a string representation of the . + + name of the tablet + + method. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/StylusSnippets/CSharp/Window1.xaml.cs" id="Snippet28"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/StylusSnippets/VisualBasic/Window1.xaml.vb" id="Snippet28"::: + + ]]> + + + + + diff --git a/xml/System.Windows.Input/StylusPointProperty.xml b/xml/System.Windows.Input/StylusPointProperty.xml index 1fb40364da5..61535c0952c 100644 --- a/xml/System.Windows.Input/StylusPointProperty.xml +++ b/xml/System.Windows.Input/StylusPointProperty.xml @@ -1,223 +1,231 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - Represents a property stored in a . - - represents properties in such as the (x, y) coordinates, pressure, and so on. You can inherit from the class to customize the information stored for each property. The Windows Presentation Framework ships with the class that inherits from and specifies the minimum and maximum values, resolution, and unit used for each property. - - - -## Examples - The following example creates the object from a and gets the information for each in the . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet2"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet4"::: - - ]]> - - - - - - PresentationCore - 4.0.0.0 - - - Initializes a new instance of the class. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - The to copy. - Initializes a new instance of the class, copying the specified . - To be added. - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - - - - The that uniquely identifies the . - - to indicate that the property represents a button on the stylus; otherwise, . - Initializes a new instance of the class using the specified GUID. - - . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet25"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet25"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Guid - - - Gets the GUID for the current . - The GUID for the current . - - from a and gets the information for each in the . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet2"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet4"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Boolean - - - Gets whether the represents a button on the stylus. - - if the represents a button on the stylus; otherwise, . - - object from a and gets the information for each in the . - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet2"::: -:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet4"::: - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.String - - - - Returns a string that represents the current object. - A string that represents the current object. - To be added. - - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + Represents a property stored in a . + + represents properties in such as the (x, y) coordinates, pressure, and so on. You can inherit from the class to customize the information stored for each property. The Windows Presentation Framework ships with the class that inherits from and specifies the minimum and maximum values, resolution, and unit used for each property. + + + +## Examples + The following example creates the object from a and gets the information for each in the . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet2"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet4"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet4"::: + + ]]> + + + + + + PresentationCore + 4.0.0.0 + + + Initializes a new instance of the class. + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + The to copy. + Initializes a new instance of the class, copying the specified . + + + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + + + + The that uniquely identifies the . + + to indicate that the property represents a button on the stylus; otherwise, . + Initializes a new instance of the class using the specified GUID. + + . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet25"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet25"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Guid + + + Gets the GUID for the current . + The GUID for the current . + + from a and gets the information for each in the . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet2"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet4"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet4"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Boolean + + + Gets whether the represents a button on the stylus. + + if the represents a button on the stylus; otherwise, . + + object from a and gets the information for each in the . + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet2"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet2"::: +:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/PacketSpy/CSharp/Window1.xaml.cs" id="Snippet4"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/PacketSpy/VisualBasic/Window1.xaml.vb" id="Snippet4"::: + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.String + + + + Returns a string that represents the current object. + A string that represents the current object. + To be added. + + + + + diff --git a/xml/System.Windows.Input/TabletDeviceCollection.xml b/xml/System.Windows.Input/TabletDeviceCollection.xml index 5a8c4349077..cc75c0070ce 100644 --- a/xml/System.Windows.Input/TabletDeviceCollection.xml +++ b/xml/System.Windows.Input/TabletDeviceCollection.xml @@ -1,314 +1,322 @@ - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - - System.Collections.ICollection - - - System.Collections.IEnumerable - - - - Contains the objects that represent the digitizer devices of a tablet device. - - class. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet15"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet15"::: - - ]]> - - - - - - - - - - Constructor - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.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 elements copied from the collection. The array must have zero-based indexing. - The zero-based index in the array parameter where copying begins. - Copies all elements in the current collection to the specified one-dimensional array, starting at the specified destination array index. - - method. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet18"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet18"::: - - ]]> - - If + collection count is greater than or equal to . - If is . - If is less than 0 or is greater than or equal to . - - - - - - - - - - Property - - P:System.Collections.ICollection.Count - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Int32 - - - Gets the number of objects in the collection. - The number of objects in the collection. - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet16"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet16"::: - - ]]> - - - - - - - - - - - Property - - P:System.Collections.ICollection.IsSynchronized - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether access to the collection is synchronized (thread safe). - - if access to the collection is synchronized (thread safe); otherwise, . The default is . - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet17"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet17"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.TabletDevice - - - - - - The zero-based index of the that is retrieved from the collection. - Gets the object at the specified index within the collection. - The object at the specified index within the collection. - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet19"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet19"::: - - ]]> - - If is less than 0 or is greater than or equal to the number of objects in the collection. - - - - - - - - - - Property - - P:System.Collections.ICollection.SyncRoot - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Object - - - Gets an object that can be used to synchronize access to the collection. - An object that can be used to synchronize access to the collection. - - property. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet17"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet17"::: - - ]]> - - - - - - - - - - - Method - - M:System.Collections.ICollection.CopyTo(System.Array,System.Int32) - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The array. - The index. - This member supports the .NET Framework and is not intended to be used from your code. - To be added. - - - - - - - - - - Method - - M:System.Collections.IEnumerable.GetEnumerator - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Collections.IEnumerator - - - - This member supports the .NET Framework and is not intended to be used from your code. - To be added. - To be added. - - - - + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + + System.Collections.ICollection + + + System.Collections.IEnumerable + + + + Contains the objects that represent the digitizer devices of a tablet device. + + class. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet15"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet15"::: + + ]]> + + + + + + + + + + Constructor + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.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 elements copied from the collection. The array must have zero-based indexing. + The zero-based index in the array parameter where copying begins. + Copies all elements in the current collection to the specified one-dimensional array, starting at the specified destination array index. + + method. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet18"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet18"::: + + ]]> + + If + collection count is greater than or equal to . + If is . + If is less than 0 or is greater than or equal to . + + + + + + + + + + Property + + P:System.Collections.ICollection.Count + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Int32 + + + Gets the number of objects in the collection. + The number of objects in the collection. + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet16"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet16"::: + + ]]> + + + + + + + + + + + Property + + P:System.Collections.ICollection.IsSynchronized + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether access to the collection is synchronized (thread safe). + + if access to the collection is synchronized (thread safe); otherwise, . The default is . + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet17"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet17"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.TabletDevice + + + + + + The zero-based index of the that is retrieved from the collection. + Gets the object at the specified index within the collection. + The object at the specified index within the collection. + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet19"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet19"::: + + ]]> + + If is less than 0 or is greater than or equal to the number of objects in the collection. + + + + + + + + + + Property + + P:System.Collections.ICollection.SyncRoot + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Object + + + Gets an object that can be used to synchronize access to the collection. + An object that can be used to synchronize access to the collection. + + property. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/HwCaps/CSharp/Window1.xaml.cs" id="Snippet17"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/HwCaps/VisualBasic/Window1.xaml.vb" id="Snippet17"::: + + ]]> + + + + + + + + + + + Method + + M:System.Collections.ICollection.CopyTo(System.Array,System.Int32) + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The array. + The index. + This member supports the .NET Framework and is not intended to be used from your code. + To be added. + + + + + + + + + + Method + + M:System.Collections.IEnumerable.GetEnumerator + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Collections.IEnumerator + + + + This member supports the .NET Framework and is not intended to be used from your code. + An object that can be used to iterate through the collection. + + instance is cast to an interface. + + ]]> + + + + + diff --git a/xml/System.Windows.Input/TouchDevice.xml b/xml/System.Windows.Input/TouchDevice.xml index 2dbe7e5a8ff..c3a8f4f47e2 100644 --- a/xml/System.Windows.Input/TouchDevice.xml +++ b/xml/System.Windows.Input/TouchDevice.xml @@ -1,1006 +1,1032 @@ - - - - - - - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.InputDevice - - - - System.Windows.Input.IManipulator - - - - Represents a single touch input produced by a finger on a touchscreen. - - by using the property. A represents a single touch on a screen. If multiple touches are present, use the property to distinguish between them. - -> [!NOTE] -> This class contains an inheritance demand at the class level that applies to all members. A is thrown when the derived class does not have full-trust permission. For more information about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). - - - -## Examples - The following example enables you to create simple patterns on a by dragging two fingers on a touchscreen. Each touch is represented by a in the . The pattern is created by drawing a line between the touch points that are provided by the touches. This example requires a Windows Touch-compatible screen. - - The following markup creates the user interface, which consists of a that is centered in a grid, and attaches the event handlers for the touch events. - - :::code language="xaml" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml" id="Snippet000"::: - - The following code handles the touch events. When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet100"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet100"::: - - ]]> - - - - - - - - - - - Constructor - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - - - - A unique identifier for the touch device. - Called from constructors in derived classes to initialize the class. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Adds the to the input messaging system. - - should call this method to activate the current device. - - ]]> - - The device is already activated. - - - - - - - - - - - Event - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the is added to the input messaging system. - To be added. - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - - System.Windows.PresentationSource - - - Gets the that is reporting input for this device. - The source that is reporting input for this device. - To be added. - - - - - PresentationCore - 4.0.0.0 - - - Captures a touch to the specified element. - - - - - - - - - - Method - - PresentationCore - 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.Boolean - - - - - - The element that captures the touch input. - Captures a touch to the specified element by using the capture mode. - - if the element was able to capture the touch; otherwise, . - - cannot be captured to an element if it is already captured to another element. - - - -## Examples - The following example handles the events that occur on a . When a touch is pressed on the , the is captured to the . - - This example is part of a larger example that is available in the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet110"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet110"::: - - ]]> - - - is not a , , or . - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - - The element that captures the touch. - The capture policy to use. - Captures a touch to the specified element by using the specified . - - if the element was able to capture the touch; otherwise, . - - cannot be captured to an element if it is already captured to another element. - - ]]> - - - is not a , , or . - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the element that captured the . - The element that captured the . - - events that occur on a . It checks the property to verify that the device that raised the event is captured to the . If it is, the is released. - - This example is part of a larger example that is available in the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet130"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet130"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.Input.CaptureMode - - - Gets the capture policy of the . - The capture policy of the . - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Removes the from the input messaging system. - - should call this method to deactivate the current device. - - A event is raised without the corresponding event. - - ]]> - - The device is not activated. - - - - - - - - - - - - - - Event - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the is removed from the input messaging system. - To be added. - - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the element that the touch contact point is directly over. - The element that the touch contact point is directly over. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.TouchPointCollection - - - - - - The element that defines the coordinate space. - When overridden in a derived class, returns all touch points that are collected between the most recent and previous touch events. - All touch points that were collected between the most recent and previous touch events. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Input.TouchPoint - - - - - - The element that defines the coordinate space. - Returns the current position of the touch device relative to the specified element. - The current position of the touch device relative to the specified element. - To be added. - - - - - - - - - - Property - - PresentationCore - 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.Int32 - - - Gets the unique identifier of the , as provided by the operating system. - The unique identifier of the . - - represents a single touch on a screen. If multiple touches are present, use the property to distinguish between them. - - - -## Examples - The following example handles the events that occur on a . When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - - This example is part of a larger example available in the class overview. - - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet120"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet120"::: - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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 a value that indicates whether the device is active. - - if the device is active; otherwise, . - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - - - - The element that captures the touch input. - The capture policy. - Called when a touch is captured to an element. - - method has no default implementation. It can be overridden in a derived class to perform any actions that are required when the touch input is captured. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - - - - to cancel the action; otherwise, . - Called when a manipulation has ended. - To be added. - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Called when a manipulation is started. - - method has no default implementation. It can be overridden in a derived class to perform any actions that are required when touch manipulation is started. - - ]]> - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Reports that a touch is pressed on an element. - - if the event was handled; otherwise, . - - should call this method to raise the event. A event is raised before the event. - - ]]> - - - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Reports that a touch is moving across an element. - - if the event was handled; otherwise, . - - should call this method to raise the event. - - ]]> - - - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Reports that a touch was lifted from an element. - - if the event was handled; otherwise, . - - should call this method to raise the event. A event is raised after the event. - - ]]> - - - - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - - - The source that reports input for this device. - Sets the that is reporting input for this device. - To be added. - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - Forces the to synchronize the user interface with underlying touch points. - - events to be raised. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Input.IManipulator.GetPosition(System.Windows.IInputElement) - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.Point - - - - - - The element to use as the frame of reference for calculating the position of the . - Returns the position of the object. - The position of the object. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Property - - P:System.Windows.Input.IManipulator.Id - - - PresentationCore - 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.Int32 - - - Gets the unique identifier of the as provided by the operating system. - The unique identifier of the . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Input.IManipulator.ManipulationEnded(System.Boolean) - - - PresentationCore - 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.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - - - - to cancel the action; otherwise, . - Occurs when a manipulation has ended. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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.IInputElement - - - Gets the element that receives input from the . - The element that receives input from the . - To be added. - - - - - - - - - - - Event - - E:System.Windows.Input.IManipulator.Updated - - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when a touch message is sent. - To be added. - - - - + + + + + + + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.InputDevice + + + + System.Windows.Input.IManipulator + + + + Represents a single touch input produced by a finger on a touchscreen. + + by using the property. A represents a single touch on a screen. If multiple touches are present, use the property to distinguish between them. + +> [!NOTE] +> This class contains an inheritance demand at the class level that applies to all members. A is thrown when the derived class does not have full-trust permission. For more information about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). + + + +## Examples + The following example enables you to create simple patterns on a by dragging two fingers on a touchscreen. Each touch is represented by a in the . The pattern is created by drawing a line between the touch points that are provided by the touches. This example requires a Windows Touch-compatible screen. + + The following markup creates the user interface, which consists of a that is centered in a grid, and attaches the event handlers for the touch events. + + :::code language="xaml" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml" id="Snippet000"::: + + The following code handles the touch events. When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet100"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet100"::: + + ]]> + + + + + + + + + + + Constructor + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + + + + A unique identifier for the touch device. + Called from constructors in derived classes to initialize the class. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Adds the to the input messaging system. + + should call this method to activate the current device. + + ]]> + + The device is already activated. + + + + + + + + + + + Event + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the is added to the input messaging system. + To be added. + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + + System.Windows.PresentationSource + + + Gets the that is reporting input for this device. + The source that is reporting input for this device. + + + + + + + + PresentationCore + 4.0.0.0 + + + Captures a touch to the specified element. + + + + + + + + + + Method + + PresentationCore + 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.Boolean + + + + + + The element that captures the touch input. + Captures a touch to the specified element by using the capture mode. + + if the element was able to capture the touch; otherwise, . + + cannot be captured to an element if it is already captured to another element. + + + +## Examples + The following example handles the events that occur on a . When a touch is pressed on the , the is captured to the . + + This example is part of a larger example that is available in the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet110"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet110"::: + + ]]> + + + is not a , , or . + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + + The element that captures the touch. + The capture policy to use. + Captures a touch to the specified element by using the specified . + + if the element was able to capture the touch; otherwise, . + + cannot be captured to an element if it is already captured to another element. + + ]]> + + + is not a , , or . + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the element that captured the . + The element that captured the . + + events that occur on a . It checks the property to verify that the device that raised the event is captured to the . If it is, the is released. + + This example is part of a larger example that is available in the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet130"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet130"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.Input.CaptureMode + + + Gets the capture policy of the . + The capture policy of the . + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Removes the from the input messaging system. + + should call this method to deactivate the current device. + + A event is raised without the corresponding event. + + ]]> + + The device is not activated. + + + + + + + + + + + + + + Event + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the is removed from the input messaging system. + To be added. + + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the element that the touch contact point is directly over. + The element that the touch contact point is directly over. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.TouchPointCollection + + + + + + The element that defines the coordinate space. + When overridden in a derived class, returns all touch points that are collected between the most recent and previous touch events. + All touch points that were collected between the most recent and previous touch events. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Input.TouchPoint + + + + + + The element that defines the coordinate space. + Returns the current position of the touch device relative to the specified element. + The current position of the touch device relative to the specified element. + To be added. + + + + + + + + + + Property + + PresentationCore + 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.Int32 + + + Gets the unique identifier of the , as provided by the operating system. + The unique identifier of the . + + represents a single touch on a screen. If multiple touches are present, use the property to distinguish between them. + + + +## Examples + The following example handles the events that occur on a . When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + + This example is part of a larger example available in the class overview. + + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Wpf/toucheventssample/cs/mainwindow.xaml.cs" id="Snippet120"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Wpf/toucheventssample/vb/mainwindow.xaml.vb" id="Snippet120"::: + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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 a value that indicates whether the device is active. + + if the device is active; otherwise, . + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + + + + The element that captures the touch input. + The capture policy. + Called when a touch is captured to an element. + + method has no default implementation. It can be overridden in a derived class to perform any actions that are required when the touch input is captured. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + + + + to cancel the action; otherwise, . + Called when a manipulation has ended. + To be added. + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Called when a manipulation is started. + + method has no default implementation. It can be overridden in a derived class to perform any actions that are required when touch manipulation is started. + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Reports that a touch is pressed on an element. + + if the event was handled; otherwise, . + + should call this method to raise the event. A event is raised before the event. + + ]]> + + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Reports that a touch is moving across an element. + + if the event was handled; otherwise, . + + should call this method to raise the event. + + ]]> + + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Reports that a touch was lifted from an element. + + if the event was handled; otherwise, . + + should call this method to raise the event. A event is raised after the event. + + ]]> + + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + + + The source that reports input for this device. + Sets the that is reporting input for this device. + To be added. + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + Forces the to synchronize the user interface with underlying touch points. + + events to be raised. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Input.IManipulator.GetPosition(System.Windows.IInputElement) + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.Point + + + + + + The element to use as the frame of reference for calculating the position of the . + Returns the position of the object. + The position of the object. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + P:System.Windows.Input.IManipulator.Id + + + PresentationCore + 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.Int32 + + + Gets the unique identifier of the as provided by the operating system. + The unique identifier of the . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Input.IManipulator.ManipulationEnded(System.Boolean) + + + PresentationCore + 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.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + + + + to cancel the action; otherwise, . + Occurs when a manipulation has ended. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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.IInputElement + + + Gets the element that receives input from the . + The element that receives input from the . + + + + + + + + + + + + + + Event + + E:System.Windows.Input.IManipulator.Updated + + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when a touch message is sent. + To be added. + + + + diff --git a/xml/System.Windows.Interop/HwndSource.xml b/xml/System.Windows.Interop/HwndSource.xml index 35211f70440..8cebd75c1d3 100644 --- a/xml/System.Windows.Interop/HwndSource.xml +++ b/xml/System.Windows.Interop/HwndSource.xml @@ -1,1725 +1,1761 @@ - - - - - - - - - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.PresentationSource - - - - System.IDisposable - - - System.Windows.Interop.IKeyboardInputSink - - - System.Windows.Interop.IWin32Window - - - - Presents Windows Presentation Foundation (WPF) content in a Win32 window. - - [!IMPORTANT] -> Many members of this class are unavailable in the Internet security zone. - - An implements a Win32 window that can contain WPF content. The WPF content in the window is arranged, measured, and rendered; and is interactive to input. Because the is specifically designed to interoperate with Win32, this class exposes several low-level Win32 features. You can use this class to do the following: - -- Specify window styles, window class styles, and extended window styles. - -- Hook the window procedure. - -- Provide access to the window handle (HWND). - -- Destroy the window. - - The class is designed for general interoperability and is not designed as a managed HWND wrapper. In general, it does not provide managed methods for manipulating the window or properties for inspecting its state. Instead, the class provides access to the Win32 window handle (HWND) through the property, which can be passed by means of PInvoke techniques to Win32 APIs in order to manipulate the window. - - **Construction** - - Many aspects of the can only be specified at construction time. To create an , first create an structure and populate it with the desired parameters. These parameters include the following: - -- The class, window, and extended window styles. You must use PInvoke to change the styles after the window is created. Not all styles can be changed after the window is created. Consult the Win32 documentation before changing window styles. - -- The initial position of the window. - -- The initial size of the window, which includes whether the size is specified or should be determined from the determined size of the WPF content. - -- The parent window. - -- The to include in the window procedure chain. If you specify a hook at construction time, it receives all messages for the window. You can use to add a hook after the window is created. - -- The transparency settings. A top-level window can be configured to blend with the other windows on the desktop according to the per-pixel transparency of the WPF content. To enable this, set the property in the to `true`. This property can only be specified at construction time, and only through the constructor signature, and it imposes several limitations. - - After you populate the structure, pass it to the constructor for the . - - **Object Lifetime** - - An is a regular common language runtime (CLR) object, and its lifetime is managed by the garbage collector. Because the represents an unmanaged resource, implements . Synchronously calling immediately destroys the Win32 window if called from the owner thread. If called from another thread, the Win32 window is destroyed asynchronously. Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios. - - **Window Procedures** - - The class implements its own window procedure. This window procedure is used to process important window messages, such as those related to layout, rendering, and input. However, you can also hook the window procedure for your own use. You can specify your own hook during construction by setting the property, or you can also use and to add and remove hooks after the window is created. The hooks are called by last-in first-out order, which enables your hooks to execute before the built-in processing. The actual hooks are held by a weak reference. Therefore, make sure that you manage the lifetime of your hook delegate. - - For more information about and other interoperation classes, see [WPF and Win32 Interoperation](/dotnet/framework/wpf/advanced/wpf-and-win32-interoperation). - - Notice how the constructors for take parameters that resemble the parameters for Win32 functions such as [CreateWindowEx](https://go.microsoft.com/fwlink/?LinkID=98462). - - Scale transformations should not be applied to the of an . See Remarks for . - - ]]> - - - - - - - PresentationCore - 4.0.0.0 - - - Initializes a new instance of the class. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - ]]> - - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - - - - A structure that contains the parameters that are required to create the window. - Initializes a new instance of the class by using a structure that contains the initial settings. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - This constructor signature might be more convenient in certain situations, because the default structure contains some appropriate initial default values. - -> [!IMPORTANT] -> If you use this signature, do not use the default constructor to construct the structure for the `parameters` value. You must use the constructor that enables you to specify an initial window name. If you use the default constructor and create an with it, that does not display because an initial window name is a construction requirement for the represented HWND. - - ]]> - - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - - - - - - - - - - The Win32 class styles for the window. - The Win32 styles for the window. - The extended Win32 styles for the window. - The position of the window's left edge. - The position of the window's upper edge. - The name of the window. - The handle of the window's parent window. - Initializes a new instance of the class with a specified class style, style, extended style, x-y position, name, and parent window. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - ]]> - - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - - - - - - - - - - - - The Win32 class styles for the window. - The Win32 styles for the window. - The extended Win32 styles for the window. - The position of the window's left edge. - The position of the window's upper edge. - The width of the window. - The height of the window. - The name of the window. - The handle of the window's parent window. - Initializes a new instance of the class with a specified class style, style, extended style, x-y position, width, height, name, and parent window. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - ]]> - - - - - - - - - - - Constructor - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - - - - - - - - - - - - - The Win32 class styles for the window. - The Win32 styles for the window. - The extended Win32 styles for the window. - The position of the window's left edge. - The position of the window's upper edge. - The width of the window. - The height of the window. - The name of the window. - The handle of the window's parent window. - - to have the layout manager include the non-client area for sizing; otherwise, . - Initializes a new instance of the class with a specified class style, style, extended style, x-y position, width, height, name, and parent window, and by specifying whether the window is autosized. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 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 the value that determines whether to acquire Win32 focus for the WPF containing window for this . - - to acquire Win32 focus for the WPF containing window when the user interacts with menus; otherwise, . - - by setting the parameter. - - The default value is determined by the property. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - - - The handler implementation (based on the delegate) that receives the window messages. - Adds an event handler that receives all window messages. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - Most Win32 messages that reach the have an approximate WPF equivalent. You use to handle the cases where the message has no WPF equivalent. - - The delegate resembles the parameter profile of a Win32 main window procedure. All window messages that the main window procedure of the parent window receives are also forwarded to the delegates. - - Hooks are called in the order that they were added. If any hook returns `handled`=`true` for a message, the hooks after it in the call order are not called for that message. - - ]]> - - - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.AutoResizedEventHandler - - - Occurs when layout causes the to automatically resize. - - is to automatically resize content and the window region based on changes reported through the WPF layout system. The window does not resize if it is currently minimized or if is set to . - - ]]> - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__1))] - [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__1))>] - - - [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__24))] - [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__24))>] - - - [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__29))] - [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__29))>] - - - [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__31))] - [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__31))>] - - - - System.Collections.Generic.IEnumerable<System.Windows.Interop.IKeyboardInputSink> - - - Gets a sequence of registered input sinks. - An enumeration of keyboard input sinks. - To be added. - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - - System.Windows.Interop.HwndTarget - - - Gets the visual manager for the hosted window. - The visual manager. - - in order to override the value that returns. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Runtime.InteropServices.HandleRef - - - - Gets the window handle for the . The window handle is packaged as part of a structure. - A structure that contains the window handle for this . - - to reference the from Win32 code. Use the handle for operations such as message handling and window behavior. - - To get just the handle, use . - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - Gets or sets the default value for new instances of . - - to acquire Win32 focus for the WPF containing window when the user interacts with menus; otherwise, . The default is . - - have set to this default value, unless a different value is passed as a parameter to the constructor for a specific instance, by using the property. - - ]]> - - - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Void - - - - Releases all managed resources that are used by the , and raises the event. - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. - - Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios, because an in some interoperation scenarios can generate several references to it across the interoperation boundaries that might prevent timely garbage collection. - - ]]> - - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the method is called on this object. - - event is raised before any resources are released by the . The event indicates that the object that raises the event is about to have all references to it removed. - - Use and the property to avoid calling twice (which raises an exception). - - ]]> - - - - - - - - - - - - - Event - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.HwndDpiChangedEventHandler - - - Occurs when the DPI of the monitor of this Hwnd has changed, or the Hwnd is moved to a monitor with a different DPI. - To be added. - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Windows.Interop.HwndSource - - - - - - The provided window handle. - Returns the object of the specified window. - The object for the window that is specified by the window handle. - - [!IMPORTANT] -> This method is not available in the Internet security zone, or for partial trust in general. - - You can use this method to return an for a window that is not explicitly an interoperation window. The procedure for this is: - -1. Create a instance (providing the main as a constructor parameter). - -2. Get the value of the property from that instance. - -3. Pass that HWND value as a parameter to . - - This technique can be useful if you then want to add general message processing to the window. However, whenever you create an , you are also responsible for destroying it. This is true even if the object for an application is disposed. For more information, see Remarks on . - - ]]> - - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [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.Windows.Media.CompositionTarget - - - - Gets the visual target of the window. - Returns the visual target of the window. - - . - - ]]> - - - Implement this method to return a type-specific visual target. implements this method to return . - - - - - - - - - - - - - Property - - P:System.Windows.Interop.IWin32Window.Handle - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - - System.IntPtr - - - Gets the window handle for this . - The window handle. - - [!IMPORTANT] -> This property is not available in the Internet security zone. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - Gets a value that indicates whether the sink or one of its contained components has focus. - - if the sink or one of its contained components has focus; otherwise, . - To be added. - - - - - - - - - - - Property - - PresentationCore - 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.Boolean - - - Gets a value that indicates whether has been called on this . - - if the object has had called on it; otherwise, . - - initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. The event is raised and the value of becomes `false` as soon as is called. During this time, if you call again, raises an exception. - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - [set: System.Security.SecurityCritical] - [<set: System.Security.SecurityCritical>] - - - - System.Windows.Interop.IKeyboardInputSite - - - Gets or sets a reference to the component's container's interface. - A reference to the container's interface; or if no site is assigned. The default is . - To be added. - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Void - - - - - - The event arguments. - Called when the DPI is going to change for the window. - - [!IMPORTANT] -> This method accesses critical data . - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Boolean - - - - - - - The message for the mnemonic and associated data. - Modifier keys. - Called when one of the mnemonics (access keys) for this sink is invoked. - - if the message was handled; otherwise, . - To be added. - - is not WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, or WM_DEADCHAR. - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Windows.Interop.IKeyboardInputSite - - - - - - The sink of the contained component. - Registers the interface of a contained component. - The site of the contained component. - To be added. - - - - - - - - - - - Method - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Void - - - - - - The event handler to remove. - Removes the event handlers that were added by . - - [!IMPORTANT] -> This method is not available in the Internet security zone. - - ]]> - - - - - - - - - - - - - Property - - PresentationCore - 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.Input.RestoreFocusMode - - - Gets the for the window. - The for the window. - - constructor by using the property. - - ]]> - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - [set: System.Security.SecurityCritical] - [<set: System.Security.SecurityCritical>] - - - - System.Windows.Media.Visual - - - Gets or sets the of the window. - The root visual object of the window. - - or another root visual to the . - - Scale transformations should not be applied to the of an because this can disable behavior. The content will scale, but the enclosing window will not. Instead of applying the transformation to the object that is the , apply the transformation to an object that is a child element of the . You might need to add an extra enclosing element to the WPF content, such as a panel, in order to provide a scaleable object. - - You can add a as the root visual, but only as a top-level window (with WS_OVERLAPPED), not as a child window. - - ]]> - - - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Windows.SizeToContent - - - Get or sets whether and how the window is sized to its content. - One of the enumeration values. The default value is , which specifies that the window is not sized to its content. - - of an , because this can disable behavior. See Remarks for . - - ]]> - - - - - - - - - - - - - Event - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.EventHandler - - - Occurs when the value of the property changes. - - event is only raised when user interaction causes the change. If you set in code, the event is not raised. - - ]]> - - - - - - - - - - - - - Method - - M:System.Windows.Interop.IKeyboardInputSink.HasFocusWithin - - - PresentationCore - 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.Boolean - - - - For a description of this member, see . - - if the sink or one of its contained components has focus; otherwise, . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Property - - P:System.Windows.Interop.IKeyboardInputSink.KeyboardInputSite - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - [set: System.Security.SecurityCritical] - [<set: System.Security.SecurityCritical>] - - - [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")>] - - - [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] - [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] - - - - System.Windows.Interop.IKeyboardInputSite - - - For a description of this member, see . - A reference to the container's interface. - - instance is cast to an interface. - - ]]> - - WPF and Win32 Interoperation Overview - Input Overview - - - - - - - - - - Method - - M:System.Windows.Interop.IKeyboardInputSink.OnMnemonic(System.Windows.Interop.MSG@,System.Windows.Input.ModifierKeys) - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - [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.Boolean - - - - - - - The message for the mnemonic and associated data. Do not modify this message structure. It is passed by reference for performance reasons only. - Modifier keys. - For a description of this member, see . - - if the message was handled; otherwise, . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Interop.IKeyboardInputSink.RegisterKeyboardInputSink(System.Windows.Interop.IKeyboardInputSink) - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [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.Windows.Interop.IKeyboardInputSite - - - - - - The sink of the contained component. - For a description of this member, see . - The site of the contained component. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Interop.IKeyboardInputSink.TabInto(System.Windows.Input.TraversalRequest) - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - Specifies whether focus should be set to the first or the last tab stop. - For a description of this member, see . - - if the focus has been set as requested; , if there are no tab stops. - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Interop.IKeyboardInputSink.TranslateAccelerator(System.Windows.Interop.MSG@,System.Windows.Input.ModifierKeys) - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - [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.Boolean - - - - - - - The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. - Modifier keys. - For a description of this member, see . - - if the message was handled by the method implementation; otherwise, . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - M:System.Windows.Interop.IKeyboardInputSink.TranslateChar(System.Windows.Interop.MSG@,System.Windows.Input.ModifierKeys) - - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - [System.Security.SecurityTreatAsSafe] - [<System.Security.SecurityTreatAsSafe>] - - - [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.Boolean - - - - - - - The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. - Modifier keys. - For a description of this member, see . - - if the message was processed and should not be called; otherwise, . - - instance is cast to an interface. - - ]]> - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - System.Boolean - - - - - - Specifies whether focus should be set to the first or the last tab stop. - Sets focus on either the first tab stop or the last tab stop of the sink. - - if the focus has been set as requested; , if there are no tab stops. - To be added. - - is . - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Boolean - - - - - - - The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. - Modifier keys. - Processes keyboard input at the key-down message level. - - if the message was handled by the method implementation; otherwise, . - To be added. - - - - - - - - - - - Method - - PresentationCore - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [System.Security.SecurityCritical] - [<System.Security.SecurityCritical>] - - - - System.Boolean - - - - - - - The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. - Modifier keys. - Processes WM_CHAR, WM_SYSCHAR, WM_DEADCHAR, and WM_SYSDEADCHAR input messages before the method is called. - - if the message was processed and should not be called; otherwise, . - To be added. - - - - - - - - - - Property - - PresentationCore - 3.0.0.0 - 4.0.0.0 - 5.0.0.0 - 6.0.0.0 - - - - [get: System.Security.SecurityCritical] - [<get: System.Security.SecurityCritical>] - - - - System.Boolean - - - Gets a value that declares whether the per-pixel opacity of the source window content is respected. - - if the system uses per-pixel opacity; otherwise, . - - is to show non-rectangular top-level UI that works in interoperation scenarios. Therefore, showing the rectangular non-client area defeats that purpose. - - ]]> - - - - - + + + + + + + + + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.PresentationSource + + + + System.IDisposable + + + System.Windows.Interop.IKeyboardInputSink + + + System.Windows.Interop.IWin32Window + + + + Presents Windows Presentation Foundation (WPF) content in a Win32 window. + + [!IMPORTANT] +> Many members of this class are unavailable in the Internet security zone. + + An implements a Win32 window that can contain WPF content. The WPF content in the window is arranged, measured, and rendered; and is interactive to input. Because the is specifically designed to interoperate with Win32, this class exposes several low-level Win32 features. You can use this class to do the following: + +- Specify window styles, window class styles, and extended window styles. + +- Hook the window procedure. + +- Provide access to the window handle (HWND). + +- Destroy the window. + + The class is designed for general interoperability and is not designed as a managed HWND wrapper. In general, it does not provide managed methods for manipulating the window or properties for inspecting its state. Instead, the class provides access to the Win32 window handle (HWND) through the property, which can be passed by means of PInvoke techniques to Win32 APIs in order to manipulate the window. + + **Construction** + + Many aspects of the can only be specified at construction time. To create an , first create an structure and populate it with the desired parameters. These parameters include the following: + +- The class, window, and extended window styles. You must use PInvoke to change the styles after the window is created. Not all styles can be changed after the window is created. Consult the Win32 documentation before changing window styles. + +- The initial position of the window. + +- The initial size of the window, which includes whether the size is specified or should be determined from the determined size of the WPF content. + +- The parent window. + +- The to include in the window procedure chain. If you specify a hook at construction time, it receives all messages for the window. You can use to add a hook after the window is created. + +- The transparency settings. A top-level window can be configured to blend with the other windows on the desktop according to the per-pixel transparency of the WPF content. To enable this, set the property in the to `true`. This property can only be specified at construction time, and only through the constructor signature, and it imposes several limitations. + + After you populate the structure, pass it to the constructor for the . + + **Object Lifetime** + + An is a regular common language runtime (CLR) object, and its lifetime is managed by the garbage collector. Because the represents an unmanaged resource, implements . Synchronously calling immediately destroys the Win32 window if called from the owner thread. If called from another thread, the Win32 window is destroyed asynchronously. Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios. + + **Window Procedures** + + The class implements its own window procedure. This window procedure is used to process important window messages, such as those related to layout, rendering, and input. However, you can also hook the window procedure for your own use. You can specify your own hook during construction by setting the property, or you can also use and to add and remove hooks after the window is created. The hooks are called by last-in first-out order, which enables your hooks to execute before the built-in processing. The actual hooks are held by a weak reference. Therefore, make sure that you manage the lifetime of your hook delegate. + + For more information about and other interoperation classes, see [WPF and Win32 Interoperation](/dotnet/framework/wpf/advanced/wpf-and-win32-interoperation). + + Notice how the constructors for take parameters that resemble the parameters for Win32 functions such as [CreateWindowEx](https://go.microsoft.com/fwlink/?LinkID=98462). + + Scale transformations should not be applied to the of an . See Remarks for . + + ]]> + + + + + + + PresentationCore + 4.0.0.0 + + + Initializes a new instance of the class. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + ]]> + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + + + + A structure that contains the parameters that are required to create the window. + Initializes a new instance of the class by using a structure that contains the initial settings. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + This constructor signature might be more convenient in certain situations, because the default structure contains some appropriate initial default values. + +> [!IMPORTANT] +> If you use this signature, do not use the default constructor to construct the structure for the `parameters` value. You must use the constructor that enables you to specify an initial window name. If you use the default constructor and create an with it, that does not display because an initial window name is a construction requirement for the represented HWND. + + ]]> + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + + + + + + + + + + The Win32 class styles for the window. + The Win32 styles for the window. + The extended Win32 styles for the window. + The position of the window's left edge. + The position of the window's upper edge. + The name of the window. + The handle of the window's parent window. + Initializes a new instance of the class with a specified class style, style, extended style, x-y position, name, and parent window. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + ]]> + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + + + + + + + + + + + + The Win32 class styles for the window. + The Win32 styles for the window. + The extended Win32 styles for the window. + The position of the window's left edge. + The position of the window's upper edge. + The width of the window. + The height of the window. + The name of the window. + The handle of the window's parent window. + Initializes a new instance of the class with a specified class style, style, extended style, x-y position, width, height, name, and parent window. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + ]]> + + + + + + + + + + + Constructor + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + + + + + + + + + + + + + The Win32 class styles for the window. + The Win32 styles for the window. + The extended Win32 styles for the window. + The position of the window's left edge. + The position of the window's upper edge. + The width of the window. + The height of the window. + The name of the window. + The handle of the window's parent window. + + to have the layout manager include the non-client area for sizing; otherwise, . + Initializes a new instance of the class with a specified class style, style, extended style, x-y position, width, height, name, and parent window, and by specifying whether the window is autosized. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 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 the value that determines whether to acquire Win32 focus for the WPF containing window for this . + + to acquire Win32 focus for the WPF containing window when the user interacts with menus; otherwise, . + + by setting the parameter. + + The default value is determined by the property. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + + + The handler implementation (based on the delegate) that receives the window messages. + Adds an event handler that receives all window messages. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + Most Win32 messages that reach the have an approximate WPF equivalent. You use to handle the cases where the message has no WPF equivalent. + + The delegate resembles the parameter profile of a Win32 main window procedure. All window messages that the main window procedure of the parent window receives are also forwarded to the delegates. + + Hooks are called in the order that they were added. If any hook returns `handled`=`true` for a message, the hooks after it in the call order are not called for that message. + + ]]> + + + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.AutoResizedEventHandler + + + Occurs when layout causes the to automatically resize. + + is to automatically resize content and the window region based on changes reported through the WPF layout system. The window does not resize if it is currently minimized or if is set to . + + ]]> + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__1))] + [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__1))>] + + + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__24))] + [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__24))>] + + + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__29))] + [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__29))>] + + + [get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__31))] + [<get: System.Runtime.CompilerServices.IteratorStateMachine(typeof(System.Windows.Interop.HwndSource+<get_ChildKeyboardInputSinks>d__31))>] + + + + System.Collections.Generic.IEnumerable<System.Windows.Interop.IKeyboardInputSink> + + + Gets a sequence of registered input sinks. + An enumeration of keyboard input sinks. + To be added. + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + + System.Windows.Interop.HwndTarget + + + Gets the visual manager for the hosted window. + The visual manager. + + in order to override the value that returns. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Runtime.InteropServices.HandleRef + + + + Gets the window handle for the . The window handle is packaged as part of a structure. + A structure that contains the window handle for this . + + to reference the from Win32 code. Use the handle for operations such as message handling and window behavior. + + To get just the handle, use . + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + Gets or sets the default value for new instances of . + + to acquire Win32 focus for the WPF containing window when the user interacts with menus; otherwise, . The default is . + + have set to this default value, unless a different value is passed as a parameter to the constructor for a specific instance, by using the property. + + ]]> + + + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Void + + + + Releases all managed resources that are used by the , and raises the event. + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. + + Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios, because an in some interoperation scenarios can generate several references to it across the interoperation boundaries that might prevent timely garbage collection. + + ]]> + + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the method is called on this object. + + event is raised before any resources are released by the . The event indicates that the object that raises the event is about to have all references to it removed. + + Use and the property to avoid calling twice (which raises an exception). + + ]]> + + + + + + + + + + + + + Event + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.HwndDpiChangedEventHandler + + + Occurs when the DPI of the monitor of this Hwnd has changed, or the Hwnd is moved to a monitor with a different DPI. + To be added. + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Windows.Interop.HwndSource + + + + + + The provided window handle. + Returns the object of the specified window. + The object for the window that is specified by the window handle. + + [!IMPORTANT] +> This method is not available in the Internet security zone, or for partial trust in general. + + You can use this method to return an for a window that is not explicitly an interoperation window. The procedure for this is: + +1. Create a instance (providing the main as a constructor parameter). + +2. Get the value of the property from that instance. + +3. Pass that HWND value as a parameter to . + + This technique can be useful if you then want to add general message processing to the window. However, whenever you create an , you are also responsible for destroying it. This is true even if the object for an application is disposed. For more information, see Remarks on . + + ]]> + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [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.Windows.Media.CompositionTarget + + + + Gets the visual target of the window. + Returns the visual target of the window. + + . + + ]]> + + + Implement this method to return a type-specific visual target. implements this method to return . + + + + + + + + + + + + + Property + + P:System.Windows.Interop.IWin32Window.Handle + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + + System.IntPtr + + + Gets the window handle for this . + The window handle. + + [!IMPORTANT] +> This property is not available in the Internet security zone. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + Gets a value that indicates whether the sink or one of its contained components has focus. + + if the sink or one of its contained components has focus; otherwise, . + To be added. + + + + + + + + + + + Property + + PresentationCore + 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.Boolean + + + Gets a value that indicates whether has been called on this . + + if the object has had called on it; otherwise, . + + initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. The event is raised and the value of becomes `false` as soon as is called. During this time, if you call again, raises an exception. + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + [set: System.Security.SecurityCritical] + [<set: System.Security.SecurityCritical>] + + + + System.Windows.Interop.IKeyboardInputSite + + + Gets or sets a reference to the component's container's interface. + A reference to the container's interface; or if no site is assigned. The default is . + + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Void + + + + + + The event arguments. + Called when the DPI is going to change for the window. + + [!IMPORTANT] +> This method accesses critical data . + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Boolean + + + + + + + The message for the mnemonic and associated data. + Modifier keys. + Called when one of the mnemonics (access keys) for this sink is invoked. + + if the message was handled; otherwise, . + To be added. + + is not WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, or WM_DEADCHAR. + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Windows.Interop.IKeyboardInputSite + + + + + + The sink of the contained component. + Registers the interface of a contained component. + The site of the contained component. + + + + + + + + + + + + + + Method + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Void + + + + + + The event handler to remove. + Removes the event handlers that were added by . + + [!IMPORTANT] +> This method is not available in the Internet security zone. + + ]]> + + + + + + + + + + + + + Property + + PresentationCore + 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.Input.RestoreFocusMode + + + Gets the for the window. + The for the window. + + constructor by using the property. + + ]]> + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + [set: System.Security.SecurityCritical] + [<set: System.Security.SecurityCritical>] + + + + System.Windows.Media.Visual + + + Gets or sets the of the window. + The root visual object of the window. + + or another root visual to the . + + Scale transformations should not be applied to the of an because this can disable behavior. The content will scale, but the enclosing window will not. Instead of applying the transformation to the object that is the , apply the transformation to an object that is a child element of the . You might need to add an extra enclosing element to the WPF content, such as a panel, in order to provide a scaleable object. + + You can add a as the root visual, but only as a top-level window (with WS_OVERLAPPED), not as a child window. + + ]]> + + + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Windows.SizeToContent + + + Get or sets whether and how the window is sized to its content. + One of the enumeration values. The default value is , which specifies that the window is not sized to its content. + + of an , because this can disable behavior. See Remarks for . + + ]]> + + + + + + + + + + + + + Event + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.EventHandler + + + Occurs when the value of the property changes. + + event is only raised when user interaction causes the change. If you set in code, the event is not raised. + + ]]> + + + + + + + + + + + + + Method + + M:System.Windows.Interop.IKeyboardInputSink.HasFocusWithin + + + PresentationCore + 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.Boolean + + + + For a description of this member, see . + + if the sink or one of its contained components has focus; otherwise, . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Property + + P:System.Windows.Interop.IKeyboardInputSink.KeyboardInputSite + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + [set: System.Security.SecurityCritical] + [<set: System.Security.SecurityCritical>] + + + [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")>] + + + [set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] + [<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>] + + + + System.Windows.Interop.IKeyboardInputSite + + + For a description of this member, see . + A reference to the container's interface. + + instance is cast to an interface. + + ]]> + + WPF and Win32 Interoperation Overview + Input Overview + + + + + + + + + + Method + + M:System.Windows.Interop.IKeyboardInputSink.OnMnemonic(System.Windows.Interop.MSG@,System.Windows.Input.ModifierKeys) + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + [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.Boolean + + + + + + + The message for the mnemonic and associated data. Do not modify this message structure. It is passed by reference for performance reasons only. + Modifier keys. + For a description of this member, see . + + if the message was handled; otherwise, . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Interop.IKeyboardInputSink.RegisterKeyboardInputSink(System.Windows.Interop.IKeyboardInputSink) + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [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.Windows.Interop.IKeyboardInputSite + + + + + + The sink of the contained component. + For a description of this member, see . + The site of the contained component. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Interop.IKeyboardInputSink.TabInto(System.Windows.Input.TraversalRequest) + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + Specifies whether focus should be set to the first or the last tab stop. + For a description of this member, see . + + if the focus has been set as requested; , if there are no tab stops. + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Interop.IKeyboardInputSink.TranslateAccelerator(System.Windows.Interop.MSG@,System.Windows.Input.ModifierKeys) + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + [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.Boolean + + + + + + + The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. + Modifier keys. + For a description of this member, see . + + if the message was handled by the method implementation; otherwise, . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + M:System.Windows.Interop.IKeyboardInputSink.TranslateChar(System.Windows.Interop.MSG@,System.Windows.Input.ModifierKeys) + + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + [System.Security.SecurityTreatAsSafe] + [<System.Security.SecurityTreatAsSafe>] + + + [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.Boolean + + + + + + + The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. + Modifier keys. + For a description of this member, see . + + if the message was processed and should not be called; otherwise, . + + instance is cast to an interface. + + ]]> + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + System.Boolean + + + + + + Specifies whether focus should be set to the first or the last tab stop. + Sets focus on either the first tab stop or the last tab stop of the sink. + + if the focus has been set as requested; , if there are no tab stops. + To be added. + + is . + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Boolean + + + + + + + The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. + Modifier keys. + Processes keyboard input at the key-down message level. + + if the message was handled by the method implementation; otherwise, . + + + + + + + + + + + + + + Method + + PresentationCore + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [System.Security.SecurityCritical] + [<System.Security.SecurityCritical>] + + + + System.Boolean + + + + + + + The message and associated data. Do not modify this structure. It is passed by reference for performance reasons only. + Modifier keys. + Processes WM_CHAR, WM_SYSCHAR, WM_DEADCHAR, and WM_SYSDEADCHAR input messages before the method is called. + + if the message was processed and should not be called; otherwise, . + To be added. + + + + + + + + + + Property + + PresentationCore + 3.0.0.0 + 4.0.0.0 + 5.0.0.0 + 6.0.0.0 + + + + [get: System.Security.SecurityCritical] + [<get: System.Security.SecurityCritical>] + + + + System.Boolean + + + Gets a value that declares whether the per-pixel opacity of the source window content is respected. + + if the system uses per-pixel opacity; otherwise, . + + is to show non-rectangular top-level UI that works in interoperation scenarios. Therefore, showing the rectangular non-client area defeats that purpose. + + ]]> + + + + + From 27394bb8eb620e9e1c8e6da5532a9f2e4fc6881d Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 13 Sep 2021 14:38:41 -0700 Subject: [PATCH 28/28] fix warnings --- xml/System.Windows.Automation/AutomationProperties.xml | 7 +++++-- xml/System.Windows.Input/InputType.xml | 1 - 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/xml/System.Windows.Automation/AutomationProperties.xml b/xml/System.Windows.Automation/AutomationProperties.xml index 757e3150ed2..a3a777e98fe 100644 --- a/xml/System.Windows.Automation/AutomationProperties.xml +++ b/xml/System.Windows.Automation/AutomationProperties.xml @@ -1389,7 +1389,9 @@ The `PositionInSet` attached property works in coordination with the + +[Automation Element Property Identifiers](/windows/win32/winauto/uiauto-automation-element-propids) + ]]> @@ -1957,7 +1959,8 @@ The property get ## Remarks SizeOfSet works in coordination with the PositionInSet property to describe the count of items in the set. - + +[Automation Element Property Identifiers](/windows/win32/winauto/uiauto-automation-element-propids) ]]> diff --git a/xml/System.Windows.Input/InputType.xml b/xml/System.Windows.Input/InputType.xml index 552b4afc4bd..c7447eb8f3f 100644 --- a/xml/System.Windows.Input/InputType.xml +++ b/xml/System.Windows.Input/InputType.xml @@ -24,7 +24,6 @@ The operating system handles keyboard, mouse, and pen input specially. - HID indicates that the input was provided by a Human Interface Device that was not a keyboard, a mouse, or a stylus.