diff --git a/xml/Accessibility/IAccIdentity.xml b/xml/Accessibility/IAccIdentity.xml index 5af4dcf9fa8..8d5c8697133 100644 --- a/xml/Accessibility/IAccIdentity.xml +++ b/xml/Accessibility/IAccIdentity.xml @@ -32,11 +32,11 @@ The and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccIdentity::GetIdentityString](/windows/win32/api/oleacc/nf-oleacc-iaccidentity-getidentitystring). - + ]]> @@ -68,11 +68,11 @@ Address of a variable that receives the length, in bytes, of the callee-allocated identity string. The and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccIdentity::GetIdentityString](/windows/win32/api/oleacc/nf-oleacc-iaccidentity-getidentitystring). - + , see [IAccIdentity::GetIdentityString](/windows/win32/api/oleacc/nf-oleacc-iaccidentity-getidentitystring). + ]]> diff --git a/xml/Accessibility/IAccPropServices.xml b/xml/Accessibility/IAccPropServices.xml index 545016d13d1..4ff42f79793 100644 --- a/xml/Accessibility/IAccPropServices.xml +++ b/xml/Accessibility/IAccPropServices.xml @@ -32,11 +32,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -77,11 +77,11 @@ Specifies the number of properties in the array. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -124,11 +124,11 @@ Specifies the number of properties in the array. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). + ]]> @@ -162,11 +162,11 @@ Specifies the number of properties in the array. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -207,11 +207,11 @@ Pointer to a buffer that receives the length of the identity string. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -254,11 +254,11 @@ Pointer to a buffer that receives the length of the identity string. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -298,11 +298,11 @@ Pointer to a buffer that receives the child ID of the accessible element. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) IAccPropServices interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -382,11 +382,11 @@ Pointer to a buffer that receives the child ID of the accessible element. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) IAccPropServices interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -467,11 +467,11 @@ Specifies a new value for the property. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -516,11 +516,11 @@ May be ANNO_THIS, indicating that the annotation affects the indicated accessible element only; or ANNO_CONTAINER, indicating that it applies to the element and its immediate element children. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -561,11 +561,11 @@ Specifies a new value for the property. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -608,11 +608,11 @@ Specifies a new value for that property. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -659,11 +659,11 @@ May be ANNO_THIS, indicating that the annotation affects the indicated accessible element only; or ANNO_CONTAINER, indicating that it applies to the element and its immediate element children. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -706,11 +706,11 @@ Specifies a new value for that property. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -748,11 +748,11 @@ May be ANNO_THIS, indicating that the annotation affects the indicated accessible element only; or ANNO_CONTAINER, indicating that it applies to the element and its immediate element children. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> @@ -786,11 +786,11 @@ Specifies a new value for the property. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see the documentation about [Dynamic Annotation](/windows/desktop/winauto/dynamic-annotation-common). - + ]]> diff --git a/xml/Accessibility/IAccessible.xml b/xml/Accessibility/IAccessible.xml index 5bae4a4068a..b3353f2d896 100644 --- a/xml/Accessibility/IAccessible.xml +++ b/xml/Accessibility/IAccessible.xml @@ -33,11 +33,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccessible interface](/windows/win32/api/oleacc/nn-oleacc-iaccessible). - + ]]> @@ -89,11 +89,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An object. - , see [IAccessible::get_accChild](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accchild). - + , see [IAccessible::get_accChild](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accchild). + ]]> @@ -141,11 +141,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An integer representing the count. - , see [IAccessible::get_accChildCount](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accchildcount). - + , see [IAccessible::get_accChildCount](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accchildcount). + ]]> @@ -197,11 +197,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. A string representing the action. - , see [IAccessible::get_accDefaultAction](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accdefaultaction). - + , see [IAccessible::get_accDefaultAction](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accdefaultaction). + ]]> @@ -253,11 +253,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. A string representing the description. - , see [IAccessible::get_accDescription](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accdescription). - + , see [IAccessible::get_accDescription](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accdescription). + ]]> @@ -303,11 +303,11 @@ This parameter is intended for internal use only. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccessible::accDoDefaultAction](/windows/win32/api/oleacc/nf-oleacc-iaccessible-accdodefaultaction). - + , see [IAccessible::accDoDefaultAction](/windows/win32/api/oleacc/nf-oleacc-iaccessible-accdodefaultaction). + ]]> @@ -355,11 +355,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. If successful, returns S_OK. Otherwise, returns another standard COM error code. - , see [IAccessible::get_accFocus](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accfocus). - + , see [IAccessible::get_accFocus](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accfocus). + ]]> @@ -411,11 +411,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. A string. - , see [IAccessible::get_accHelp](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_acchelp). - + , see [IAccessible::get_accHelp](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_acchelp). + ]]> @@ -469,11 +469,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An integer. - , see [IAccessible::get_accHelpTopic](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_acchelptopic). - + , see [IAccessible::get_accHelpTopic](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_acchelptopic). + ]]> @@ -523,11 +523,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An object. - , see [IAccessible::accHitTest](/windows/win32/api/oleacc/nf-oleacc-iaccessible-acchittest). - + , see [IAccessible::accHitTest](/windows/win32/api/oleacc/nf-oleacc-iaccessible-acchittest). + ]]> @@ -579,11 +579,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. A string. - , see [IAccessible::get_accKeyboardShortcut](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_acckeyboardshortcut). - + , see [IAccessible::get_accKeyboardShortcut](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_acckeyboardshortcut). + ]]> @@ -637,11 +637,11 @@ This parameter is intended for internal use only. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccessible::accLocation](/windows/win32/api/oleacc/nf-oleacc-iaccessible-acclocation). - + , see [IAccessible::accLocation](/windows/win32/api/oleacc/nf-oleacc-iaccessible-acclocation). + ]]> @@ -709,11 +709,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. A string. - , see [IAccessible::get_accName](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accname). - + , see [IAccessible::get_accName](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accname). + ]]> @@ -762,11 +762,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. If successful, returns S_OK. For other possible return values, see the documentation for . - , see [IAccessible::accNavigate](/windows/win32/api/oleacc/nf-oleacc-iaccessible-accnavigate). - + , see [IAccessible::accNavigate](/windows/win32/api/oleacc/nf-oleacc-iaccessible-accnavigate). + ]]> @@ -814,11 +814,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An object. - , see [IAccessible::get_accParent](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accparent). - + , see [IAccessible::get_accParent](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accparent). + ]]> @@ -870,11 +870,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An object. - , see [IAccessible::get_accRole](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accrole). - + , see [IAccessible::get_accRole](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accrole). + ]]> @@ -922,11 +922,11 @@ This parameter is intended for internal use only. The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccessible::accSelect](/windows/win32/api/oleacc/nf-oleacc-iaccessible-accselect). - + , see [IAccessible::accSelect](/windows/win32/api/oleacc/nf-oleacc-iaccessible-accselect). + ]]> @@ -974,11 +974,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An object. - , see [IAccessible::get_accSelection](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accselection). - + , see [IAccessible::get_accSelection](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accselection). + ]]> @@ -1030,11 +1030,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. An object. - , see [IAccessible::get_accState](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accstate). - + , see [IAccessible::get_accState](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accstate). + ]]> @@ -1102,11 +1102,11 @@ The interface and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. A string. - , see [IAccessible::get_accValue](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accvalue). - + , see [IAccessible::get_accValue](/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accvalue). + ]]> diff --git a/xml/Accessibility/IAccessibleHandler.xml b/xml/Accessibility/IAccessibleHandler.xml index 5af72a409ed..cffa9f35e50 100644 --- a/xml/Accessibility/IAccessibleHandler.xml +++ b/xml/Accessibility/IAccessibleHandler.xml @@ -41,11 +41,11 @@ The and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccessibleHandler::AccessibleObjectFromID](/windows/win32/api/oleacc/nf-oleacc-iaccessiblehandler-accessibleobjectfromid). - + , see [IAccessibleHandler::AccessibleObjectFromID](/windows/win32/api/oleacc/nf-oleacc-iaccessiblehandler-accessibleobjectfromid). + ]]> @@ -78,11 +78,11 @@ Specifies the address of a pointer variable that receives the address of the object's IAccessible interface. The and all of its exposed members are part of a managed wrapper for the Component Object Model (COM) interface. - , see [IAccessibleHandler::AccessibleObjectFromID](/windows/win32/api/oleacc/nf-oleacc-iaccessiblehandler-accessibleobjectfromid). - + , see [IAccessibleHandler::AccessibleObjectFromID](/windows/win32/api/oleacc/nf-oleacc-iaccessiblehandler-accessibleobjectfromid). + ]]> diff --git a/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml b/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml index 11fed9b31f4..9d981188d81 100644 --- a/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml +++ b/xml/Microsoft.Build.Tasks.Windows/GenerateTemporaryTargetAssembly.xml @@ -270,7 +270,7 @@ ## Remarks The property is an optional task parameter. It's a diagnostic parameter, and it defaults to `false`. - The only debugging information that is generated consists of the temporary project that is created to generate the temporary target assembly. The temporary project is normally deleted at the end of the MSBuild task. When is enabled, the temporary project is retained for inspection by the developer. + The only debugging information that is generated consists of the temporary project that is created to generate the temporary target assembly. The temporary project is normally deleted at the end of the MSBuild task. When is enabled, the temporary project is retained for inspection by the developer. ]]> diff --git a/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml b/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml index 3d947403c7b..73dc4f40161 100644 --- a/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml +++ b/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml @@ -91,8 +91,8 @@ |Property|Value| |--------------|-----------| -||`null`.| -||The localized error message string.| +||`null`.| +||The localized error message string.| ]]> @@ -139,8 +139,8 @@ |Property|Value| |--------------|-----------| -||`null`.| -||The error message string specified in `message`.| +||`null`.| +||The error message string specified in `message`.| ]]> @@ -242,8 +242,8 @@ |Property|Value| |--------------|-----------| -||`null`.| -||The error message string specified in `message`.| +||`null`.| +||The error message string specified in `message`.| ]]> diff --git a/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderInternalCompilerException.xml b/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderInternalCompilerException.xml index 188d6a36f5d..664682a4f1c 100644 --- a/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderInternalCompilerException.xml +++ b/xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderInternalCompilerException.xml @@ -91,8 +91,8 @@ |Property|Value| |--------------|-----------| -||`null`.| -||The localized error message string.| +||`null`.| +||The localized error message string.| ]]> @@ -139,8 +139,8 @@ |Property|Value| |--------------|-----------| -||`null`.| -||The error message string specified in `message`.| +||`null`.| +||The error message string specified in `message`.| ]]> @@ -242,8 +242,8 @@ |Property|Value| |--------------|-----------| -||`null`.| -||The error message string specified in `message`.| +||`null`.| +||The error message string specified in `message`.| ]]> diff --git a/xml/Microsoft.CSharp/CSharpCodeProvider.xml b/xml/Microsoft.CSharp/CSharpCodeProvider.xml index 41cca07413d..6adfb45b785 100644 --- a/xml/Microsoft.CSharp/CSharpCodeProvider.xml +++ b/xml/Microsoft.CSharp/CSharpCodeProvider.xml @@ -361,7 +361,7 @@ In .NET Framework apps, you can obtain the value for `providerOptions` from the ## Examples - The following code example shows the use of the method to create a code fragment to be used in a CodeDOM graph. This code example is part of a larger example provided for the method of the class. + The following code example shows the use of the method to create a code fragment to be used in a CodeDOM graph. This code example is part of a larger example provided for the method of the class. :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/GenerateCodeFromMember/program.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.CSharp/CSharpCodeProvider/GenerateCodeFromMember/module1.vb" id="Snippet3"::: diff --git a/xml/Microsoft.JScript.Vsa/JSVsaError.xml b/xml/Microsoft.JScript.Vsa/JSVsaError.xml index 048413324ad..22b8e027a9e 100644 --- a/xml/Microsoft.JScript.Vsa/JSVsaError.xml +++ b/xml/Microsoft.JScript.Vsa/JSVsaError.xml @@ -2160,7 +2160,7 @@ ## Remarks Exception string: The specified element could not be saved. - Thrown by the method and methods when a call to the `SaveElement` method fails. The `InnerException` property of the class is set to the actual exception thrown by the underlying code (for example, an out of disk space exception). For more information, see . The `SaveSourceState` method returns the `SaveElementFailed` exception from the `SaveElement` method back to the caller. + Thrown by the method and methods when a call to the `SaveElement` method fails. The `InnerException` property of the class is set to the actual exception thrown by the underlying code (for example, an out of disk space exception). For more information, see . The `SaveSourceState` method returns the `SaveElementFailed` exception from the `SaveElement` method back to the caller. ]]> diff --git a/xml/Microsoft.JScript/ErrorObject.xml b/xml/Microsoft.JScript/ErrorObject.xml index a97af49fa29..00da86bcb08 100644 --- a/xml/Microsoft.JScript/ErrorObject.xml +++ b/xml/Microsoft.JScript/ErrorObject.xml @@ -93,11 +93,11 @@ Specifies a number or code for the error. - can be a member, a , or another -related error number or code. - + can be a member, a , or another -related error number or code. + ]]> diff --git a/xml/Microsoft.JScript/IDebugVsaScriptCodeItem.xml b/xml/Microsoft.JScript/IDebugVsaScriptCodeItem.xml index 248c9817e59..08eb4783622 100644 --- a/xml/Microsoft.JScript/IDebugVsaScriptCodeItem.xml +++ b/xml/Microsoft.JScript/IDebugVsaScriptCodeItem.xml @@ -50,11 +50,11 @@ When implemented in a class, evaluates the block, expression, or statement represented by the code item and returns the value. It is typically called by a debugger that needs to evaluate an expression (in a Watch window, for example). For expressions, the value is the result of the expression. For blocks and statements, the resulting expression is the last expression calculated by the block or statement. A value that represents the evaluation of the statement, expression, or block. - method is functionally identical to the method. Only the marshaling attributes differ. This version of the interface allows an unmanaged debugger to obtain the return value as an `IUnknown` pointer rather than a `VARIANT`. - + method is functionally identical to the method. Only the marshaling attributes differ. This version of the interface allows an unmanaged debugger to obtain the return value as an `IUnknown` pointer rather than a `VARIANT`. + ]]> diff --git a/xml/Microsoft.JScript/JSParser.xml b/xml/Microsoft.JScript/JSParser.xml index 113606a4c6f..719063cf516 100644 --- a/xml/Microsoft.JScript/JSParser.xml +++ b/xml/Microsoft.JScript/JSParser.xml @@ -74,11 +74,11 @@ Parses the source code. The root of the abstract syntax tree that is created by parsing the code. - constructor. - + constructor. + ]]> @@ -110,11 +110,11 @@ Parses the source code. Use this method instead of when the source code is inside an method call. The root of the abstract syntax tree that is created by parsing the code. - constructor. - + constructor. + ]]> diff --git a/xml/Microsoft.JScript/JSScanner.xml b/xml/Microsoft.JScript/JSScanner.xml index 15c75034b3d..5e757b7eedb 100644 --- a/xml/Microsoft.JScript/JSScanner.xml +++ b/xml/Microsoft.JScript/JSScanner.xml @@ -200,11 +200,11 @@ Gets the source code that is associated with this scanner object. The source code to scan. - method or to the method. - + method or to the method. + ]]> @@ -391,11 +391,11 @@ to indicate authoring mode; otherwise, . Sets a flag that indicates whether the scanner is operating in authoring mode. - diff --git a/xml/Microsoft.JScript/ScriptFunction.xml b/xml/Microsoft.JScript/ScriptFunction.xml index db7cf56d172..184a1c83379 100644 --- a/xml/Microsoft.JScript/ScriptFunction.xml +++ b/xml/Microsoft.JScript/ScriptFunction.xml @@ -44,11 +44,11 @@ The name of the object that this function constructs. Initializes a new instance of the class. - by using a , the parent is a . - + by using a , the parent is a . + ]]> @@ -125,11 +125,11 @@ Gets the prototype object for this constructor function. The prototype object for this constructor function. - by using a , the prototype is a . - + by using a , the prototype is a . + ]]> @@ -206,11 +206,11 @@ Invokes a method of the prototype-based object, passing in the specified arguments. The result of the call to the method. - often acts as a constructor or create instance call. - + often acts as a constructor or create instance call. + ]]> @@ -321,11 +321,11 @@ Gets or sets the prototype object for this constructor function. The prototype object for this constructor function. - by using a , the prototype is a . - + by using a , the prototype is a . + ]]> diff --git a/xml/Microsoft.SqlServer.Server/Format.xml b/xml/Microsoft.SqlServer.Server/Format.xml index c6981a9dfaf..1cff9a02c9d 100644 --- a/xml/Microsoft.SqlServer.Server/Format.xml +++ b/xml/Microsoft.SqlServer.Server/Format.xml @@ -27,47 +27,47 @@ Used by and to indicate the serialization format of a user-defined type (UDT) or aggregate. - and to indicate the serialization format of a user-defined type (UDT) or aggregate. Use of the `Native` and `UserDefined` enumeration members has special requirements. +## Remarks + +This enumeration is used by and to indicate the serialization format of a user-defined type (UDT) or aggregate. Use of the `Native` and `UserDefined` enumeration members has special requirements. - `Format.Native` - The requirements for the `Format.Native` format are: - + The requirements for the `Format.Native` format are: + - The with a property value of must be applied to the aggregate or UDT if it is defined in a class and not a structure. This controls the physical layout of the data fields and is used to force the members to be laid out sequentially in the order they appear. SQL Server uses this attribute to determine the field order for UDTs with multiple fields. - - - The type must contain at least one member (serialized values cannot be zero bytes in size). - - - All the fields of the aggregate must be *blittable*; that is, they must have a common representation in both managed and unmanaged memory and not require special handling by the interop marshaler. - - - All the fields of the UDT should be of one of the following types that can be serialized: `bool`, `byte`, `sbyte`, `short`, `ushort`, `int`, `uint`, `long`, `ulong`, `float`, `double`, , , , , , , , , or other value types defined by the user that contain fields of one of these types. - - - The aggregate must not specify a value for `MaxByteSize`. - - - The aggregate must not have any [NonSerialized] fields. - - - Fields must not be marked as an explicit layout (with a of ). + + - The type must contain at least one member (serialized values cannot be zero bytes in size). + + - All the fields of the aggregate must be *blittable*; that is, they must have a common representation in both managed and unmanaged memory and not require special handling by the interop marshaler. + + - All the fields of the UDT should be of one of the following types that can be serialized: `bool`, `byte`, `sbyte`, `short`, `ushort`, `int`, `uint`, `long`, `ulong`, `float`, `double`, , , , , , , , , or other value types defined by the user that contain fields of one of these types. + + - The aggregate must not specify a value for `MaxByteSize`. + + - The aggregate must not have any [NonSerialized] fields. + + - Fields must not be marked as an explicit layout (with a of ). - `Format.UserDefined` The requirements for the `Format.UserDefined` format are: - - The aggregate must specify a value for `MaxByteSize`. - - - Specify the attribute property. The default value is `false`. - - - If you omit any field in the or methods, the state of that field is not serialized. + - The aggregate must specify a value for `MaxByteSize`. + + - Specify the attribute property. The default value is `false`. -## Examples + - If you omit any field in the or methods, the state of that field is not serialized. + +## Examples + +The following example shows the `UserDefinedType` attribute of the Point UDT. The UDT is byte-ordered, is named "Point", has a validation method named "ValidatePoint", and uses the native serialization format. -The following example shows the `UserDefinedType` attribute of the Point UDT. The UDT is byte-ordered, is named "Point", has a validation method named "ValidatePoint", and uses the native serialization format. - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks SqlUserDefinedTypeAttribute Example/CS/source.cs" id="Snippet1"::: -:::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/Format/Overview/source.vb" id="Snippet1"::: - +:::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/Format/Overview/source.vb" id="Snippet1"::: + ]]> diff --git a/xml/Microsoft.SqlServer.Server/IBinarySerialize.xml b/xml/Microsoft.SqlServer.Server/IBinarySerialize.xml index 30d5ccbe50a..3253b276637 100644 --- a/xml/Microsoft.SqlServer.Server/IBinarySerialize.xml +++ b/xml/Microsoft.SqlServer.Server/IBinarySerialize.xml @@ -25,15 +25,15 @@ Provides custom implementation for user-defined type (UDT) and user-defined aggregate serialization and deserialization. - .`Native` or .`UserDefined`. - - .`Native` allows SQL Server to handle serialization and deserialization automatically, but the format has restrictions on the kind of types it can handle. .`UserDefined` allows user-defined types and aggregates to handle their own serialization. User-defined types and aggregates must be marked with .`UserDefined` in the `SqlUserDefinedType` or `SqlUserDefinedAggregate` attribute, and must implement the interface. - - Note that even with custom serialization, the total size of each instance must be under the maximum allowed limit, currently 8000 bytes. - + .`Native` or .`UserDefined`. + + .`Native` allows SQL Server to handle serialization and deserialization automatically, but the format has restrictions on the kind of types it can handle. .`UserDefined` allows user-defined types and aggregates to handle their own serialization. User-defined types and aggregates must be marked with .`UserDefined` in the `SqlUserDefinedType` or `SqlUserDefinedAggregate` attribute, and must implement the interface. + + Note that even with custom serialization, the total size of each instance must be under the maximum allowed limit, currently 8000 bytes. + ]]> @@ -65,19 +65,19 @@ The stream from which the object is deserialized. Generates a user-defined type (UDT) or user-defined aggregate from its binary form. - method must reconstitute your object using the information written by the method. - - - -## Examples - The following example shows the implementation of the method of a UDT, which uses a to de-serialize a previously persisted UDT. This example assumes that the UDT has two data properties: `StringValue` and `DoubleValue`. - + method must reconstitute your object using the information written by the method. + + + +## Examples + The following example shows the implementation of the method of a UDT, which uses a to de-serialize a previously persisted UDT. This example assumes that the UDT has two data properties: `StringValue` and `DoubleValue`. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks IBinarySerialize Samples/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/IBinarySerialize/Read/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/IBinarySerialize/Read/source.vb" id="Snippet1"::: + ]]> @@ -109,19 +109,19 @@ The stream to which the UDT or user-defined aggregate is serialized. Converts a user-defined type (UDT) or user-defined aggregate into its binary format so that it may be persisted. - method to reconstitute your UDT or user-defined aggregate. - - - -## Examples - The following example shows the implementation of the method of a UDT, which uses a to serialize the UDT in the user-defined binary format. The purpose of the null character padding is to ensure that the string value is completely separated from the double value, so that one UDT is compared to another in Transact-SQL code, string bytes are compared to string bytes and double bytes are compared to double bytes. - + method to reconstitute your UDT or user-defined aggregate. + + + +## Examples + The following example shows the implementation of the method of a UDT, which uses a to serialize the UDT in the user-defined binary format. The purpose of the null character padding is to ensure that the string value is completely separated from the double value, so that one UDT is compared to another in Transact-SQL code, string bytes are compared to string bytes and double bytes are compared to double bytes. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks IBinarySerialize Samples/CS/source.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/IBinarySerialize/Read/source.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/IBinarySerialize/Read/source.vb" id="Snippet2"::: + ]]> diff --git a/xml/Microsoft.SqlServer.Server/SqlContext.xml b/xml/Microsoft.SqlServer.Server/SqlContext.xml index 862dc0309cb..9dd862b391e 100644 --- a/xml/Microsoft.SqlServer.Server/SqlContext.xml +++ b/xml/Microsoft.SqlServer.Server/SqlContext.xml @@ -25,7 +25,7 @@ ## Examples - The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. + The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks SqlPipe.SendResultsRow/CS/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/SqlPipe/SendResultsEnd/source.vb" id="Snippet1"::: diff --git a/xml/Microsoft.SqlServer.Server/SqlDataRecord.xml b/xml/Microsoft.SqlServer.Server/SqlDataRecord.xml index 8451896a5d0..93678ee4b8a 100644 --- a/xml/Microsoft.SqlServer.Server/SqlDataRecord.xml +++ b/xml/Microsoft.SqlServer.Server/SqlDataRecord.xml @@ -275,7 +275,7 @@ ## Remarks This method enables you to obtain a binary value either in a single call or in chunks. Getting the value in chunks is useful for large values or values of unknown size. - To obtain the value in several chunks, allocate a byte array of the chunk-size and call repeatedly, adjusting the `fieldOffset` parameter accordingly in each call. + To obtain the value in several chunks, allocate a byte array of the chunk-size and call repeatedly, adjusting the `fieldOffset` parameter accordingly in each call. ]]> @@ -374,7 +374,7 @@ ## Remarks This method enables you to obtain a character value either in a single call or in chunks. Getting the value in chunks is useful for large values or values of unknown size. - To obtain the value in several chunks, allocate a char array of the chunk-size and call repeatedly adjusting the `fieldOffset` parameter accordingly in each call. + To obtain the value in several chunks, allocate a char array of the chunk-size and call repeatedly adjusting the `fieldOffset` parameter accordingly in each call. ]]> diff --git a/xml/Microsoft.SqlServer.Server/SqlFacetAttribute.xml b/xml/Microsoft.SqlServer.Server/SqlFacetAttribute.xml index 8fa5ec2a088..13f7bbf6c6c 100644 --- a/xml/Microsoft.SqlServer.Server/SqlFacetAttribute.xml +++ b/xml/Microsoft.SqlServer.Server/SqlFacetAttribute.xml @@ -43,7 +43,7 @@ To specify the on an input p The table below captures the matrix of valid values for the various properties for specific field types. In this table, "Y" indicates that the property is valid, and "N" indicates that the property is not valid. - The specified must be compatible with the field type. If the property is not valid, type registration will report an error if the user specifies a non-default value for the property. The maximum values for and properties are 38. For the property, the value should be in the range of 1-8000 for binary and non-Unicode data, 1-4000 for Unicode data, or -1. All other values are not valid. + The specified must be compatible with the field type. If the property is not valid, type registration will report an error if the user specifies a non-default value for the property. The maximum values for and properties are 38. For the property, the value should be in the range of 1-8000 for binary and non-Unicode data, 1-4000 for Unicode data, or -1. All other values are not valid. |Type|IsFixedLength|MaxSize|Precision|Scale|IsNullable| |----------|-------------------|-------------|---------------|-----------|----------------| diff --git a/xml/Microsoft.SqlServer.Server/SqlFunctionAttribute.xml b/xml/Microsoft.SqlServer.Server/SqlFunctionAttribute.xml index b39b3df95e6..41cb4204e07 100644 --- a/xml/Microsoft.SqlServer.Server/SqlFunctionAttribute.xml +++ b/xml/Microsoft.SqlServer.Server/SqlFunctionAttribute.xml @@ -100,7 +100,7 @@ . is also required when connecting to remote servers if transactions integration is required (the default). + The default is . is also required when connecting to remote servers if transactions integration is required (the default). If a Transact-SQL query is executed from inside a table-valued function (TVF), the property should be set. @@ -172,9 +172,9 @@ The property is also useful for indexing the result of the function in the form of indexed computed columns and indexed views. If this property is not specified, the function is assumed to be non-deterministic. - Functions that access local data can be deterministic. The data access characteristic is captured separately by the and properties. + Functions that access local data can be deterministic. The data access characteristic is captured separately by the and properties. - Note that data access to remote servers (for example, using a to connect to another SQL Server instance) is available in user-defined functions. However, you must still honor the declaration. If the common language runtime (CLR) function is marked as deterministic, it should not cause side-effects in the remote server. While side-effects against the context connection are restricted, SQL Server will not enforce the restriction for side-effects over remote connections. + Note that data access to remote servers (for example, using a to connect to another SQL Server instance) is available in user-defined functions. However, you must still honor the declaration. If the common language runtime (CLR) function is marked as deterministic, it should not cause side-effects in the remote server. While side-effects against the context connection are restricted, SQL Server will not enforce the restriction for side-effects over remote connections. The default value of this attribute is `false`. diff --git a/xml/Microsoft.SqlServer.Server/SqlMetaData.xml b/xml/Microsoft.SqlServer.Server/SqlMetaData.xml index 086b42a20eb..344e719e646 100644 --- a/xml/Microsoft.SqlServer.Server/SqlMetaData.xml +++ b/xml/Microsoft.SqlServer.Server/SqlMetaData.xml @@ -90,7 +90,7 @@ ## Remarks Only the following are allowed to be passed to the constructor as `dbType`: `Bit`, `BigInt`, `DateTime`, `Decimal`, `Float`, `Int`, `Money`, `Numeric`, `SmallDateTime`, `SmallInt`, `SmallMoney`, `TimeStamp`, `TinyInt`, `UniqueIdentifier`, `Xml`. - The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): + The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): |SqlDbType|Maximum length|Precision|Scale|Locale|Compare options| |---------------|--------------------|---------------|-----------|------------|---------------------| @@ -162,11 +162,11 @@ ## Remarks Only the following are allowed to be passed to the constructor as `dbType`: `Binary`, `Char`, `Image`, `NChar`, `Ntext`, `NVarChar`, `Text`, `VarBinary`, `VarChar`. - Only a `maxLength` specification of , or -1 is allowed for a `dbType` of `Text`, `NText`, or `Image`. + Only a `maxLength` specification of , or -1 is allowed for a `dbType` of `Text`, `NText`, or `Image`. - For a `dbType` of `Varchar`, `Nvarchar`, or `VarBinary`, a length specification of , or -1, declares the metadata as varchar(max), nvarchar(max), or nvarbinary(max), respectively. + For a `dbType` of `Varchar`, `Nvarchar`, or `VarBinary`, a length specification of , or -1, declares the metadata as varchar(max), nvarchar(max), or nvarbinary(max), respectively. - The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): + The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): | SqlDbType | Precision | Scale | Locale | Compare options | |-----------|-----------|-------|-----------|-----------------------------------------| @@ -225,7 +225,7 @@ ## Remarks Only the following `SqlDbType` is allowed to be passed to the constructor as `dbType`: `UDT`. - The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): + The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): |SqlDbType|Maximum length|Precision|Scale|Locale|Compare options| |---------------|--------------------|---------------|-----------|------------|---------------------| @@ -277,7 +277,7 @@ ## Remarks Only the following `SqlDbType` is allowed to be passed to the constructor as `dbType`: `Decimal`. - The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): + The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): |SqlDbType|Maximum length|Precision|Scale|Locale|Compare options| |---------------|--------------------|---------------|-----------|------------|---------------------| @@ -363,11 +363,11 @@ ## Remarks Only the following are allowed to be passed to the constructor as `dbType`: `Char`, `NChar`, `Ntext`, `NVarChar`, `Text`, `VarChar`. - Only a `maxLength` specification of , or -1, is allowed for a `dbType` of `Text` or `NText`. + Only a `maxLength` specification of , or -1, is allowed for a `dbType` of `Text` or `NText`. - For a `dbType` of `Varchar` or `Nvarchar`, a length specification of , or -1, declares the metadata as varchar(max) and nvarchar(max), respectively. + For a `dbType` of `Varchar` or `Nvarchar`, a length specification of , or -1, declares the metadata as varchar(max) and nvarchar(max), respectively. - The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): + The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): |SqlDbType|Precision|Scale| |---------------|---------------|-----------| @@ -636,7 +636,7 @@ ## Remarks Only the following are allowed to be passed to the constructor as `dbType`: `BigInt`, `Bit`, `BitInt`, `DateTime`, `Decimal`, `Float`, `Image`, `Int`, `Money`, `Ntext`, `Numeric`, `Real`, `SmallDateTime`, `SmallInt`, `SmallMoney`, `Text`, `TimeStamp`, `TinyInt`, `UniqueIdentifier`, `Variant`, `Xml`. - The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): + The following are the default values assigned to `dbType`, depending on the `SqlDbType` (the , , , and properties are set to `null`): |SqlDbType|Maximum length|Precision|Scale|Locale|Compare options| |---------------|--------------------|---------------|-----------|------------|---------------------| @@ -2634,7 +2634,7 @@ ## Remarks The default value is `null`. - Returns `null` if is not a UDT type. `Null` may also returned for valid UDT result sets where the assembly is not available to the application. + Returns `null` if is not a UDT type. `Null` may also returned for valid UDT result sets where the assembly is not available to the application. ]]> @@ -2752,7 +2752,7 @@ ## Remarks The default value is `null`. - This property may be `null` if the collection is defined within the current database. It is also `null` if there is no schema collection, in which case and are also null. + This property may be `null` if the collection is defined within the current database. It is also `null` if there is no schema collection, in which case and are also null. ]]> @@ -2792,7 +2792,7 @@ ## Remarks The default value is `null`. - This value is `null` if there is no associated schema collection. If the value is `null`, then and are also `null`. + This value is `null` if there is no associated schema collection. If the value is `null`, then and are also `null`. ]]> @@ -2832,7 +2832,7 @@ ## Remarks The default value is `null`. - This value may be `null` if the collection is defined within the current database and default schema. It is also null if there is no schema collection, in which case and are also `null`. + This value may be `null` if the collection is defined within the current database and default schema. It is also null if there is no schema collection, in which case and are also `null`. ]]> diff --git a/xml/Microsoft.SqlServer.Server/SqlMethodAttribute.xml b/xml/Microsoft.SqlServer.Server/SqlMethodAttribute.xml index 79f7315e2f8..bd959e3e1c6 100644 --- a/xml/Microsoft.SqlServer.Server/SqlMethodAttribute.xml +++ b/xml/Microsoft.SqlServer.Server/SqlMethodAttribute.xml @@ -146,7 +146,7 @@ The default value of the `InvokeIfReceiverIsNull` property is `false`. That is, The default value of the property is `false`. - A property can be a mutator if is used on the setter and is set to `true`. However, a property setter is implicitly treated as a mutator, so it is not necessary to set the property of the to `true`. + A property can be a mutator if is used on the setter and is set to `true`. However, a property setter is implicitly treated as a mutator, so it is not necessary to set the property of the to `true`. ]]> diff --git a/xml/Microsoft.SqlServer.Server/SqlPipe.xml b/xml/Microsoft.SqlServer.Server/SqlPipe.xml index 191f2648ae7..56696206d12 100644 --- a/xml/Microsoft.SqlServer.Server/SqlPipe.xml +++ b/xml/Microsoft.SqlServer.Server/SqlPipe.xml @@ -116,7 +116,7 @@ with the command text "EXEC Procedure2". Procedure2 is also a managed stored procedure. If Procedure2 now calls , the row is sent to Procedure1's reader, not to the client. + The **Send** method sends data straight to the client or caller. It is usually the client that consumes the output from the **Pipe** method, but in the case of nested CLR stored procedures the output consumer can also be a stored procedure. For example, Procedure1 calls with the command text "EXEC Procedure2". Procedure2 is also a managed stored procedure. If Procedure2 now calls , the row is sent to Procedure1's reader, not to the client. ]]> @@ -212,7 +212,7 @@ ## Examples - The following example uses the method to send a message string directly to the client. + The following example uses the method to send a message string directly to the client. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks SqlPipe.Send/CS/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/SqlPipe/Send/source.vb" id="Snippet1"::: @@ -246,12 +246,12 @@ . This method, along with and , allow stored procedures to send custom result sets to the client. + Managed stored procedures can send result sets to clients that are not implementing a . This method, along with and , allow stored procedures to send custom result sets to the client. ## Examples - The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. + The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks SqlPipe.SendResultsEnd/CS/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/SqlContext/Overview/source.vb" id="Snippet1"::: @@ -289,14 +289,14 @@ . This method, along with and , allows stored procedures to send custom result sets to the client. + Managed stored procedures can send result sets to clients that are not implementing a . This method, along with and , allows stored procedures to send custom result sets to the client. - The method sends a single row of data back to the client. Rows can subsequently be returned to the caller by calling , one time for each row being sent. After all the rows have been sent, a call to the method is required to mark the end of the result set. + The method sends a single row of data back to the client. Rows can subsequently be returned to the caller by calling , one time for each row being sent. After all the rows have been sent, a call to the method is required to mark the end of the result set. ## Examples - The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. + The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks SqlPipe.SendResultsRow/CS/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/SqlPipe/SendResultsEnd/source.vb" id="Snippet1"::: @@ -335,18 +335,18 @@ . This method, along with and , allow stored procedures to send custom result sets to the client. + Managed stored procedures can send result sets to clients that are not implementing a . This method, along with and , allow stored procedures to send custom result sets to the client. - The method marks the beginning of a result set, and uses the record parameter to construct the metadata that describes the result set. All the subsequent rows, sent using the method, must match that metadata definition. + The method marks the beginning of a result set, and uses the record parameter to construct the metadata that describes the result set. All the subsequent rows, sent using the method, must match that metadata definition. - Note that after calling , only and can be called. Any other method in the same instance of throws an . sets back to the initial state where other methods can be called. + Note that after calling , only and can be called. Any other method in the same instance of throws an . sets back to the initial state where other methods can be called. After control returns to Transact-SQL from CLR execution, do not attempt to use a static or local variable initialized to CLR memory. For example, do not store an instance of an in process class, for example `SQLDataRecord`, which will be used after control returns from CLR. One exception is the `SQLMetaData` in process class. ## Examples - The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. + The following example creates a new and its . The example then marks the beginning of a result set using the method, sends records with example data back to the client using the method, and marks the end of the result set with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks SqlPipe.SendResultsStart/CS/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.SqlServer.Server/SqlPipe/SendResultsStart/source.vb" id="Snippet1"::: diff --git a/xml/Microsoft.SqlServer.Server/SqlTriggerContext.xml b/xml/Microsoft.SqlServer.Server/SqlTriggerContext.xml index 8b332f0c229..fe3c89cb02a 100644 --- a/xml/Microsoft.SqlServer.Server/SqlTriggerContext.xml +++ b/xml/Microsoft.SqlServer.Server/SqlTriggerContext.xml @@ -60,7 +60,7 @@ property is useful to determine the maximum ordinal that allows for a given trigger invocation. + property is useful to determine the maximum ordinal that allows for a given trigger invocation. ]]> diff --git a/xml/Microsoft.SqlServer.Server/SqlUserDefinedAggregateAttribute.xml b/xml/Microsoft.SqlServer.Server/SqlUserDefinedAggregateAttribute.xml index 9d3898115cf..ae158ae044d 100644 --- a/xml/Microsoft.SqlServer.Server/SqlUserDefinedAggregateAttribute.xml +++ b/xml/Microsoft.SqlServer.Server/SqlUserDefinedAggregateAttribute.xml @@ -294,7 +294,7 @@ The maximum size allowed is 2 gigabytes (GB). You can specify a number from 1 to 8000 bytes, or -1 to represent a value larger than 8000 bytes, up to 2 gigabytes. - For an aggregate with user-defined serialization specified, refers to the total size of the serialized data. Consider an aggregate serializing a string of 10 characters (). When the string is serialized using a , the total size of the serialized string is 22 bytes: 2 bytes per Unicode UTF-16 character, multiplied by the maximum number of characters, plus 2 control bytes of overhead incurred from serializing a binary stream. So, when determining the value of , the total size of the serialized data must be considered: the size of the data serialized in binary form plus the overhead incurred by serialization. + For an aggregate with user-defined serialization specified, refers to the total size of the serialized data. Consider an aggregate serializing a string of 10 characters (). When the string is serialized using a , the total size of the serialized string is 22 bytes: 2 bytes per Unicode UTF-16 character, multiplied by the maximum number of characters, plus 2 control bytes of overhead incurred from serializing a binary stream. So, when determining the value of , the total size of the serialized data must be considered: the size of the data serialized in binary form plus the overhead incurred by serialization. ]]> diff --git a/xml/Microsoft.SqlServer.Server/SqlUserDefinedTypeAttribute.xml b/xml/Microsoft.SqlServer.Server/SqlUserDefinedTypeAttribute.xml index 2f7e57225d4..8a60855462b 100644 --- a/xml/Microsoft.SqlServer.Server/SqlUserDefinedTypeAttribute.xml +++ b/xml/Microsoft.SqlServer.Server/SqlUserDefinedTypeAttribute.xml @@ -146,7 +146,7 @@ ## Remarks When set to `true`, the property in effect guarantees that the serialized binary data can be used for semantic ordering of the information. Thus, each instance of a byte-ordered UDT object can only have one serialized representation. When a comparison operation is performed in SQL Server on the serialized bytes, its results should be the same as if the same comparison operation had taken place in managed code. - The following features are supported when is set to `true`: + The following features are supported when is set to `true`: - The ability to create indexes on columns of this type. @@ -158,7 +158,7 @@ - The ability to persist computed columns of this type. - Note that both the `Native` and `UserDefined` serialization formats support the following comparison operators when is set to `true`: + Note that both the `Native` and `UserDefined` serialization formats support the following comparison operators when is set to `true`: - Equal to (=) @@ -204,7 +204,7 @@ . This attribute is only relevant for UDTs with `UserDefined` serialization . + If set to `true`, all instances of UDTs corresponding to this common language runtime (CLR) type must have a length in bytes exactly equal to . This attribute is only relevant for UDTs with `UserDefined` serialization . ]]> @@ -239,11 +239,11 @@ ## Remarks You must specify the property with the `UserDefined` serialization . - When connecting to SQL Server 2005 or earlier, must be between 1 and 8000. + When connecting to SQL Server 2005 or earlier, must be between 1 and 8000. - When connecting to SQL Server 2008 or later, set between 1 and 8000, for a type whose instances are always 8,000 bytes or less. For types that can have instances larger than 8000, specify -1. + When connecting to SQL Server 2008 or later, set between 1 and 8000, for a type whose instances are always 8,000 bytes or less. For types that can have instances larger than 8000, specify -1. - For a UDT with user-defined serialization specified, refers to the total size of the UDT in its serialized form as defined by the user. Consider a UDT with a property of a string of 10 characters (). When the UDT is serialized using a , the total size of the serialized string is 22 bytes: 2 bytes per Unicode UTF-16 character, multiplied by the maximum number of characters, plus 2 control bytes of overhead incurred from serializing a binary stream. So, when determining the value of , the total size of the serialized UDT must be considered: the size of the data serialized in binary form plus the overhead incurred by serialization. + For a UDT with user-defined serialization specified, refers to the total size of the UDT in its serialized form as defined by the user. Consider a UDT with a property of a string of 10 characters (). When the UDT is serialized using a , the total size of the serialized string is 22 bytes: 2 bytes per Unicode UTF-16 character, multiplied by the maximum number of characters, plus 2 control bytes of overhead incurred from serializing a binary stream. So, when determining the value of , the total size of the serialized UDT must be considered: the size of the data serialized in binary form plus the overhead incurred by serialization. This property should not be used with `Native` serialization . diff --git a/xml/Microsoft.VisualBasic.Activities.XamlIntegration/VisualBasicSettingsConverter.xml b/xml/Microsoft.VisualBasic.Activities.XamlIntegration/VisualBasicSettingsConverter.xml index ccf6ecf9a02..2392c48c215 100644 --- a/xml/Microsoft.VisualBasic.Activities.XamlIntegration/VisualBasicSettingsConverter.xml +++ b/xml/Microsoft.VisualBasic.Activities.XamlIntegration/VisualBasicSettingsConverter.xml @@ -16,11 +16,11 @@ Converts a instance to the specified type. - facilitates the deserialization of Visual Basic expressions from XAML. - + facilitates the deserialization of Visual Basic expressions from XAML. + ]]> @@ -76,11 +76,11 @@ if the specified type can be converted from; otherwise, . - , this method returns `true`; otherwise, the determination is made by calling the base class method . - + , this method returns `true`; otherwise, the determination is made by calling the base class method . + ]]> @@ -112,11 +112,11 @@ if a instance can be converted to an instance of the specified type; otherwise, . - ; otherwise, the determination is made by calling the base class method . - + ; otherwise, the determination is made by calling the base class method . + ]]> @@ -149,11 +149,11 @@ Converts the specified object to a instance. An object that represents the converted value. - . If the conversion cannot be made, a is thrown. - + . If the conversion cannot be made, a is thrown. + ]]> @@ -188,11 +188,11 @@ Converts a instance to the specified type. The converted value. - . If the conversion cannot be made, a is thrown. - + . If the conversion cannot be made, a is thrown. + ]]> diff --git a/xml/Microsoft.VisualBasic.Activities/VisualBasic.xml b/xml/Microsoft.VisualBasic.Activities/VisualBasic.xml index 7b09639a7bf..3bf2f4e3aa3 100644 --- a/xml/Microsoft.VisualBasic.Activities/VisualBasic.xml +++ b/xml/Microsoft.VisualBasic.Activities/VisualBasic.xml @@ -16,11 +16,11 @@ Provides an attached property store for . - allows for an instance of to be attached to the top level activity in a workflow defined in a XAML file, thus defining the settings for all and expressions in that workflow. - + allows for an instance of to be attached to the top level activity in a workflow defined in a XAML file, thus defining the settings for all and expressions in that workflow. + ]]> @@ -100,11 +100,11 @@ The instance to attach. Attaches a instance to an object for use by its implementation. - exists for the activity author who is creating a new activity in a class. Any required by the new activity's implementation should be attached to the activity in the constructor using . - + exists for the activity author who is creating a new activity in a class. Any required by the new activity's implementation should be attached to the activity in the constructor using . + ]]> diff --git a/xml/Microsoft.VisualBasic.Activities/VisualBasicImportReference.xml b/xml/Microsoft.VisualBasic.Activities/VisualBasicImportReference.xml index 2a169ce3530..b5d92be2327 100644 --- a/xml/Microsoft.VisualBasic.Activities/VisualBasicImportReference.xml +++ b/xml/Microsoft.VisualBasic.Activities/VisualBasicImportReference.xml @@ -20,11 +20,11 @@ Represents an assembly reference and the namespace imported from that assembly. - and to provide assembly references and namespaces required for expression compilation. - + and to provide assembly references and namespaces required for expression compilation. + ]]> diff --git a/xml/Microsoft.VisualBasic.Activities/VisualBasicReference`1.xml b/xml/Microsoft.VisualBasic.Activities/VisualBasicReference`1.xml index 163101a3d7a..974c67b3ab6 100644 --- a/xml/Microsoft.VisualBasic.Activities/VisualBasicReference`1.xml +++ b/xml/Microsoft.VisualBasic.Activities/VisualBasicReference`1.xml @@ -41,11 +41,11 @@ The type of the expression. Contains an expression in Visual Basic syntax that evaluates to an l-value, which supports binding of the arguments. - @@ -148,11 +148,11 @@ if the can be converted into a string; otherwise, . - @@ -183,11 +183,11 @@ Converts the to a . A string representation of the . - surrounded by brackets. - + surrounded by brackets. + ]]> diff --git a/xml/Microsoft.VisualBasic.Activities/VisualBasicValue`1.xml b/xml/Microsoft.VisualBasic.Activities/VisualBasicValue`1.xml index a76736a214e..72d776804c7 100644 --- a/xml/Microsoft.VisualBasic.Activities/VisualBasicValue`1.xml +++ b/xml/Microsoft.VisualBasic.Activities/VisualBasicValue`1.xml @@ -41,11 +41,11 @@ The type of the expression. Contains an expression in Visual Basic syntax that evaluates to an r-value, which supports binding of arguments. - @@ -148,11 +148,11 @@ if the can be converted into a string; otherwise, . - @@ -183,11 +183,11 @@ Converts the to a . A string representation of the . - surrounded by brackets. - + surrounded by brackets. + ]]> diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/ApplicationBase.xml b/xml/Microsoft.VisualBasic.ApplicationServices/ApplicationBase.xml index 40dc19afddf..336a5f2cd03 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/ApplicationBase.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/ApplicationBase.xml @@ -139,11 +139,11 @@ property. determines the default formats for dates, times, currency, numbers, sorting order of text, string comparisons, and casing for all computations on that thread. + The `My.Application.ChangeCulture` method changes the current thread's property. determines the default formats for dates, times, currency, numbers, sorting order of text, string comparisons, and casing for all computations on that thread. To retrieve the current culture, you can use the property or the property. - The setting is different from a language setting. It contains only data related to the standard settings for a geographical region. Therefore, the property can only be set to a specific culture or to the . + The setting is different from a language setting. It contains only data related to the standard settings for a geographical region. Therefore, the property can only be set to a specific culture or to the . Use the `My.Application.ChangeUICulture` method to change the culture that the current thread uses for retrieving culture-specific resources. @@ -294,9 +294,9 @@ ## Remarks The `My.Application.CurrentCulture` property gets the object that the current thread uses for string manipulation and string formatting. This object is identical to the one returned by the property, which controls many of the string-related computations on that thread. The property determines the default formats for dates, times, currency, and numbers. It also determines how to sort, compare, and capitalize strings. - To change the culture, you can use the method or assign a different object to the property. + To change the culture, you can use the method or assign a different object to the property. - The setting is different from a language setting. It contains only data related to the standard settings for a geographical region. + The setting is different from a language setting. It contains only data related to the standard settings for a geographical region. Use the `My.Application.CurrentUICulture` property to get the culture that the current thread uses for retrieving culture-specific resources. @@ -367,7 +367,7 @@ , except that this method raises an exception if the environment variable specified by `name` does not exist. + The `My.Application.GetEnvironmentVariable` method returns the environment variable with the name `name`. This method is similar to , except that this method raises an exception if the environment variable specified by `name` does not exist. ## Availability by Project Type @@ -527,9 +527,9 @@ ## Remarks The `My.Application.CurrentUICulture` property gets the object that the current thread uses for retrieving culture-specific resources. This object is identical to the one returned by the property. The property determines the culture used by the Resource Manager and the `My.Resources` object, information it needs to look up culture-specific resources at run time. - To change the culture, you can use the method or assign a different object to the property. + To change the culture, you can use the method or assign a different object to the property. - The setting is different from a language setting. It contains only data related to the standard settings for a geographical region. + The setting is different from a language setting. It contains only data related to the standard settings for a geographical region. Use the `My.Application.CurrentCulture` property to get the culture that the current thread uses for string manipulation and string formatting. @@ -548,7 +548,7 @@ ## Examples - This example uses the `My.Application.CurrentCulture` property to cache the current culture before changing it by using . The `My.Application.ChangeUICulture` method sets the culture that the `My.Resources` object uses for retrieving resources. + This example uses the `My.Application.CurrentCulture` property to cache the current culture before changing it by using . The `My.Application.ChangeUICulture` method sets the culture that the `My.Resources` object uses for retrieving resources. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.ApplicationServices/ApplicationBase/ChangeUICulture/Form1.vb" id="Snippet10"::: diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/AssemblyInfo.xml b/xml/Microsoft.VisualBasic.ApplicationServices/AssemblyInfo.xml index 7ddf32b942e..594e550e9b1 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/AssemblyInfo.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/AssemblyInfo.xml @@ -460,7 +460,7 @@ method. + The `My.Application.Info.LoadedAssemblies` property is similar to the method. ## Availability by Project Type @@ -814,7 +814,7 @@ object containing the version number of the application. You can use the , , , and properties of the object to access specific version information about the application. + The `My.Application.Info.Version` property gets a object containing the version number of the application. You can use the , , , and properties of the object to access specific version information about the application. ClickOnce-deployed applications should use the property of the property. diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/AuthenticationMode.xml b/xml/Microsoft.VisualBasic.ApplicationServices/AuthenticationMode.xml index bc1ceb9454c..5ff463bb52e 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/AuthenticationMode.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/AuthenticationMode.xml @@ -26,13 +26,13 @@ Indicates how a Visual Basic application authenticates the user for the object. - constructor. For more information, see [Extending the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/customizing-extending-my/extending-the-visual-basic-application-model). - - A Visual Basic application that uses the Visual Basic Application Model can specify whether it uses Windows authentication or custom authentication. You can also configure the authentication mode in the Visual Studio Integrated Development Environment. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - + constructor. For more information, see [Extending the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/customizing-extending-my/extending-the-visual-basic-application-model). + + A Visual Basic application that uses the Visual Basic Application Model can specify whether it uses Windows authentication or custom authentication. You can also configure the authentication mode in the Visual Studio Integrated Development Environment. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + ]]> diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/BuiltInRoleConverter.xml b/xml/Microsoft.VisualBasic.ApplicationServices/BuiltInRoleConverter.xml index 79624995a22..368bfe1fb92 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/BuiltInRoleConverter.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/BuiltInRoleConverter.xml @@ -25,7 +25,7 @@ For more information about type converters, see the base class and [How to: Implement a Type Converter](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)). > [!CAUTION] -> You should never create an instance of a class. Instead, call the method of the class. For more information, see the examples in the base class. +> You should never create an instance of a class. Instead, call the method of the class. For more information, see the examples in the base class. ]]> @@ -143,7 +143,7 @@ on the object if the object is valid and if the destination type is . + The most common types to convert to and convert from are string objects. The default implementation makes a call to on the object if the object is valid and if the destination type is . The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `Nothing`, so always check. Also, properties on the context object can return `Nothing`. diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/CantStartSingleInstanceException.xml b/xml/Microsoft.VisualBasic.ApplicationServices/CantStartSingleInstanceException.xml index 5f7852348fa..cc53f999998 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/CantStartSingleInstanceException.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/CantStartSingleInstanceException.xml @@ -96,8 +96,8 @@ |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic).| -||The localized error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The localized error message string.| ]]> @@ -150,8 +150,8 @@ |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic)| -||The `message` string.| +||A null reference (`Nothing` in Visual Basic)| +||The `message` string.| ]]> @@ -265,8 +265,8 @@ |Property|Value| |-|-| -||The `inner` reference.| -||The `message` string.| +||The `inner` reference.| +||The `message` string.| ]]> diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/ConsoleApplicationBase.xml b/xml/Microsoft.VisualBasic.ApplicationServices/ConsoleApplicationBase.xml index cd8517bcf3a..6b58e4df763 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/ConsoleApplicationBase.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/ConsoleApplicationBase.xml @@ -142,7 +142,7 @@ > The `My.Application.CommandLineArgs` property returns only the command-line arguments. This is different from the behavior of the property, which returns the application name in addition to the arguments. > [!NOTE] -> In an application that is ClickOnce deployed, use the property of the `My.Application.Deployment` object to get the command-line arguments. For more information, see . +> In an application that is ClickOnce deployed, use the property of the `My.Application.Deployment` object to get the command-line arguments. For more information, see . The following table lists examples of tasks involving the `My.Application.CommandLineArgs` property. @@ -223,7 +223,7 @@ ## Examples - This example downloads and installs the update after checking that the application is network-deployed. The method does not update the application unless it is out of date. The application has to restart to use the update. + This example downloads and installs the update after checking that the application is network-deployed. The method does not update the application unless it is out of date. The application has to restart to use the update. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.ApplicationServices/ApplicationBase/Overview/Form1.vb" id="Snippet4"::: @@ -339,7 +339,7 @@ ## Examples - This example downloads and installs the update after checking that the application is deployed from a network. The method does not update the application unless it is out of date. The application has to restart to use the update. + This example downloads and installs the update after checking that the application is deployed from a network. The method does not update the application unless it is out of date. The application has to restart to use the update. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.ApplicationServices/ApplicationBase/Overview/Form1.vb" id="Snippet4"::: diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/NoStartupFormException.xml b/xml/Microsoft.VisualBasic.ApplicationServices/NoStartupFormException.xml index 65716cfcd93..23286e83acb 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/NoStartupFormException.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/NoStartupFormException.xml @@ -40,7 +40,7 @@ property before running the method. If the property is not set, the Visual Basic Application Model raises this exception. For more information, see [Extending the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/customizing-extending-my/extending-the-visual-basic-application-model). + The Visual Basic Application Model requires that the application set the property before running the method. If the property is not set, the Visual Basic Application Model raises this exception. For more information, see [Extending the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/customizing-extending-my/extending-the-visual-basic-application-model). > [!NOTE] > For information about how to set the startup form by using the **Project Designer**, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). @@ -91,14 +91,14 @@ property before running the method. If the property is not set, the Visual Basic Application Model raises this exception. For more information, see [Extending the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/customizing-extending-my/extending-the-visual-basic-application-model). + The Visual Basic Application Model requires that the application set the property before running the method. If the property is not set, the Visual Basic Application Model raises this exception. For more information, see [Extending the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/customizing-extending-my/extending-the-visual-basic-application-model). The following table shows the initial property values for an instance of . |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic).| -||The localized error-message string.| +||A null reference (`Nothing` in Visual Basic).| +||The localized error-message string.| ]]> @@ -151,8 +151,8 @@ |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic)| -||The `message` string.| +||A null reference (`Nothing` in Visual Basic)| +||The `message` string.| ]]> @@ -266,8 +266,8 @@ |Property|Value| |-|-| -||The `inner` reference.| -||The `message` string.| +||The `inner` reference.| +||The `message` string.| ]]> diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/ShutdownMode.xml b/xml/Microsoft.VisualBasic.ApplicationServices/ShutdownMode.xml index cddf6b098ec..8b13ac89ac8 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/ShutdownMode.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/ShutdownMode.xml @@ -29,7 +29,7 @@ property. By default, the method checks the value of the property to determine if the application should shut down. + You can set the shutdown mode for an application through the property. By default, the method checks the value of the property to determine if the application should shut down. ]]> diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/UnhandledExceptionEventArgs.xml b/xml/Microsoft.VisualBasic.ApplicationServices/UnhandledExceptionEventArgs.xml index 4158b8e5170..1cdbc09afef 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/UnhandledExceptionEventArgs.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/UnhandledExceptionEventArgs.xml @@ -41,13 +41,13 @@ Provides data for the event. - event occurs when an unhandled exception occurs in an application that implements the Visual Basic Application Model. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). - - contains the that occurred and indicates whether the application should exit upon exiting the exception handler. - + event occurs when an unhandled exception occurs in an application that implements the Visual Basic Application Model. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). + + contains the that occurred and indicates whether the application should exit upon exiting the exception handler. + ]]> @@ -96,13 +96,13 @@ The that occurred. Initializes a new instance of the class. - event occurs when an unhandled exception occurs in an application that implements the Visual Basic Application Model. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). - - contains the that occurred and indicates whether the application should exit upon exiting the exception handler. - + event occurs when an unhandled exception occurs in an application that implements the Visual Basic Application Model. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). + + contains the that occurred and indicates whether the application should exit upon exiting the exception handler. + ]]> @@ -153,11 +153,11 @@ Indicates whether the application should exit upon exiting the exception handler. A that indicates whether the application should exit upon exiting the exception handler. - event. If is `True`, then the application exits. Otherwise, the application continues to run. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). - + event. If is `True`, then the application exits. Otherwise, the application continues to run. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). + ]]> diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/User.xml b/xml/Microsoft.VisualBasic.ApplicationServices/User.xml index 40318989a04..f3f1c061cc9 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/User.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/User.xml @@ -41,7 +41,7 @@ For Windows applications, this property provides the same functionality as the property. For Web applications, this property provides the same functionality as the property of the object returned by the property. > [!NOTE] -> For Windows applications, only projects built on the **Windows Application** template initialize the `My.User` object by default. In all other Windows project types, you must initialize the `My.User` object by calling the method explicitly or by assigning a value to . +> For Windows applications, only projects built on the **Windows Application** template initialize the `My.User` object by default. In all other Windows project types, you must initialize the `My.User` object by calling the method explicitly or by assigning a value to . ## Examples This example checks if the application is using Windows or custom authentication, and uses that information to parse the `My.User.Name` property. @@ -216,7 +216,7 @@ . + You can use the `My.User.InitializeWithWindowsUser` method to set the thread's current principal to the Windows user that started the application. The Visual Basic Application Model in a Windows application calls this method at startup by default. In other project types, you must set the thread's current principal by calling this method explicitly or by assigning a value to . In Windows projects, the `My.User` object is based on the thread's current principal; therefore, this method can change the information `My.User` returns. In an ASP.NET application, the `My.User` object is based on the current HTTP request's user identity, and is unaffected by this method. @@ -392,9 +392,9 @@ ## Remarks The `My.User.IsInRole` method allows your code to determine if the current user is a member of the specified role. - The overload of the `My.User.IsInRole` method that takes a string provides easy access to the method of the current principal. + The overload of the `My.User.IsInRole` method that takes a string provides easy access to the method of the current principal. - The overload of the `My.User.IsInRole` method that takes a `BuiltInRole` enumeration behaves differently, depending on the current principal. If it is a Windows user principal (), this function converts `role` to the equivalent enumeration and returns the result of calling . If the current principal is any other principal, this function passes the name of the enumeration value in `role` to the principal's method. + The overload of the `My.User.IsInRole` method that takes a `BuiltInRole` enumeration behaves differently, depending on the current principal. If it is a Windows user principal (), this function converts `role` to the equivalent enumeration and returns the result of calling . If the current principal is any other principal, this function passes the name of the enumeration value in `role` to the principal's method. > [!NOTE] > The exact behavior of the `My.User` object depends on the type of the application and on the operating system on which the application runs. For more information, see the class overview. @@ -467,9 +467,9 @@ ## Remarks The `My.User.IsInRole` method allows your code to determine if the current user is a member of the specified role. - The overload of the `My.User.IsInRole` method that takes a string provides easy access to the method of the current principal. + The overload of the `My.User.IsInRole` method that takes a string provides easy access to the method of the current principal. - The overload of the `My.User.IsInRole` method that takes a `BuiltInRole` enumeration behaves differently, depending on the current principal. If it is a Windows user principal (), this function converts `role` to the equivalent enumeration and returns the result of calling . If the current principal is any other principal, this function passes the name of the enumeration value in `role` to the principal's method. + The overload of the `My.User.IsInRole` method that takes a `BuiltInRole` enumeration behaves differently, depending on the current principal. If it is a Windows user principal (), this function converts `role` to the equivalent enumeration and returns the result of calling . If the current principal is any other principal, this function passes the name of the enumeration value in `role` to the principal's method. > [!NOTE] > The exact behavior of the `My.User` object depends on the type of the application and on the operating system on which the application runs. For more information, see the class overview. diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/WebUser.xml b/xml/Microsoft.VisualBasic.ApplicationServices/WebUser.xml index bb8e55d10c2..0f1195ecac2 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/WebUser.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/WebUser.xml @@ -27,7 +27,7 @@ For Windows applications, this property provides the same functionality as the property. For Web applications, this property provides the same functionality as the property of the object returned by the property. > [!NOTE] -> For Windows applications, only projects built on the **Windows Application** template initialize the `My.User` object by default. In all other Windows project types, you must initialize the `My.User` object by calling the method explicitly or by assigning a value to . +> For Windows applications, only projects built on the **Windows Application** template initialize the `My.User` object by default. In all other Windows project types, you must initialize the `My.User` object by calling the method explicitly or by assigning a value to . ## Examples This example checks if the application is using Windows or custom authentication, and uses that information to parse the `My.User.Name` property. diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml b/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml index c9b98c0e6e1..09fdac06bde 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml @@ -43,7 +43,7 @@ ## Examples - This example uses a loop to iterate through the application's open forms, selects the forms that can be accessed directly by the current thread, and displays their titles in a control. For information about how to access the open forms, see . + This example uses a loop to iterate through the application's open forms, selects the forms that can be accessed directly by the current thread, and displays their titles in a control. For information about how to access the open forms, see . :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.ApplicationServices/ApplicationBase/Overview/Form1.vb" id="Snippet10"::: @@ -302,7 +302,7 @@ method. + The `My.Application.DoEvents` method allows your application to handle other events that might be raised while you code runs. The `My.Application.DoEvents` method has the same behavior as the method. When you run a Windows Forms application, it creates a new form, which then waits for events to be handled. Each time the form handles an event, such as a button click, it processes all the code associated with that event. All other events wait in the queue. While your code handles the event, your application does not respond. For example, the window does not repaint if another window is dragged on top. @@ -392,7 +392,7 @@ method uses this property to determine whether to call . + The method uses this property to determine whether to call . ]]> @@ -536,7 +536,7 @@ method uses this property to determine whether this application is a single-instance application. + The method uses this property to determine whether this application is a single-instance application. ]]> @@ -642,7 +642,7 @@ This property supports the Visual Basic Application model. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). - You should set the `My.Application.MinimumSplashScreenDisplayTime` property in a method that overrides the or method. Code that overrides methods of the class should be entered in the ApplicationEvents.vb file, which is hidden by default. + You should set the `My.Application.MinimumSplashScreenDisplayTime` property in a method that overrides the or method. Code that overrides methods of the class should be entered in the ApplicationEvents.vb file, which is hidden by default. To access the Code Editor window for overriding members: @@ -717,7 +717,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht ## Remarks An application raises the `NetworkAvailabilityChanged` event every time that the availability of the network changes. You can use the property of the `e` parameter to get the new state of the network connection. To get the current state of the network connection, use the property. - This event is raised on the application's main thread with the other user-interface events. This enables the event handler to access directly the application's UI. However, if the application is busy handling another user-interface event when this event is raised, this event cannot be processed until the other event handler finishes or calls the method. + This event is raised on the application's main thread with the other user-interface events. This enables the event handler to access directly the application's UI. However, if the application is busy handling another user-interface event when this event is raised, this event cannot be processed until the other event handler finishes or calls the method. The event provides the same functionality as this event but is available for all application types. @@ -808,7 +808,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht ## Remarks By default, this method does nothing. However, when you select a main form for your application in the Visual Basic **Project Designer**, the designer overrides this method with a method that sets the property to a new instance of the main form. - This method is called by the method. + This method is called by the method. ]]> @@ -854,9 +854,9 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht method with a method that sets the property to a new instance of the splash-screen form. + By default, this method does nothing. If you select a splash screen for your application in the Visual Basic **Project Designer**, the designer overrides the method with a method that sets the property to a new instance of the splash-screen form. - This method is called by the method. + This method is called by the method. ]]> @@ -914,9 +914,9 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht This method calls the following methods: -- . +- . -- . +- . ]]> @@ -971,11 +971,11 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht ## Remarks By default, before it enters the Windows Forms message loop, this method calls the `OnCreateMainForm` (to create the application's main form) and `HideSplashScreen` (to close the splash screen) methods: -- . Provides a way for a designer to emit code that initializes the main form. +- . Provides a way for a designer to emit code that initializes the main form. - By default, this method does nothing. However, when you select a main form for your application in the Visual Basic **Project Designer**, the designer overrides the method with a method that sets the property to a new instance of the main form. + By default, this method does nothing. However, when you select a main form for your application in the Visual Basic **Project Designer**, the designer overrides the method with a method that sets the property to a new instance of the main form. -- . If the application has a splash screen defined and it is open, this method closes the splash screen. +- . If the application has a splash screen defined and it is open, this method closes the splash screen. By default, this method closes the splash screen. @@ -1076,7 +1076,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht event. The event handler can set the property of the event argument. If is `True`, this method returns `False` to cancel the application startup. Otherwise, this method returns `True`. + By default, this method raises the event. The event handler can set the property of the event argument. If is `True`, this method returns `False` to cancel the application startup. Otherwise, this method returns `True`. ]]> @@ -1131,7 +1131,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht event. The event handler can set the property of the event argument. If is `True`, the method activates the main form. Otherwise, the main form is left in its current state. + By default, this method raises the event. The event handler can set the property of the event argument. If is `True`, the method activates the main form. Otherwise, the main form is left in its current state. ]]> @@ -1184,7 +1184,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht event as long as a debugger is not attached and the user is handling the `UnhandledException` event. The event handler can set the property. If is `False`, or if the event is not handled, the application exits upon return from the exception handler. Otherwise, control of the application is returned to the Windows Forms message loop. + By default, this method raises the event as long as a debugger is not attached and the user is handling the `UnhandledException` event. The event handler can set the property. If is `False`, or if the event is not handled, the application exits upon return from the exception handler. Otherwise, control of the application is returned to the Windows Forms message loop. ]]> @@ -1367,7 +1367,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht method of the `My.Settings` object. For more information about changing and saving settings, see [Application Properties](/previous-versions/visualstudio/visual-studio-2015/ide/application-properties). + The `SaveMySettingsOnExit` property allows the user to change how the application saves settings, at run time. You can explicitly save setting changes by using the method of the `My.Settings` object. For more information about changing and saving settings, see [Application Properties](/previous-versions/visualstudio/visual-studio-2015/ide/application-properties). The changes to this property are not persisted when the application closes. To change the `SaveMySettingsOnExit` property permanently, you must change the setting in the **Project Designer**: @@ -1449,9 +1449,9 @@ To change the setting in the Project Designer: ## Remarks By default, this method calls `OnCreateSplashScreen` in a thread-safe way. - The method contains the code that displays the splash screen for at least the number of milliseconds specified by the property. To use this functionality, you must set the `My.Application.MinimumSplashScreenDisplayTime` property in a method that overrides the or method, or add the splash screen to your application using the **Project Designer**. For more information, see . + The method contains the code that displays the splash screen for at least the number of milliseconds specified by the property. To use this functionality, you must set the `My.Application.MinimumSplashScreenDisplayTime` property in a method that overrides the or method, or add the splash screen to your application using the **Project Designer**. For more information, see . - This method is called by the method. + This method is called by the method. ]]> @@ -1573,7 +1573,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht method checks the value of this property to determine if the application should shut down when the main form is closed, or if another open form should be promoted as the new main form. + The method checks the value of this property to determine if the application should shut down when the main form is closed, or if another open form should be promoted as the new main form. ]]> @@ -1776,7 +1776,7 @@ For more information, see [Application Page, Project Designer (Visual Basic)](ht This event is part of the Visual Basic Application model. For more information, see [Overview of the Visual Basic Application Model](/dotnet/visual-basic/developing-apps/development-with-my/overview-of-the-visual-basic-application-model). - This event is raised on the application's main thread with the other user-interface events. This allows the event handler to access directly the application's user interface. However, if the application is busy handling another user-interface event when this event is raised, this event cannot be processed until the other event handler finishes or calls the method. + This event is raised on the application's main thread with the other user-interface events. This allows the event handler to access directly the application's user interface. However, if the application is busy handling another user-interface event when this event is raised, this event cannot be processed until the other event handler finishes or calls the method. > [!NOTE] > The `StartupNextInstance` event is raised only in single-instance applications. To enable single-instance behavior for your application, you must check the **Make single instance application** check box in the Project Designer. @@ -1798,7 +1798,7 @@ To access the Code Editor window for application events: |To|See| |-|-| -|Check the command-line arguments of the first application instance|| +|Check the command-line arguments of the first application instance|| ## Availability by Project Type @@ -1868,7 +1868,7 @@ To access the Code Editor window for application events: You can use the property of the `e` parameter to access the unhandled exception that caused this event. - You can use the property of the `e` parameter to control whether the application exits. By default, is `True`. Therefore, the application exits after completing the `UnhandledException` event handler. You can set the value to `False` in the `UnhandledException` event handler to keep the application running, and have it return to a waiting state. + You can use the property of the `e` parameter to control whether the application exits. By default, is `True`. Therefore, the application exits after completing the `UnhandledException` event handler. You can set the value to `False` in the `UnhandledException` event handler to keep the application running, and have it return to a waiting state. The code for the `UnhandledException` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODC.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODC.xml index 90c480ce2db..6c275db7130 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODC.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODC.xml @@ -190,9 +190,9 @@ return values are determined by the location of the current row pointer if this pointer is valid. If either `BOF` or is `true`, there is no current row, and any attempt to reference data causes an exception. + The `BOF` and return values are determined by the location of the current row pointer if this pointer is valid. If either `BOF` or is `true`, there is no current row, and any attempt to reference data causes an exception. - You can use the `BOF` and properties to determine whether an object contains rows or whether you have gone beyond the limits of an as you move from row to row. + You can use the `BOF` and properties to determine whether an object contains rows or whether you have gone beyond the limits of an as you move from row to row. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -238,7 +238,7 @@ is the current row. + Use this property to specify the behavior when the `MovePrevious` button is pressed and the first row of a is the current row. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -284,7 +284,7 @@ , the provider fetches the first 10 records into local memory. Therefore, as you move forward from the current record, the provider returns the data values from the local memory buffer. As soon as you move past the last record, the next 10 records are fetched from the data source into the cache. + The `CacheSize` value tells the provider how many records to keep in its buffer and how many records to fetch at one time to local memory. For example, when set to 10, after opening the first , the provider fetches the first 10 records into local memory. Therefore, as you move forward from the current record, the provider returns the data values from the local memory buffer. As soon as you move past the last record, the next 10 records are fetched from the data source into the cache. While you can change value during the life of the cursor, the change only affects the number of records in the cache after the next fetch from the data source. @@ -574,7 +574,7 @@ . + Determines the cursor type to use when opening a . > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -614,7 +614,7 @@ method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. + This method is called by the public `Dispose()` method and the method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. @@ -701,9 +701,9 @@ and `EOF` return values are determined by the location of the current row pointer if this pointer is valid. If either or `EOF` is `true`, there is no current row, and any attempt to reference data causes an exception. + The and `EOF` return values are determined by the location of the current row pointer if this pointer is valid. If either or `EOF` is `true`, there is no current row, and any attempt to reference data causes an exception. - You can use the and `EOF` properties to determine whether an object contains rows or whether you have gone beyond the limits of an as you move from row to row. + You can use the and `EOF` properties to determine whether an object contains rows or whether you have gone beyond the limits of an as you move from row to row. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -749,7 +749,7 @@ is the current row. + Use this property to specify the behavior when the `MoveNext` button is pressed when the first row of a is the current row. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1675,7 +1675,7 @@ are supplied, the control uses the values to create a connection string ( property). + The user-name syntax depends on the data source. When a `UserName` and are supplied, the control uses the values to create a connection string ( property). > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODCArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODCArray.xml index fcea85cfa1c..2628907369f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODCArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ADODCArray.xml @@ -81,7 +81,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -119,7 +119,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -779,7 +779,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -789,7 +789,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1047,7 +1047,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1189,7 +1189,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1428,7 +1428,7 @@ MsgBox(CStr(ADODCArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1463,7 +1463,7 @@ MsgBox(CStr(ADODCArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1473,7 +1473,7 @@ MsgBox(CStr(ADODCArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1646,7 +1646,7 @@ MsgBox(CStr(ADODCArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2155,7 +2155,7 @@ MsgBox(CStr(ADODCArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2237,7 +2237,7 @@ MsgBox(CStr(ADODCArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should be called only when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2483,7 +2483,7 @@ MsgBox(CStr(ADODCArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2497,7 +2497,7 @@ MsgBox(CStr(ADODCArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2548,7 +2548,7 @@ MsgBox(CStr(ADODCArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2562,7 +2562,7 @@ MsgBox(CStr(ADODCArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml index 10498503570..4a9777d2a4f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml @@ -501,7 +501,7 @@ method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. + This method is called by the public `Dispose()` method and the method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. @@ -702,7 +702,7 @@ function to determine the size of a control array. + The `LBound` function is used with the function to determine the size of a control array. The class is the base class for all control arrays used in applications upgraded from Visual Basic 6.0. @@ -811,7 +811,7 @@ and `EndInit` methods prevents the control from being used before it is fully initialized. The initialization occurs at run time. + Design environments typically use this method to finish the initialization of a component that is used on a form or used by another component. The `EndInit` method ends the initialization. Using the and `EndInit` methods prevents the control from being used before it is fully initialized. The initialization occurs at run time. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -844,7 +844,7 @@ function to determine the size of a control array. + The `UBound` function is used with the function to determine the size of a control array. The class is the base class for all control arrays used in applications upgraded from Visual Basic 6.0. @@ -884,7 +884,7 @@ This method is the equivalent of the Visual Basic 6.0 `Unload` function for dynamically removing a control array element. > [!NOTE] -> Only controls that were added dynamically by using the method can be removed from the control array. +> Only controls that were added dynamically by using the method can be removed from the control array. The class is the base class for all control arrays that are used in applications upgraded from Visual Basic 6.0. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseDataEnvironment.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseDataEnvironment.xml index ed08741f546..ee9e38b5cb0 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseDataEnvironment.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseDataEnvironment.xml @@ -30,13 +30,13 @@ Emulates a Visual Basic 6.0 in applications that have been upgraded from Visual Basic 6.0. - @@ -57,13 +57,13 @@ Initializes a new instance of the class. - @@ -101,13 +101,13 @@ The listener to add. This method is not implemented in the class. - class. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -147,13 +147,13 @@ Gets a collection of objects for use in an application upgraded from Visual Basic 6.0. A collection of objects. - @@ -188,13 +188,13 @@ Gets a collection of objects for use in an application upgraded from Visual Basic 6.0. A collection of objects. - @@ -234,13 +234,13 @@ Gets a collection of objects for use in an application upgraded from Visual Basic 6.0. A collection of objects. - @@ -275,13 +275,13 @@ Gets a collection of objects for use in an application upgraded from Visual Basic 6.0. A collection of objects. - @@ -318,13 +318,13 @@ Releases the unmanaged resources that are used by a . - method. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + method. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -353,15 +353,15 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Releases the unmanaged resources that are used by a , and optionally releases the managed resources. - method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. - - When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. + + When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -393,13 +393,13 @@ Overrides the method. - @@ -433,13 +433,13 @@ Invokes a method based on an object. An that contains the object. - @@ -465,15 +465,15 @@ Gets a count of objects. An that contains the count. - @@ -503,15 +503,15 @@ . - class. - - When an application is upgraded to Visual Basic, a `BaseDataEnvironment` is created to enable the ADO-related code. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class. + + When an application is upgraded to Visual Basic, a `BaseDataEnvironment` is created to enable the ADO-related code. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -535,11 +535,11 @@ Contains the collection. - @@ -563,11 +563,11 @@ Contains the collection. - @@ -591,11 +591,11 @@ Contains a collection. - @@ -619,11 +619,11 @@ Contains the collection. - @@ -648,13 +648,13 @@ Gets the object. A object. - @@ -694,13 +694,13 @@ Gets a collection of objects for use in an application upgraded from Visual Basic 6.0. A collection of objects. - @@ -735,13 +735,13 @@ Gets a collection of objects for use in an application upgraded from Visual Basic 6.0. A collection of objects. - @@ -778,15 +778,15 @@ Not applicable. This method is not implemented in the class. - class. - - When an application is upgraded to Visual Basic, a `BaseDataEnvironment` is created to enable the ADO-related code. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class. + + When an application is upgraded to Visual Basic, a `BaseDataEnvironment` is created to enable the ADO-related code. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseOcxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseOcxArray.xml index 7b7ff21798c..de58028a0ec 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseOcxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseOcxArray.xml @@ -69,7 +69,7 @@ method to create the initial element in the array. + When you instantiate a `BaseOcxArray`, you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -107,7 +107,7 @@ method to create the initial element in the array. + When you instantiate a `BaseOcxArray`, you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -415,7 +415,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -447,7 +447,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -457,7 +457,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -750,7 +750,7 @@ of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -856,7 +856,7 @@ or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -870,7 +870,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -921,7 +921,7 @@ or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -935,7 +935,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ButtonArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ButtonArray.xml index a5fac61ec40..8cc21175f52 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ButtonArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ButtonArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -877,7 +877,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -887,7 +887,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -999,7 +999,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1035,7 +1035,7 @@ or . + This method can be used to retrieve the index for the or . > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1141,7 +1141,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1347,7 +1347,7 @@ MsgBox(CStr(ButtonArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1382,7 +1382,7 @@ MsgBox(CStr(ButtonArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1392,7 +1392,7 @@ MsgBox(CStr(ButtonArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1674,7 +1674,7 @@ MsgBox(CStr(ButtonArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2135,7 +2135,7 @@ MsgBox(CStr(ButtonArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get it's property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data to a and get it's 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2217,7 +2217,7 @@ MsgBox(CStr(ButtonArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2499,7 +2499,7 @@ MsgBox(CStr(ButtonArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2513,7 +2513,7 @@ MsgBox(CStr(ButtonArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2564,7 +2564,7 @@ MsgBox(CStr(ButtonArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2578,7 +2578,7 @@ MsgBox(CStr(ButtonArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckBoxArray.xml index c40847ff434..c7ff71ec0a8 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -979,7 +979,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -989,7 +989,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1101,7 +1101,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1243,7 +1243,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1449,7 +1449,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1484,7 +1484,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1494,7 +1494,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1778,7 +1778,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2239,7 +2239,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get it's property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data to a and get it's 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2321,7 +2321,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2603,7 +2603,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2617,7 +2617,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2668,7 +2668,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2682,7 +2682,7 @@ MsgBox(CStr(CheckBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckedListBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckedListBoxArray.xml index 43aeae77e28..e28777cc2b7 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckedListBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/CheckedListBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -807,7 +807,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -817,7 +817,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1029,7 +1029,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1171,7 +1171,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1445,7 +1445,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1480,7 +1480,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1490,7 +1490,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1837,7 +1837,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2269,7 +2269,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get it's property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data to a and get it's 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2375,7 +2375,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) is changed by either a programmatic modification or user interaction. + This event is raised if the is changed by either a programmatic modification or user interaction. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2420,7 +2420,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2668,7 +2668,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2682,7 +2682,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2733,7 +2733,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2747,7 +2747,7 @@ MsgBox(CStr(CheckedListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ColorDialogArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ColorDialogArray.xml index 2a8e3211270..13782eb149f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ColorDialogArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ColorDialogArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -195,7 +195,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -302,7 +302,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -427,7 +427,7 @@ MsgBox(CStr(ColorDialogArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ComboBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ComboBoxArray.xml index e15169f2479..dddf8592a59 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ComboBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ComboBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1213,7 +1213,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1354,7 +1354,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1594,7 +1594,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1629,7 +1629,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1639,7 +1639,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2019,7 +2019,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2447,7 +2447,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2631,7 +2631,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2947,7 +2947,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2961,7 +2961,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -3012,7 +3012,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -3026,7 +3026,7 @@ MsgBox(CStr(ComboBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBox.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBox.xml index f320b3eae87..71358e2bafe 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBox.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBox.xml @@ -32,7 +32,7 @@ ## Remarks Use this control to display a hierarchical list of directories. You can create dialog boxes that, for example, enable a user to open a file from a list of files in all available directories. - Set the , , and properties to enable a user to access items in a list. If you also display the and controls, you can write code to synchronize them with the control and with each other. + Set the , , and properties to enable a user to access items in a list. If you also display the and controls, you can write code to synchronize them with the control and with each other. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -240,7 +240,7 @@ and properties. + Use this property to access list items. The `DirList` property works together with the and properties. For a control, the `Index` number sequence is based on the current directories and subdirectories when the control is created at run time. @@ -286,7 +286,7 @@ and properties. + Use this property to return the number of subdirectories in the currently selected directory. The `DirListCount` property works together with the and properties. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -330,7 +330,7 @@ and properties. + Use this property to return the index of the currently selected directory. The `DirListIndex` property works together with the and properties. The expression `instance.DirList(instance.DirListIndex)` returns the string for the currently selected directory. @@ -374,7 +374,7 @@ method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. + This method is called by the public `Dispose()` method and the method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBoxArray.xml index 31f2768055f..ef6c639edd9 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -769,7 +769,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -779,7 +779,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -891,7 +891,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1033,7 +1033,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1273,7 +1273,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1308,7 +1308,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1318,7 +1318,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1525,7 +1525,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1885,7 +1885,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2035,7 +2035,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2283,7 +2283,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2297,7 +2297,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2348,7 +2348,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2362,7 +2362,7 @@ MsgBox(CStr(DirListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBox.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBox.xml index fd8b6b356b5..975f3921a93 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBox.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBox.xml @@ -196,7 +196,7 @@ method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. + This method is called by the public `Dispose()` method and the method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. @@ -980,7 +980,7 @@ method. + All messages are sent to the `WndProc` method after being filtered through the method. The `WndProc` method corresponds exactly to the Windows `WindowProc` function. For more information about processing Windows messages, see [WindowProc callback function](https://learn.microsoft.com/previous-versions/windows/desktop/legacy/ms633573(v=vs.85)). diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBoxArray.xml index d45ee9e3328..99c2c335a7a 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -836,7 +836,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -846,7 +846,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -958,7 +958,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1100,7 +1100,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1340,7 +1340,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1375,7 +1375,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1385,7 +1385,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1592,7 +1592,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1952,7 +1952,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2136,7 +2136,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2418,7 +2418,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2432,7 +2432,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2483,7 +2483,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2497,7 +2497,7 @@ MsgBox(CStr(DriveListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/FileListBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/FileListBoxArray.xml index 15f496d7308..176f8d191f9 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/FileListBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/FileListBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -735,7 +735,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -745,7 +745,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -857,7 +857,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -999,7 +999,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1239,7 +1239,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1274,7 +1274,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1284,7 +1284,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1491,7 +1491,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1909,7 +1909,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2059,7 +2059,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2307,7 +2307,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2321,7 +2321,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2372,7 +2372,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2386,7 +2386,7 @@ MsgBox(CStr(FileListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/FixedLengthString.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/FixedLengthString.xml index e6d2911ade3..4d397f48a93 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/FixedLengthString.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/FixedLengthString.xml @@ -28,7 +28,7 @@ ## Remarks In Visual Basic 6.0, a `String` could be declared with a fixed length. In Visual Basic, fixed-length strings are no longer supported and a new is allocated every time the length of the is changed. - The `FixedLengthString` class can be used to emulate the behavior of a Visual Basic 6.0 string, which enables you to declare a string with a fixed length. A `FixedLengthString` cannot be converted to a ; you must either reference the property or call the method to convert the type. + The `FixedLengthString` class can be used to emulate the behavior of a Visual Basic 6.0 string, which enables you to declare a string with a fixed length. A `FixedLengthString` cannot be converted to a ; you must either reference the property or call the method to convert the type. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -257,7 +257,7 @@ End Sub class can be used to emulate the behavior of a Visual Basic 6.0 string, which enables you to declare a string with a fixed length. A cannot be converted to a ; you must either reference the property or call the method to convert the type. + The class can be used to emulate the behavior of a Visual Basic 6.0 string, which enables you to declare a string with a fixed length. A cannot be converted to a ; you must either reference the property or call the method to convert the type. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -308,7 +308,7 @@ End Sub class can be used to emulate the behavior of a Visual Basic 6.0 string, which enables you to declare a string with a fixed length. A cannot be converted to a ; you must either reference the property or call the method to convert the type. + The class can be used to emulate the behavior of a Visual Basic 6.0 string, which enables you to declare a string with a fixed length. A cannot be converted to a ; you must either reference the property or call the method to convert the type. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/FontDialogArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/FontDialogArray.xml index c57ed9f644b..eea260ccf6f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/FontDialogArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/FontDialogArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -229,7 +229,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -336,7 +336,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -461,7 +461,7 @@ MsgBox(CStr(FontDialogArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/FormShowConstants.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/FormShowConstants.xml index a3a343b7e0c..2890907fb20 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/FormShowConstants.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/FormShowConstants.xml @@ -25,7 +25,7 @@ and . + In Visual Basic 6.0, the `Modal` parameter of the `Show` method was used to determine whether a form would be shown as a modal dialog box. In Visual Basic, the `Modal` parameter is replaced by two different Show methods: and . These constants enable code that has been upgraded from Visual Basic 6.0 to continue to run without additional modification. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/GroupBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/GroupBoxArray.xml index 3520f700529..319f7b13bab 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/GroupBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/GroupBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -841,7 +841,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -851,7 +851,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -963,7 +963,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1105,7 +1105,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1212,7 +1212,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1247,7 +1247,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1257,7 +1257,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1403,7 +1403,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1731,7 +1731,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -1813,7 +1813,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2061,7 +2061,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2075,7 +2075,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2126,7 +2126,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2140,7 +2140,7 @@ MsgBox(CStr(GroupBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/HScrollBarArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/HScrollBarArray.xml index 79b967defa3..75264191753 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/HScrollBarArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/HScrollBarArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -705,7 +705,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -715,7 +715,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -759,7 +759,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1112,7 +1112,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1147,7 +1147,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1157,7 +1157,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1348,7 +1348,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1686,7 +1686,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -1800,7 +1800,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2048,7 +2048,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2062,7 +2062,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2113,7 +2113,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2127,7 +2127,7 @@ MsgBox(CStr(HScrollBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ImageListArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ImageListArray.xml index c15f17b3bc5..056fecdcbce 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ImageListArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ImageListArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -195,7 +195,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -267,7 +267,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -392,7 +392,7 @@ MsgBox(CStr(ImageListArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/LabelArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/LabelArray.xml index 04c70800b93..58dadcf2052 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/LabelArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/LabelArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -841,7 +841,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -851,7 +851,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -963,7 +963,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1105,7 +1105,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1178,7 +1178,7 @@ MsgBox(CStr(LabelArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1213,7 +1213,7 @@ MsgBox(CStr(LabelArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1223,7 +1223,7 @@ MsgBox(CStr(LabelArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1557,7 +1557,7 @@ MsgBox(CStr(LabelArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2020,7 +2020,7 @@ MsgBox(CStr(LabelArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2102,7 +2102,7 @@ MsgBox(CStr(LabelArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2384,7 +2384,7 @@ MsgBox(CStr(LabelArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2398,7 +2398,7 @@ MsgBox(CStr(LabelArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2449,7 +2449,7 @@ MsgBox(CStr(LabelArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2463,7 +2463,7 @@ MsgBox(CStr(LabelArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxArray.xml index 88aa5580e04..599a5b9303d 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -909,7 +909,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -919,7 +919,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1133,7 +1133,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1275,7 +1275,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1515,7 +1515,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1550,7 +1550,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1560,7 +1560,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1929,7 +1929,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2357,7 +2357,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2507,7 +2507,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2755,7 +2755,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2769,7 +2769,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2820,7 +2820,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2834,7 +2834,7 @@ MsgBox(CStr(ListBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxItem.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxItem.xml index b9359149da8..5f043844ff0 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxItem.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ListBoxItem.xml @@ -28,7 +28,7 @@ ## Remarks In Visual Basic 6.0, the `ListBox` and `ComboBox` controls use a `List` property to store list items and an `ItemData` property to optionally store an `Integer` associated with each list item. In Visual Basic, the and controls use the property to store list items, and the `ItemData` property is no longer supported. - When a Visual Basic 6.0 application is upgraded to Visual Basic, the upgrade tools create a `ListBoxItem` class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. + When a Visual Basic 6.0 application is upgraded to Visual Basic, the upgrade tools create a `ListBoxItem` class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -74,7 +74,7 @@ class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. + When a Visual Basic 6.0 application is upgraded to Visual Basic, the upgrade tools create a class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -113,7 +113,7 @@ class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. + When a Visual Basic 6.0 application is upgraded to Visual Basic, the upgrade tools create a class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -143,7 +143,7 @@ class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. + When a Visual Basic 6.0 application is upgraded to Visual Basic, the upgrade tools create a class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -173,7 +173,7 @@ class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. + When a Visual Basic 6.0 application is upgraded to Visual Basic, the upgrade tools create a class for each item in a or control. The and functions can then be used to enable any code that references the `ItemData` property. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ListViewArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ListViewArray.xml index dfed6a94bc4..00c82d1e48f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ListViewArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ListViewArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -149,7 +149,7 @@ ## Remarks The `AfterLabelEdit` event occurs when the user finishes modifying the text for an item. The new string that the user types for the item is passed to the event, and the event handler can reject the change. If the event handler rejects the change, the text reverts to the text as it was before the user began editing the item. - In order for the `AfterLabelEdit` event to be raised, the property of the control must be set to `true`. + In order for the `AfterLabelEdit` event to be raised, the property of the control must be set to `true`. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -569,7 +569,7 @@ of the will not change to the value. + The `ColumnReordered` event is a cancelable event and can be canceled by handling the event and setting the [System.Windows.Forms.ColumnReorderedEventArgs.Cancel](xref:System.ComponentModel.CancelEventArgs.Cancel) property to `true`. However, if the event is canceled, the of the will not change to the value. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1181,7 +1181,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -1191,7 +1191,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1303,7 +1303,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1445,7 +1445,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1552,7 +1552,7 @@ MsgBox(CStr(ListViewArray(1).Text)) control. The user can activate an item with either a single-click or double-click, depending on the value of the property, or with the keyboard. From within the event handler for the `ItemActivate` event, you can reference the or properties to access the collection of items selected in the to determine which items are being activated. + The `ItemActivate` event occurs when the user activates one or more items in the control. The user can activate an item with either a single-click or double-click, depending on the value of the property, or with the keyboard. From within the event handler for the `ItemActivate` event, you can reference the or properties to access the collection of items selected in the to determine which items are being activated. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1652,7 +1652,7 @@ MsgBox(CStr(ListViewArray(1).Text)) method. You can use this event to perform the tasks necessary to drag items into and out of your application's control. + The `ItemDrag` event occurs when the user begins dragging an item. Typically the event handler for the `ItemDrag` event performs the task of dragging by calling the method. You can use this event to perform the tasks necessary to drag items into and out of your application's control. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1887,7 +1887,7 @@ MsgBox(CStr(ListViewArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1922,7 +1922,7 @@ MsgBox(CStr(ListViewArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1932,7 +1932,7 @@ MsgBox(CStr(ListViewArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2268,7 +2268,7 @@ MsgBox(CStr(ListViewArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2696,7 +2696,7 @@ MsgBox(CStr(ListViewArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2835,7 +2835,7 @@ MsgBox(CStr(ListViewArray(1).Text)) is in virtual mode and the or method is called. When handling this event, you should calculate which item from the list of items supplied by the Items property matches the search criteria and set the `SearchForVirtualItemEventArgs.Index` property to the index of the ListViewItem. If an item is not provided, and FindItemWithText will return a null reference (Nothing in Visual Basic). + This event occurs when a is in virtual mode and the or method is called. When handling this event, you should calculate which item from the list of items supplied by the Items property matches the search criteria and set the `SearchForVirtualItemEventArgs.Index` property to the index of the ListViewItem. If an item is not provided, and FindItemWithText will return a null reference (Nothing in Visual Basic). For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2914,7 +2914,7 @@ MsgBox(CStr(ListViewArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -3162,7 +3162,7 @@ MsgBox(CStr(ListViewArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -3176,7 +3176,7 @@ MsgBox(CStr(ListViewArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -3227,7 +3227,7 @@ MsgBox(CStr(ListViewArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -3241,7 +3241,7 @@ MsgBox(CStr(ListViewArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/MBinding.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/MBinding.xml index 01c3762fe0b..8884da5aa33 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/MBinding.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/MBinding.xml @@ -34,11 +34,11 @@ Enables Windows Forms controls to be bound to ADO recordsets. This type is a managed equivalent of the Visual Basic 6.0 msbind library. - @@ -77,11 +77,11 @@ if data has changed; otherwise, . - @@ -115,11 +115,11 @@ Gets a data field. A that contains the data. - @@ -147,11 +147,11 @@ Gets or sets the data format for a data field. An interface. - @@ -188,13 +188,13 @@ Releases the unmanaged resources that are used by an . - method. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + method. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -223,15 +223,15 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Releases the unmanaged resources that are used by an and, optionally, releases the managed resources. - method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the `disposing` parameter set to `false`. - - When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the `disposing` parameter set to `false`. + + When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -265,11 +265,11 @@ Gets the key value for a data field. A that contains the key value. - @@ -303,11 +303,11 @@ Gets a data object. An that contains data. - @@ -341,11 +341,11 @@ Gets the name of a property from a data object. A that contains the property name. - diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/MBindingCollection.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/MBindingCollection.xml index b7c861bc7e5..6b6798a1c96 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/MBindingCollection.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/MBindingCollection.xml @@ -349,7 +349,7 @@ method. + This method is called by the public `Dispose()` method and the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -385,7 +385,7 @@ method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. + This method is called by the public `Dispose()` method and the method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the disposing parameter set to `true`. invokes `Dispose` with the disposing parameter set to `false`. When the disposing parameter is `true`, this method releases all resources held by any managed objects that this control references. This method invokes the `Dispose()` method of each referenced object. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/MaskedTextBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/MaskedTextBoxArray.xml index 043770228e4..33ccdb634ad 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/MaskedTextBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/MaskedTextBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -841,7 +841,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -851,7 +851,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -963,7 +963,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1139,7 +1139,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1413,7 +1413,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1448,7 +1448,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1458,7 +1458,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1569,7 +1569,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) property is changed by either a programmatic modification or user interaction. This event is also raised if the is indirectly changed by a member such as , , , and . + This event is raised if the property is changed by either a programmatic modification or user interaction. This event is also raised if the is indirectly changed by a member such as , , , and . For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1891,7 +1891,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2317,7 +2317,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2399,7 +2399,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should be called only when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2750,7 +2750,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2764,7 +2764,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2815,7 +2815,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2829,7 +2829,7 @@ MsgBox(CStr(MaskedTextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/MenuItemArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/MenuItemArray.xml index ad6bab9a3e8..42ef3f73bf8 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/MenuItemArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/MenuItemArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -265,7 +265,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -337,7 +337,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -564,7 +564,7 @@ MsgBox(CStr(MenuItemArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/OpenFileDialogArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/OpenFileDialogArray.xml index 4bfc2e845cd..229bf65329e 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/OpenFileDialogArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/OpenFileDialogArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate an , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -227,7 +227,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -331,7 +331,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -456,7 +456,7 @@ MsgBox(CStr(OpenFileDialogArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/PanelArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/PanelArray.xml index a8ecee0a2be..c9d3ce7721a 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/PanelArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/PanelArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -909,7 +909,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -919,7 +919,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1031,7 +1031,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1173,7 +1173,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1280,7 +1280,7 @@ MsgBox(CStr(PanelArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1315,7 +1315,7 @@ MsgBox(CStr(PanelArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1325,7 +1325,7 @@ MsgBox(CStr(PanelArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1655,7 +1655,7 @@ MsgBox(CStr(PanelArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2116,7 +2116,7 @@ MsgBox(CStr(PanelArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2230,7 +2230,7 @@ MsgBox(CStr(PanelArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should be called only when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2478,7 +2478,7 @@ MsgBox(CStr(PanelArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2492,7 +2492,7 @@ MsgBox(CStr(PanelArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2543,7 +2543,7 @@ MsgBox(CStr(PanelArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2557,7 +2557,7 @@ MsgBox(CStr(PanelArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/PictureBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/PictureBoxArray.xml index df8580cf465..ead2fac3bb4 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/PictureBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/PictureBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -843,7 +843,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -985,7 +985,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1058,7 +1058,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1093,7 +1093,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) methods, and is false. If the image-load is canceled by calling the method the property of the will be set to true. If an exception or error occurs during the load process, it will be caught and the `Error` property of the will contain the exception information. + The `LoadCompleted` event occurs only when the image is loaded asynchronously by using one of the methods, and is false. If the image-load is canceled by calling the method the property of the will be set to true. If an exception or error occurs during the load process, it will be caught and the `Error` property of the will contain the exception information. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1127,7 +1127,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) methods. The progress percentage of the image load is reported with the property of the . + The `LoadProgressChanged` event occurs only when the image is loaded asynchronously by using one of the methods. The progress percentage of the image load is reported with the property of the . Handle the `LoadProgressChanged` event if you want to reflect the progress of an asynchronous image-loading operation in a or similar control. Use the property of the to update the progress value. @@ -1450,7 +1450,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1911,7 +1911,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -1959,7 +1959,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2173,7 +2173,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2187,7 +2187,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2238,7 +2238,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2252,7 +2252,7 @@ MsgBox(CStr(PictureBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/PrintDialogArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/PrintDialogArray.xml index a0692ef1f5a..67beba3212c 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/PrintDialogArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/PrintDialogArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -195,7 +195,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -302,7 +302,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -427,7 +427,7 @@ MsgBox(CStr(PrintDialogArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ProgressBarArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ProgressBarArray.xml index 4d3059b7c8e..8f3ac2350a0 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ProgressBarArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ProgressBarArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -777,7 +777,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -919,7 +919,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -992,7 +992,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1266,7 +1266,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1692,7 +1692,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -1808,7 +1808,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2022,7 +2022,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2036,7 +2036,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2087,7 +2087,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2101,7 +2101,7 @@ MsgBox(CStr(ProgressBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/RadioButtonArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/RadioButtonArray.xml index 761c11918d5..7d63834dacf 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/RadioButtonArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/RadioButtonArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -945,7 +945,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -955,7 +955,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -1067,7 +1067,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1209,7 +1209,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1415,7 +1415,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1450,7 +1450,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1460,7 +1460,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1744,7 +1744,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2205,7 +2205,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2287,7 +2287,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2569,7 +2569,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2583,7 +2583,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2634,7 +2634,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2648,7 +2648,7 @@ MsgBox(CStr(RadioButtonArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/RichTextBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/RichTextBoxArray.xml index 28d605bdce6..90a8d2c3dc7 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/RichTextBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/RichTextBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -871,7 +871,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1012,7 +1012,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1316,7 +1316,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1351,7 +1351,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1361,7 +1361,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1775,7 +1775,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2236,7 +2236,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2352,7 +2352,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2634,7 +2634,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2648,7 +2648,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2699,7 +2699,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2713,7 +2713,7 @@ MsgBox(CStr(RichTextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/SaveFileDialogArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/SaveFileDialogArray.xml index c33466d49b1..aa0214c37b9 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/SaveFileDialogArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/SaveFileDialogArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -227,7 +227,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -331,7 +331,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -456,7 +456,7 @@ MsgBox(CStr(SaveFileDialogArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusBarArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusBarArray.xml index 8081dc20aae..b2cd6b7431f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusBarArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusBarArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -880,7 +880,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1021,7 +1021,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1227,7 +1227,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1262,7 +1262,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1272,7 +1272,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1618,7 +1618,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2079,7 +2079,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2161,7 +2161,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2443,7 +2443,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2457,7 +2457,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2508,7 +2508,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2522,7 +2522,7 @@ MsgBox(CStr(StatusBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusStripArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusStripArray.xml index 90d6251cca9..71cde668e58 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusStripArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/StatusStripArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -909,7 +909,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1050,7 +1050,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1386,7 +1386,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1488,7 +1488,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1498,7 +1498,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1844,7 +1844,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2303,7 +2303,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2417,7 +2417,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2699,7 +2699,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2713,7 +2713,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2764,7 +2764,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2778,7 +2778,7 @@ MsgBox(CStr(StatusStripArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/Support.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/Support.xml index f2d24765d6f..49919a4bb58 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/Support.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/Support.xml @@ -75,7 +75,7 @@ ## Remarks The Visual Basic 6.0 `Variant` data type is no longer supported in Visual Basic. The `CopyArray` function is used by the upgrade tools to copy an `Array` to or from a `Variant` array. - To copy an array in Visual Basic, use the , or methods of the class. + To copy an array in Visual Basic, use the , or methods of the class. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -118,7 +118,7 @@ ## Remarks In Visual Basic 6.0, the `MouseIcon` property of a form or control could be used to load a custom `MousePointer` (cursor). In some cases, the image for the `MouseIcon` was stored as a `stdOle.IPicture`; this function is used by the upgrade tool to convert a to a `stdOle.IPicture`. - To convert a in Visual Basic, use the method of the class. + To convert a in Visual Basic, use the method of the class. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -598,7 +598,7 @@ is a property of the object. This function is used by the upgrade tools to convert a Visual Basic 6.0 `Font` to a . + In Visual Basic 6.0, the name of a font was specified by the `Font` property; in Visual Basic, is a property of the object. This function is used by the upgrade tools to convert a Visual Basic 6.0 `Font` to a . [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -641,7 +641,7 @@ is a property of the object. This function is used by the upgrade tools to convert a Visual Basic 6.0 `Font` to a . + In Visual Basic 6.0, the size of a font was specified by the `FontSize` property; in Visual Basic, is a property of the object. This function is used by the upgrade tools to convert a Visual Basic 6.0 `Font` to a . [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -1132,7 +1132,7 @@ in Visual Basic. + This function is used by the upgrade tools to replace the Visual Basic 6.0 `Screen.ActiveControl` property. It is the equivalent of calling in Visual Basic. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -1290,7 +1290,7 @@ . + This function is the equivalent of calling . [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -1333,7 +1333,7 @@ methods can be used to emulate the behavior of `ItemData`. + In Visual Basic 6.0, the `ItemData` property for a `ListBox` or `ComboBox` control could be set at design time in the **Properties** window to associate an `Integer` with a `ListBox` or `ComboBox` item. In Visual Basic, the `ItemData` property no longer exists; the `GetItemData` and methods can be used to emulate the behavior of `ItemData`. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -1376,7 +1376,7 @@ or property instead. + This function is used by the upgrade tools to emulate the Visual Basic 6.0 `List` property. In Visual Basic, use the or property instead. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -2421,7 +2421,7 @@ control no longer has `Default` or `Cancel` properties. The object has and properties that provide the same functionality; these properties take the name of a control as an argument. + In Visual Basic 6.0, the Boolean `Default` and `Cancel` properties of a `CommandButton` control determine whether the control responds to the ENTER or ESC keys, respectively. In Visual Basic, the control no longer has `Default` or `Cancel` properties. The object has and properties that provide the same functionality; these properties take the name of a control as an argument. This function is used by the upgrade tools to set the property of a based on the `Cancel` property of an upgraded Visual Basic 6.0 `CommandButton` control. @@ -2466,7 +2466,7 @@ control no longer has `Default` or `Cancel` properties. The object has and properties that provide the same functionality; these properties take the name of a control as an argument. + In Visual Basic 6.0, the Boolean `Default` and `Cancel` properties of a `CommandButton` control determine whether the control responds to the ENTER or ESC keys, respectively. In Visual Basic, the control no longer has `Default` or `Cancel` properties. The object has and properties that provide the same functionality; these properties take the name of a control as an argument. This function is used by the upgrade tools to set the property of a based on the `Default` property of an upgraded Visual Basic 6.0 `CommandButton` control. @@ -2512,7 +2512,7 @@ and `SetItemData` methods can be used to emulate the behavior of `ItemData`. + In Visual Basic 6.0, the `ItemData` property for a `ListBox` or `ComboBox` control could be set at design time in the **Properties** window to associate an `Integer` with a `ListBox` or `ComboBox` item. In Visual Basic, the `ItemData` property no longer exists; the and `SetItemData` methods can be used to emulate the behavior of `ItemData`. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -2556,7 +2556,7 @@ or property instead. + This function is used by the upgrade tools to emulate the Visual Basic 6.0 `List` property. In Visual Basic, use the or property instead. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -2690,7 +2690,7 @@ and methods. This function is used by the upgrade tools to map the Visual Basic 6.0 `Show` method to either the or method. + In Visual Basic 6.0, the `Show` method specified whether a Form would be displayed modally; in Visual Basic it is replaced by the and methods. This function is used by the upgrade tools to map the Visual Basic 6.0 `Show` method to either the or method. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] @@ -3206,7 +3206,7 @@ method, which returns `true` or `false`. + In Visual Basic 6.0, the `ValidateControls` method was used to force the `Validate` event for the control that has focus when a form is closed; if the `Validate` event fails, an error was raised. In Visual Basic, the `ValidateControls` method is replaced by the method, which returns `true` or `false`. This function is used by the upgrade tools to emulate the Visual Basic 6.0 behavior. @@ -3290,7 +3290,7 @@ and methods. This function is used by the upgrade tools to map between the methods. + In Visual Basic 6.0, the `ZOrder` method was used to specify the layering of controls; in Visual Basic .it is replaced by the and methods. This function is used by the upgrade tools to map between the methods. [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/TabControlArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/TabControlArray.xml index 1932d30c87a..afc78903182 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/TabControlArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/TabControlArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -551,7 +551,7 @@ These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . - The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. + The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -597,7 +597,7 @@ These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . - The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. + The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -973,7 +973,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1114,7 +1114,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1354,7 +1354,7 @@ MsgBox(CStr(TabControlArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1389,7 +1389,7 @@ MsgBox(CStr(TabControlArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1399,7 +1399,7 @@ MsgBox(CStr(TabControlArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1745,7 +1745,7 @@ MsgBox(CStr(TabControlArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2171,7 +2171,7 @@ MsgBox(CStr(TabControlArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2288,7 +2288,7 @@ MsgBox(CStr(TabControlArray(1).Text)) These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . - The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. + The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2368,7 +2368,7 @@ MsgBox(CStr(TabControlArray(1).Text)) These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . - The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. + The current tab changes when the user clicks a tab, when you call the or method, or when you change the value of the or property. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2413,7 +2413,7 @@ MsgBox(CStr(TabControlArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2661,7 +2661,7 @@ MsgBox(CStr(TabControlArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2675,7 +2675,7 @@ MsgBox(CStr(TabControlArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2726,7 +2726,7 @@ MsgBox(CStr(TabControlArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2740,7 +2740,7 @@ MsgBox(CStr(TabControlArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/TextBoxArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/TextBoxArray.xml index b77b1267346..474762b7f82 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/TextBoxArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/TextBoxArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1017,7 +1017,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1192,7 +1192,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1432,7 +1432,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1467,7 +1467,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1477,7 +1477,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1857,7 +1857,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2317,7 +2317,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2399,7 +2399,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2715,7 +2715,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2729,7 +2729,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2780,7 +2780,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2794,7 +2794,7 @@ MsgBox(CStr(TextBoxArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/TimerArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/TimerArray.xml index 20c2eb1ad5d..210ac1c50ac 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/TimerArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/TimerArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -195,7 +195,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -267,7 +267,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -392,7 +392,7 @@ MsgBox(CStr(TimerArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolBarArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolBarArray.xml index 3118bd27043..d8ae7c84290 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolBarArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolBarArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -943,7 +943,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1084,7 +1084,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1290,7 +1290,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1325,7 +1325,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1335,7 +1335,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1681,7 +1681,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2107,7 +2107,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2155,7 +2155,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2403,7 +2403,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2417,7 +2417,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2468,7 +2468,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2482,7 +2482,7 @@ MsgBox(CStr(ToolBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripArray.xml index 48b2c387a16..b160acf3214 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -909,7 +909,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1050,7 +1050,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1386,7 +1386,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1488,7 +1488,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1498,7 +1498,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1844,7 +1844,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2338,7 +2338,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2452,7 +2452,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2734,7 +2734,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2748,7 +2748,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2799,7 +2799,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2813,7 +2813,7 @@ MsgBox(CStr(ToolStripArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripMenuItemArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripMenuItemArray.xml index bad2bddf1ec..e065cbf2f5d 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripMenuItemArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ToolStripMenuItemArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -395,7 +395,7 @@ from changes you made in response to the event. + Use the `DropDownClosed` event to restore the state of the from changes you made in response to the event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -595,7 +595,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -667,7 +667,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -866,7 +866,7 @@ MsgBox(CStr(ToolStripMenuItemArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1233,7 +1233,7 @@ MsgBox(CStr(ToolStripMenuItemArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/TreeViewArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/TreeViewArray.xml index d8f4430aca3..644fcf91424 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/TreeViewArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/TreeViewArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1270,7 +1270,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1411,7 +1411,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1683,7 +1683,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1718,7 +1718,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1728,7 +1728,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2074,7 +2074,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -2602,7 +2602,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -2718,7 +2718,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2966,7 +2966,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2980,7 +2980,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -3031,7 +3031,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -3045,7 +3045,7 @@ MsgBox(CStr(TreeViewArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/VScrollBarArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/VScrollBarArray.xml index e0d63a5dae7..9f0a43cfb47 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/VScrollBarArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/VScrollBarArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -705,7 +705,7 @@ or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: `Enter` @@ -715,7 +715,7 @@ - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: `Enter` @@ -759,7 +759,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1112,7 +1112,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) 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 `Layout` event. + The `Layout` 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 by 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 `Layout` event. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1147,7 +1147,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) or method, focus events occur in the following order: + When you change the focus by using the keyboard (TAB, SHIFT+TAB, and so on), or by calling the or method, focus events occur in the following order: @@ -1157,7 +1157,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1348,7 +1348,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) ## Remarks A typical use of `MouseHover` 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 `MouseHover` event is defined and detected in connection with the and properties. + The `MouseHover` event is defined and detected in connection with the and properties. Mouse events occur in the following order: @@ -1686,7 +1686,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -1766,7 +1766,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -2014,7 +2014,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2028,7 +2028,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -2079,7 +2079,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -2093,7 +2093,7 @@ MsgBox(CStr(VScrollBarArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/WebBrowserArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/WebBrowserArray.xml index 1c6ff4d42f3..2167c7ca52f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/WebBrowserArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/WebBrowserArray.xml @@ -77,7 +77,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -115,7 +115,7 @@ , you must also call the method to create the initial element in the array. + When you instantiate a , you must also call the method to create the initial element in the array. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -435,23 +435,23 @@ ## Remarks The control navigates to a new document whenever one of the following properties is set or methods is called: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- - Handle the `DocumentCompleted` event to receive notification when the new document finishes loading. When the `DocumentCompleted` event occurs, the new document is fully loaded, which means you can access its contents through the , , or property. + Handle the `DocumentCompleted` event to receive notification when the new document finishes loading. When the `DocumentCompleted` event occurs, the new document is fully loaded, which means you can access its contents through the , , or property. To receive notification before navigation starts, handle the event. Handling this event lets you cancel navigation if certain conditions have not been met, for example, when the user has not completely filled out a form. Handle the event to receive notification when the control finishes navigation and has begun loading the document at the new location. @@ -521,7 +521,7 @@ method instead. + This method cannot be called from your application's code. Use the method instead. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -593,7 +593,7 @@ method. + This method cannot be called from your application's code. Use `AddHandler` to hook up events for any controls that are added by using the method. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -769,23 +769,23 @@ MsgBox(CStr(WebBrowserArray(1).Text)) ## Remarks The control navigates to a new document whenever one of the following properties is set or methods is called: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- - Handle the `Navigated` event to receive notification when the control has navigated to a new document. When the `Navigated` event occurs, the new document has begun loading, which means you can access the loaded content through the , , and properties. Handle the event to receive notification when the control finishes loading the new document. + Handle the `Navigated` event to receive notification when the control has navigated to a new document. When the `Navigated` event occurs, the new document has begun loading, which means you can access the loaded content through the , , and properties. Handle the event to receive notification when the control finishes loading the new document. You can also receive notification before navigation starts by handling the event. Handling this event lets you cancel navigation if certain conditions have not been met, for example, the user has not filled out a form. @@ -823,21 +823,21 @@ MsgBox(CStr(WebBrowserArray(1).Text)) ## Remarks The control navigates to a new document whenever one of the following properties is set or methods is called: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- You can handle the `Navigating` event to cancel navigation if certain conditions have not been met, for example, when the user has not completely filled out a form. To cancel navigation, set the `Cancel` property of the object passed to the event handler to `true`. You can also use this object to retrieve the URL of the new document through the property. If the new document will be displayed in a Web page frame, you can retrieve the name of the frame through the property. @@ -875,7 +875,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) control opens a separate browser window when the appropriate overload of the method is called or when the user clicks **Open in New Window** on the browser shortcut menu when the mouse pointer hovers over a hyperlink. You can disable the shortcut menu by setting the property to `false`. + The control opens a separate browser window when the appropriate overload of the method is called or when the user clicks **Open in New Window** on the browser shortcut menu when the mouse pointer hovers over a hyperlink. You can disable the shortcut menu by setting the property to `false`. The `NewWindow` event occurs before the new browser window is opened. You can handle this event, for example, to prevent the window from opening when certain conditions have not been met. @@ -1054,7 +1054,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) of the resized control, you can cast the `sender` parameter of the data to a and get its property (or and properties individually). + To determine the of the resized control, you can cast the `sender` parameter of the data 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 `Resize` event, but also in response to other changes that affect the layout of the control. @@ -1102,7 +1102,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) method and specify the `Index`. + The `SetIndex` method should only be called when you are creating the initial element in the control array. To add subsequent elements, call the method and specify the `Index`. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. @@ -1246,7 +1246,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -1260,7 +1260,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: @@ -1311,7 +1311,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) or methods, or by setting the property to the current form, focus events occur in the following order: + 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: @@ -1325,7 +1325,7 @@ MsgBox(CStr(WebBrowserArray(1).Text)) - When you change the focus by using the mouse or by calling the method, focus events occur in the following order: + When you change the focus by using the mouse or by calling the method, focus events occur in the following order: diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/WebClass.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/WebClass.xml index 59ce7d9405a..144687ffa1a 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/WebClass.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/WebClass.xml @@ -23,15 +23,15 @@ Enables upgraded Visual Basic 6.0 projects to run in ASP.NET. - objects for each `WebItem` and `Template` associated with the Visual Basic 6.0 `WebClass` project. Finally, in the `Page_Load` event procedure, you will see a call to the `WebClass` Compatibility runtime: . This enables the runtime to render the specified in the Request URL. This code is the only new code added to your upgraded project and serves only to emulate the underlying behavior of the Visual Basic 6.0 `WebClass` runtime. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + objects for each `WebItem` and `Template` associated with the Visual Basic 6.0 `WebClass` project. Finally, in the `Page_Load` event procedure, you will see a call to the `WebClass` Compatibility runtime: . This enables the runtime to render the specified in the Request URL. This code is the only new code added to your upgraded project and serves only to emulate the underlying behavior of the Visual Basic 6.0 `WebClass` runtime. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -60,13 +60,13 @@ A that contains the property for the Visual Basic 6.0 object. Initializes a new instance of the class. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -97,15 +97,15 @@ Gets the name that is used in code to identify a object. A that contains the name for the object. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -136,15 +136,15 @@ Gets or sets another object in the current object. A object. - to another during a single request. - - The class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + to another during a single request. + + The class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -172,13 +172,13 @@ An object. Renders a in a . - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -213,13 +213,13 @@ Gets or sets a parameter that is appended to the end of any URL that is generated by using the method. A that contains the parameter that will be appended. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -258,13 +258,13 @@ Specifies the URL that the system must have to reference a in the browser. A that contains the URL. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -294,13 +294,13 @@ Specifies the URL that the system must have to reference a in the browser. A that contains the URL. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web-site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/WebItem.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/WebItem.xml index 55f943088d8..55697e37f7f 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/WebItem.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/WebItem.xml @@ -23,15 +23,15 @@ Enables upgraded Visual Basic 6.0 projects to run in ASP.NET. - object and then `WebItem` objects for each of the `WebItems` and `Templates` associated with the Visual Basic 6.0 `WebClass` project. Finally, in the `Page_Load` event procedure, you will see a call to the `WebClass` Compatibility runtime: . This enables the runtime to render the specified in the Request URL. This code is the only new code added to your upgraded project and only serves to emulate the underlying behavior of the Visual Basic 6.0 `WebClass` runtime. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + object and then `WebItem` objects for each of the `WebItems` and `Templates` associated with the Visual Basic 6.0 `WebClass` project. Finally, in the `Page_Load` event procedure, you will see a call to the `WebClass` Compatibility runtime: . This enables the runtime to render the specified in the Request URL. This code is the only new code added to your upgraded project and only serves to emulate the underlying behavior of the Visual Basic 6.0 `WebClass` runtime. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -59,13 +59,13 @@ Optional. The file name of a Visual Basic 6.0 that was associated with the Visual Basic 6.0 . Initializes a new instance of the class. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -96,15 +96,15 @@ Gets the name that is used in code to identify a object. A that contains the name for the object. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -140,13 +140,13 @@ if the text should be rescanned; otherwise . The default is . - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -181,13 +181,13 @@ Gets or sets the string that is used to prefix replacement tag names in an HTML template. A that identifies the sequence used to recognize replacement tags in an HTML template. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> @@ -216,13 +216,13 @@ Optional. The file name of a Visual Basic 6.0 that was associated with the Visual Basic 6.0 . Processes an HTML template attached to a object and returns it to the browser. - class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. - - [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] - + class is used by the upgrade tools to upgrade a Visual Basic 6.0 `WebClass` project to an ASP.NET Web site project. + + [!INCLUDE[Note_compatibility](~/includes/note-compatibility-md.md)] + ]]> diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/ZOrderConstants.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/ZOrderConstants.xml index 09f40344d94..77b91d52162 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/ZOrderConstants.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/ZOrderConstants.xml @@ -25,7 +25,7 @@ and functions. These constants enable code that has been upgraded from Visual Basic 6.0 to continue to run without additional modification. + In Visual Basic, the Visual Basic `ZOrder` method is replaced by the and functions. These constants enable code that has been upgraded from Visual Basic 6.0 to continue to run without additional modification. > [!NOTE] > Functions and objects in the namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation. diff --git a/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml b/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml index 43f9147b7af..0cf848e5295 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml @@ -115,11 +115,11 @@ Executes a late-bound method or function call. This helper method is not meant to be called directly from your code. An instance of the call object. - . - + . + ]]> @@ -680,11 +680,11 @@ Executes a late-bound method or function call. This helper method is not meant to be called directly from your code. An instance of the call object. - . - + . + ]]> @@ -1276,11 +1276,11 @@ An enumeration member of type representing the type of procedure being called. The value of CallType can be , , or . Only is used. Executes a late-bound property set or field write call. This helper method is not meant to be called directly from your code. - . - + . + ]]> @@ -1360,11 +1360,11 @@ A value that specifies when the base reference of the late reference is an . Set to when the base reference of the late reference is an ; this allows you to generate a run-time exception for late assignments to fields of of value types. Otherwise, set to . Executes a late-bound property set or field write call. This helper method is not meant to be called directly from your code. - except that this method is use with complex expressions (for example, expressions in parentheses). - + except that this method is use with complex expressions (for example, expressions in parentheses). + ]]> diff --git a/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml b/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml index e6d5981a118..b38a1d40160 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/Operators.xml @@ -39,11 +39,11 @@ Provides late-bound math operators, such as and , which the Visual Basic compiler uses internally. - @@ -96,11 +96,11 @@ Represents the Visual Basic addition (+) operator. The sum of and . - @@ -153,11 +153,11 @@ Represents the Visual Basic operator. For operations, if both and evaluate to ; otherwise, . For bitwise operations, 1 if both and evaluate to 1; otherwise, 0. - @@ -196,48 +196,48 @@ - Value - + Value + - Condition - + Condition + - -1 - + -1 + - is less than . - + is less than . + - 0 - + 0 + - and are equal. - + and are equal. + - 1 - + 1 + - is greater than . - + is greater than . + - @@ -293,11 +293,11 @@ if and are equal; otherwise, . - @@ -353,11 +353,11 @@ if is greater than ; otherwise, . - @@ -413,11 +413,11 @@ if is greater than or equal to ; otherwise, . - @@ -473,11 +473,11 @@ if is less than ; otherwise, . - @@ -533,11 +533,11 @@ if is less than or equal to ; otherwise, . - @@ -593,11 +593,11 @@ if is not equal to ; otherwise, . - @@ -647,50 +647,50 @@ - Value - + Value + - Condition - + Condition + - -1 - + -1 + - is less than . - + is less than . + - 0 - + 0 + - is equal to . - + is equal to . + - 1 - + 1 + - is greater than . - + is greater than . + - method along with a value of `False` for the `TextCompare` argument. This performs a case-sensitive comparison that is either ordinal or based on the current culture, depending on the value of the [Option Compare](/dotnet/visual-basic/language-reference/statements/option-compare-statement) statement. - + method along with a value of `False` for the `TextCompare` argument. This performs a case-sensitive comparison that is either ordinal or based on the current culture, depending on the value of the [Option Compare](/dotnet/visual-basic/language-reference/statements/option-compare-statement) statement. + ]]> @@ -743,11 +743,11 @@ Represents the Visual Basic concatenation (&) operator. A string representing the concatenation of and . - @@ -802,11 +802,11 @@ Represents the overloaded Visual Basic equals (=) operator. The result of the overloaded equals operator. if operator overloading is not supported. - @@ -861,11 +861,11 @@ Represents the overloaded Visual Basic greater-than (>) operator. The result of the overloaded greater-than operator. if operator overloading is not supported. - @@ -920,11 +920,11 @@ Represents the overloaded Visual Basic greater-than or equal-to (>=) operator. The result of the overloaded greater-than or equal-to operator. if operator overloading is not supported. - @@ -979,11 +979,11 @@ Represents the overloaded Visual Basic less-than (<) operator. The result of the overloaded less-than operator. if operator overloading is not supported. - @@ -1038,11 +1038,11 @@ Represents the overloaded Visual Basic less-than or equal-to (<=) operator. The result of the overloaded less-than or equal-to operator. if operator overloading is not supported. - @@ -1097,11 +1097,11 @@ Represents the overloaded Visual Basic not-equal (<>) operator. The result of the overloaded not-equal operator. if operator overloading is not supported. - @@ -1154,11 +1154,11 @@ Represents the Visual Basic division (/) operator. The full quotient of divided by , including any remainder. - @@ -1211,11 +1211,11 @@ Represents the Visual Basic exponent (^) operator. The result of raised to the power of . - @@ -1334,11 +1334,11 @@ Represents the Visual Basic integer division (\\) operator. The integer quotient of divided by , which discards any remainder and retains only the integer portion. - @@ -1391,11 +1391,11 @@ Represents the Visual Basic arithmetic left shift (<<) operator. An integral numeric value. The result of shifting the bit pattern. The data type is the same as that of . - @@ -1434,11 +1434,11 @@ if the string representation of the value in satisfies the pattern that is contained in ; otherwise, . if both and are . - @@ -1477,11 +1477,11 @@ if the value in satisfies the pattern that is contained in ; otherwise, . if both and are empty. - @@ -1534,11 +1534,11 @@ Represents the Visual Basic operator. The remainder after is divided by . - @@ -1591,11 +1591,11 @@ Represents the Visual Basic multiply (*) operator. The product of and . - @@ -1646,11 +1646,11 @@ Represents the Visual Basic unary minus (-) operator. The negative value of . - @@ -1701,11 +1701,11 @@ Represents the Visual Basic operator. For operations, if is ; otherwise, . For bitwise operations, 1 if is 0; otherwise, 0. - @@ -1758,11 +1758,11 @@ Represents the Visual Basic operator. For operations, if both and evaluate to ; otherwise, . For bitwise operations, 0 if both and evaluate to 0; otherwise, 1. - @@ -1813,11 +1813,11 @@ Represents the Visual Basic unary plus (+) operator. The value of . (The sign of the is unchanged.) - @@ -1870,11 +1870,11 @@ Represents the Visual Basic arithmetic right shift (>>) operator. An integral numeric value. The result of shifting the bit pattern. The data type is the same as that of . - @@ -1927,11 +1927,11 @@ Represents the Visual Basic subtraction (-) operator. The difference between and . - @@ -1984,11 +1984,11 @@ Represents the Visual Basic operator. A or numeric value. For a comparison, the return value is the logical exclusion (exclusive logical disjunction) of two values. For bitwise (numeric) operations, the return value is a numeric value that represents the bitwise exclusion (exclusive bitwise disjunction) of two numeric bit patterns. For more information, see Xor Operator. - diff --git a/xml/Microsoft.VisualBasic.CompilerServices/ProjectData.xml b/xml/Microsoft.VisualBasic.CompilerServices/ProjectData.xml index aef727c0220..addc9873fc0 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/ProjectData.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/ProjectData.xml @@ -41,11 +41,11 @@ Provides helpers for the Visual Basic object. - . - + . + ]]> @@ -95,11 +95,11 @@ Performs the work for the method of the object. A helper method. - . - + . + ]]> @@ -143,11 +143,11 @@ Performs the work for the method of the object. A helper method. An object. - . - + . + ]]> @@ -193,11 +193,11 @@ Closes all files for the calling assembly and stops the process. - @@ -235,11 +235,11 @@ The Visual Basic compiler uses this helper method to capture exceptions in the object. - . - + . + ]]> @@ -291,11 +291,11 @@ The object to be caught. The Visual Basic compiler uses this helper method to capture exceptions in the object. - . - + . + ]]> @@ -350,11 +350,11 @@ The line number of the exception. The Visual Basic compiler uses this helper method to capture exceptions in the object. - . - + . + ]]> diff --git a/xml/Microsoft.VisualBasic.CompilerServices/StringType.xml b/xml/Microsoft.VisualBasic.CompilerServices/StringType.xml index 0d56bc0001d..41a325391c3 100644 --- a/xml/Microsoft.VisualBasic.CompilerServices/StringType.xml +++ b/xml/Microsoft.VisualBasic.CompilerServices/StringType.xml @@ -46,11 +46,11 @@ This class has been deprecated as of Visual Basic 2005. - @@ -95,11 +95,11 @@ Returns a value that corresponds to the specified . The value corresponding to . - @@ -144,11 +144,11 @@ Returns a value that corresponds to the specified . The value corresponding to . - @@ -193,11 +193,11 @@ Returns a value that corresponds to the specified . The value corresponding to . - @@ -242,11 +242,11 @@ Returns a value that corresponds to the specified date. The value corresponding to . - @@ -260,11 +260,11 @@ Returns a value that corresponds to a specified and optional number format information. - @@ -314,11 +314,11 @@ Returns a value that corresponds to the specified . The value corresponding to . - @@ -373,11 +373,11 @@ Returns a value that corresponds to a specified and number format information. The value corresponding to . - @@ -391,11 +391,11 @@ Returns a string that corresponds to a specified and optional number format information. - @@ -445,11 +445,11 @@ Returns a string value that corresponds to a specified . The value corresponding to . - @@ -504,11 +504,11 @@ Returns a string that corresponds to a specified and number format information. The string representation of . - @@ -553,11 +553,11 @@ Returns a value that corresponds to a specified . The value corresponding to . - @@ -602,11 +602,11 @@ Returns a value that corresponds to a specified (64-bit integer). The value corresponding to . - @@ -658,11 +658,11 @@ Returns a value that corresponds to the specified object. The value corresponding to . - @@ -707,11 +707,11 @@ Returns a value that corresponds to a specified (16-bit integer). The value corresponding to . - @@ -725,11 +725,11 @@ Returns a string value that corresponds to a specified and optional number format information. - @@ -779,11 +779,11 @@ Returns a string value that corresponds to a specified . The string value corresponding to . - @@ -838,11 +838,11 @@ Returns a string value that corresponds to a specified and number format information. The string value corresponding to . - @@ -900,11 +900,11 @@ Required. String value to overwrite the parameter with. Overwrites the parameter with the contents of the parameter. - @@ -955,47 +955,47 @@ - Value - + Value + - Condition - + Condition + - zero - + zero + - The two strings are equal. - + The two strings are equal. + - less than zero - + less than zero + - is less than . - + is less than . + - greater than zero - + greater than zero + - is greater than . - + is greater than . + - @@ -1045,11 +1045,11 @@ Compares the parameters and and returns the same results as the operator. A value indicating whether or not the string satisfies the pattern. If the value in string satisfies the pattern contained in pattern, result is . If the string does not satisfy the pattern, result is . If both string and pattern are empty strings, the result is . - @@ -1097,13 +1097,13 @@ Compares the parameters and and returns the same results as the operator, using binary comparison. A value indicating whether or not the string satisfies the pattern. If the value in string satisfies the pattern contained in pattern, result is . If the string does not satisfy the pattern, result is . If both string and pattern are empty strings, the result is . - except that it always performs a case-sensitive binary comparison. - + except that it always performs a case-sensitive binary comparison. + ]]> @@ -1151,13 +1151,13 @@ Compares the parameters and and returns the same results as the operator, using text comparison. A value indicating whether or not the string satisfies the pattern. If the value in string satisfies the pattern contained in pattern, result is . If the string does not satisfy the pattern, result is . If both string and pattern are empty strings, the result is . - except that it always performs a comparison based on a case-insensitive text sort order determined by your system's `LocaleID` value. - + except that it always performs a comparison based on a case-insensitive text sort order determined by your system's `LocaleID` value. + ]]> diff --git a/xml/Microsoft.VisualBasic.Devices/Audio.xml b/xml/Microsoft.VisualBasic.Devices/Audio.xml index d009b8307e0..6210730eb32 100644 --- a/xml/Microsoft.VisualBasic.Devices/Audio.xml +++ b/xml/Microsoft.VisualBasic.Devices/Audio.xml @@ -31,38 +31,38 @@ Provides methods for playing sounds. - @@ -105,11 +105,11 @@ Initializes a new instance of the class. - @@ -162,48 +162,48 @@ A containing the name of the sound file. Plays a .wav sound file. - method is called. The calling code continues to execute.| -|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| - - Background playing lets the application execute other code while the sound plays. - - For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Application|**Yes**| -|Class Library|**Yes**| -|Console Application|**Yes**| -|Windows Control Library|**Yes**| -|Web Control Library|No| -|Windows Service|**Yes**| -|Web Site|No| - - - -## Examples - The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. - - :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: - - This code example can only run within a Windows Forms application. - - The file name should reference a .wav sound file on your system. - - To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. - + method is called. The calling code continues to execute.| +|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| + + Background playing lets the application execute other code while the sound plays. + + For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Application|**Yes**| +|Class Library|**Yes**| +|Console Application|**Yes**| +|Windows Control Library|**Yes**| +|Web Control Library|No| +|Windows Service|**Yes**| +|Web Site|No| + + + +## Examples + The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. + + :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: + + This code example can only run within a Windows Forms application. + + The file name should reference a .wav sound file on your system. + + To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. + ]]> @@ -255,48 +255,48 @@ mode for playing the sound. By default, . Plays a .wav sound file. - method is called. The calling code continues to execute.| -|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| - - Background playing lets the application execute other code while the sound plays. - - For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Application|**Yes**| -|Class Library|**Yes**| -|Console Application|**Yes**| -|Windows Control Library|**Yes**| -|Web Control Library|No| -|Windows Service|**Yes**| -|Web Site|No| - - - -## Examples - The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. - - :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: - - This code example can only run within a Windows Forms application. - - The file name should reference a .wav sound file on your system. - - To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. - + method is called. The calling code continues to execute.| +|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| + + Background playing lets the application execute other code while the sound plays. + + For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Application|**Yes**| +|Class Library|**Yes**| +|Console Application|**Yes**| +|Windows Control Library|**Yes**| +|Web Control Library|No| +|Windows Service|**Yes**| +|Web Site|No| + + + +## Examples + The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. + + :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: + + This code example can only run within a Windows Forms application. + + The file name should reference a .wav sound file on your system. + + To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. + ]]> @@ -347,48 +347,48 @@ mode for playing the sound. By default, . Plays a .wav sound file. - method is called. The calling code continues to execute.| -|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| - - Background playing lets the application execute other code while the sound plays. - - For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Application|**Yes**| -|Class Library|**Yes**| -|Console Application|**Yes**| -|Windows Control Library|**Yes**| -|Web Control Library|No| -|Windows Service|**Yes**| -|Web Site|No| - - - -## Examples - The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. - - :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: - - This code example can only run within a Windows Forms application. - - The file name should reference a .wav sound file on your system. - - To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. - + method is called. The calling code continues to execute.| +|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| + + Background playing lets the application execute other code while the sound plays. + + For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Application|**Yes**| +|Class Library|**Yes**| +|Console Application|**Yes**| +|Windows Control Library|**Yes**| +|Web Control Library|No| +|Windows Service|**Yes**| +|Web Site|No| + + + +## Examples + The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. + + :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: + + This code example can only run within a Windows Forms application. + + The file name should reference a .wav sound file on your system. + + To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. + ]]> @@ -439,48 +439,48 @@ mode for playing the sound. By default, . Plays a .wav sound file. - method is called. The calling code continues to execute.| -|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| - - Background playing lets the application execute other code while the sound plays. - - For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Application|**Yes**| -|Class Library|**Yes**| -|Console Application|**Yes**| -|Windows Control Library|**Yes**| -|Web Control Library|No| -|Windows Service|**Yes**| -|Web Site|No| - - - -## Examples - The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. - - :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: - - This code example can only run within a Windows Forms application. - - The file name should reference a .wav sound file on your system. - - To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. - + method is called. The calling code continues to execute.| +|`AudioPlayMode.WaitToComplete`|Plays the sound and waits until it completes before the calling code continues.| + + Background playing lets the application execute other code while the sound plays. + + For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Application|**Yes**| +|Class Library|**Yes**| +|Console Application|**Yes**| +|Windows Control Library|**Yes**| +|Web Control Library|No| +|Windows Service|**Yes**| +|Web Site|No| + + + +## Examples + The `My.Computer.Audio.Play` method plays the specified sound in the background when `PlayMode.Background` is specified. + + :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet15"::: + + This code example can only run within a Windows Forms application. + + The file name should reference a .wav sound file on your system. + + To simplify the management of your sound files, consider storing the files as application resources. They can then be accessed through the `My.Resources` object. + ]]> @@ -531,46 +531,46 @@ object representing the system sound to play. Plays a system sound. - class: - -- - -- - -- - -- - -- - - For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Application|**Yes**| -|Class Library|**Yes**| -|Console Application|**Yes**| -|Windows Control Library|**Yes**| -|Web Control Library|No| -|Windows Service|**Yes**| -|Web Site|No| - - - -## Examples - This example uses the `My.Computer.Audio.PlaySystemSound` method to play a system sound. - - :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet17"::: - - This code example can run only within a Windows Forms application. - + class: + +- + +- + +- + +- + +- + + For more information, see [Playing Sounds](/dotnet/visual-basic/developing-apps/programming/computer-resources/playing-sounds). + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Application|**Yes**| +|Class Library|**Yes**| +|Console Application|**Yes**| +|Windows Control Library|**Yes**| +|Web Control Library|No| +|Windows Service|**Yes**| +|Web Site|No| + + + +## Examples + This example uses the `My.Computer.Audio.PlaySystemSound` method to play a system sound. + + :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class1.vb" id="Snippet17"::: + + This code example can run only within a Windows Forms application. + ]]> @@ -611,40 +611,40 @@ Stops a sound playing in the background. - Objects (Visual Basic) diff --git a/xml/Microsoft.VisualBasic.Devices/Computer.xml b/xml/Microsoft.VisualBasic.Devices/Computer.xml index 893351cbca3..d22d8f85300 100644 --- a/xml/Microsoft.VisualBasic.Devices/Computer.xml +++ b/xml/Microsoft.VisualBasic.Devices/Computer.xml @@ -431,9 +431,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: diff --git a/xml/Microsoft.VisualBasic.Devices/Keyboard.xml b/xml/Microsoft.VisualBasic.Devices/Keyboard.xml index c950750109e..d60abd197b6 100644 --- a/xml/Microsoft.VisualBasic.Devices/Keyboard.xml +++ b/xml/Microsoft.VisualBasic.Devices/Keyboard.xml @@ -490,7 +490,7 @@ and methods. + The `My.Computer.Keyboard.SendKeys` method provides functionality similar to the and methods. The `wait` argument is useful if the other application must finish before your application can continue. @@ -543,13 +543,13 @@ ## Examples -This example uses the `My.Computer.Keyboard.SendKeys` method to send keystrokes to an external application, the Notepad application, started by the method. +This example uses the `My.Computer.Keyboard.SendKeys` method to send keystrokes to an external application, the Notepad application, started by the method. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet25"::: An exception is raised if an application with the requested process identifier cannot be found. -The call to the method requires full trust ( class). +The call to the method requires full trust ( class). ]]> @@ -600,7 +600,7 @@ The call to the method require and methods. + The `My.Computer.Keyboard.SendKeys` method provides functionality similar to the and methods. The `wait` argument is useful if the other application must finish before your application can continue. @@ -653,13 +653,13 @@ The call to the method require ## Examples -This example uses the `My.Computer.Keyboard.SendKeys` method to send keystrokes to an external application, the Notepad application, started by the method. +This example uses the `My.Computer.Keyboard.SendKeys` method to send keystrokes to an external application, the Notepad application, started by the method. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet25"::: An exception is raised if an application with the requested process identifier cannot be found. -The call to the method requires full trust ( class). +The call to the method requires full trust ( class). ]]> diff --git a/xml/Microsoft.VisualBasic.Devices/Network.xml b/xml/Microsoft.VisualBasic.Devices/Network.xml index d40fafc65e5..f8598b0540f 100644 --- a/xml/Microsoft.VisualBasic.Devices/Network.xml +++ b/xml/Microsoft.VisualBasic.Devices/Network.xml @@ -141,7 +141,7 @@ method to instruct it to overwrite existing files, provide user credentials, or specify a specific timeout value. + If the destination file already exists, the `DownloadFile` method will not overwrite the existing file. You can use one of the other overloads of the method to instruct it to overwrite existing files, provide user credentials, or specify a specific timeout value. `DownloadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). @@ -223,7 +223,7 @@ method to instruct it to overwrite existing files, provide user credentials, or specify a specific timeout value. `DownloadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). + If the destination file already exists, the `DownloadFile` method will not overwrite the existing file. You can use one of the other overloads of the method to instruct it to overwrite existing files, provide user credentials, or specify a specific timeout value. `DownloadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). > [!NOTE] > The `DownloadFile` method does not send optional HTTP headers. Some servers may return 500 (Internal Server Error) if the optional user agent header is missing. To send optional headers, you must construct a request using the class. @@ -307,7 +307,7 @@ method to instruct it to overwrite existing files or specify a specific timeout value. + If the destination file already exists, the `DownloadFile` method will not overwrite the existing file. You can use one of the other overloads of the method to instruct it to overwrite existing files or specify a specific timeout value. `DownloadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). @@ -396,7 +396,7 @@ method to instruct it to overwrite existing files or specify a specific timeout value. + If the destination file already exists, the `DownloadFile` method will not overwrite the existing file. You can use one of the other overloads of the method to instruct it to overwrite existing files or specify a specific timeout value. `DownloadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). @@ -1125,7 +1125,7 @@ ## Remarks An application raises the `NetworkAvailabilityChanged` event every time the availability of the network changes. You can use the property of the `e` parameter to get the new state of the network connection. To get the current state of the network connection, use the property. - In a Windows Forms application, this event is raised on the application's main thread with the other user-interface events. This allows the event handler to access directly the application's user interface. However, if the application is busy handling another user-interface event when this event is raised, this event cannot be processed until the other event handler finishes or calls the method. + In a Windows Forms application, this event is raised on the application's main thread with the other user-interface events. This allows the event handler to access directly the application's user interface. However, if the application is busy handling another user-interface event when this event is raised, this event cannot be processed until the other event handler finishes or calls the method. You cannot use the `Handles` statement to handle the `NetworkAvailabilityChanged` event; you must use the `AddHandler` statement. @@ -1482,7 +1482,7 @@ method to provide user credentials or specify a specific timeout value. + You can use one of the other overloads of the method to provide user credentials or specify a specific timeout value. `My.Computer.Network.UploadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). @@ -1563,7 +1563,7 @@ method to provide user credentials or specify a specific timeout value. + You can use one of the other overloads of the method to provide user credentials or specify a specific timeout value. `My.Computer.Network.UploadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). @@ -1648,7 +1648,7 @@ method to specify a specific timeout value. + You can use one of the other overloads of the method to specify a specific timeout value. `My.Computer.Network.UploadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). @@ -1737,7 +1737,7 @@ method to specify a specific timeout value. + You can use one of the other overloads of the method to specify a specific timeout value. `My.Computer.Network.UploadFile` outputs trace information when you enable network tracing in your application. For more information, see [Enabling Network Tracing](/dotnet/framework/network-programming/enabling-network-tracing). diff --git a/xml/Microsoft.VisualBasic.Devices/Ports.xml b/xml/Microsoft.VisualBasic.Devices/Ports.xml index ac6947784f7..9c079450ba6 100644 --- a/xml/Microsoft.VisualBasic.Devices/Ports.xml +++ b/xml/Microsoft.VisualBasic.Devices/Ports.xml @@ -52,9 +52,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: @@ -137,7 +137,7 @@ ## Remarks The `My.Computer.Ports.OpenSerialPort` method creates and opens a object. The arguments to the `OpenSerialPort` method determine the settings of the object. - Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. + Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. The following table lists examples of tasks involving the `My.Computer.Ports.OpenSerialPort` method. @@ -164,9 +164,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: @@ -220,7 +220,7 @@ ## Remarks The `My.Computer.Ports.OpenSerialPort` method creates and opens a object. The arguments to the `OpenSerialPort` method determine the settings of the object. - Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. + Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. The following table lists examples of tasks involving the `My.Computer.Ports.OpenSerialPort` method. @@ -247,9 +247,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: @@ -308,7 +308,7 @@ ## Remarks The `My.Computer.Ports.OpenSerialPort` method creates and opens a object. The arguments to the `OpenSerialPort` method determine the settings of the object. - Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. + Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. The following table lists examples of tasks involving the `My.Computer.Ports.OpenSerialPort` method. @@ -335,9 +335,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: @@ -401,7 +401,7 @@ ## Remarks The `My.Computer.Ports.OpenSerialPort` method creates and opens a object. The arguments to the `OpenSerialPort` method determine the settings of the object. - Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. + Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. The following table lists examples of tasks involving the `My.Computer.Ports.OpenSerialPort` method. @@ -428,9 +428,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: @@ -497,7 +497,7 @@ ## Remarks The `My.Computer.Ports.OpenSerialPort` method creates and opens a object. The arguments to the `OpenSerialPort` method determine the settings of the object. - Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. + Your code should close the object when it is finished using the object. You can use the method to close the object explicitly or the `Using` statement to close it implicitly. See the example in this topic for more information. The following table lists examples of tasks involving the `My.Computer.Ports.OpenSerialPort` method. @@ -524,9 +524,9 @@ ## Examples This example describes how to send strings to the computer's `COM1` serial port. - The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. + The `Using` block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a `Try...Catch...Finally` block with a call to use the method. - The method sends the data to the serial port. + The method sends the data to the serial port. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic.Devices/Audio/Overview/Class2.vb" id="Snippet33"::: diff --git a/xml/Microsoft.VisualBasic.FileIO/DeleteDirectoryOption.xml b/xml/Microsoft.VisualBasic.FileIO/DeleteDirectoryOption.xml index bd3d102c876..0ab12163798 100644 --- a/xml/Microsoft.VisualBasic.FileIO/DeleteDirectoryOption.xml +++ b/xml/Microsoft.VisualBasic.FileIO/DeleteDirectoryOption.xml @@ -28,11 +28,11 @@ Specifies what should be done when a directory that is to be deleted contains files or directories. - method. - + method. + ]]> diff --git a/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml b/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml index a17e46903aa..a49d08612d6 100644 --- a/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml +++ b/xml/Microsoft.VisualBasic.FileIO/FileSystem.xml @@ -3659,9 +3659,9 @@ The `OpenTextFileWriter` method opens and initializes a stream for a file and then returns the object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. > [!NOTE] -> You must call the method on the object to make sure that all data is correctly written to the underlying stream. +> You must call the method on the object to make sure that all data is correctly written to the underlying stream. - If you are writing only a few strings to a file, it might be simpler to use the method. + If you are writing only a few strings to a file, it might be simpler to use the method. The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. @@ -3734,9 +3734,9 @@ The `OpenTextFileWriter` method opens and initializes a stream for a file and then returns the object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. > [!NOTE] -> You must call the method on the object to make sure that all data is correctly written to the underlying stream. +> You must call the method on the object to make sure that all data is correctly written to the underlying stream. - If you are writing only a few strings to a file, it might be simpler to use the method. + If you are writing only a few strings to a file, it might be simpler to use the method. The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. @@ -3883,7 +3883,7 @@ ## Remarks The `ReadAllText` method of the `My.Computer.FileSystem` object allows you to read from a text file. The contents of the file are returned as a string. - The file encoding can be specified if the contents of the file are in an encoding such as ASCII or UTF-8. If you are reading from a file with extended characters, you need to specify the file encoding using another overload of the method. + The file encoding can be specified if the contents of the file are in an encoding such as ASCII or UTF-8. If you are reading from a file with extended characters, you need to specify the file encoding using another overload of the method. Do not make decisions about the contents of the file based on the name of the file. For example, the file Form1.vb may not be a Visual Basic source file. Verify all inputs before using the data in your application. @@ -4111,7 +4111,7 @@ method to move and rename the file. + This method cannot be used to move a file; use the method to move and rename the file. The following table lists an example of a task involving the `My.Computer.FileSystem.RenameFile` method. @@ -4274,14 +4274,14 @@ method. + The UTF-8 encoding is used to write to the file. To specify a different encoding, use a different overload of the method. If the specified file does not exist, it is created. If the specified encoding does not match the existing encoding of the file, the specified coding is ignored. > [!NOTE] -> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. +> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. @@ -4367,7 +4367,7 @@ If the specified encoding does not match the existing encoding of the file, the specified coding is ignored. > [!NOTE] -> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. +> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. diff --git a/xml/Microsoft.VisualBasic.FileIO/MalformedLineException.xml b/xml/Microsoft.VisualBasic.FileIO/MalformedLineException.xml index 50236333c00..14b5fab3de7 100644 --- a/xml/Microsoft.VisualBasic.FileIO/MalformedLineException.xml +++ b/xml/Microsoft.VisualBasic.FileIO/MalformedLineException.xml @@ -45,7 +45,7 @@ ## Remarks Check to ensure that the `TextFieldType` and `Delimiter` parameters are defined properly. - If the method cannot parse a row using the specified format, the exception is thrown. The exception contains the line number of the malformed line. + If the method cannot parse a row using the specified format, the exception is thrown. The exception contains the line number of the malformed line. ]]> @@ -100,14 +100,14 @@ method cannot parse a row using the specified format. + The exception indicates that the method cannot parse a row using the specified format. The following table shows the initial property values for an instance of . |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic).| -||The localized error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The localized error message string.| ]]> @@ -163,8 +163,8 @@ |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic)| -||The `message` string.| +||A null reference (`Nothing` in Visual Basic)| +||The `message` string.| ]]> @@ -281,8 +281,8 @@ |Property|Value| |-|-| -||The `innerException` reference.| -||The `message` string.| +||The `innerException` reference.| +||The `message` string.| ]]> @@ -339,8 +339,8 @@ |Property|Value| |-|-| -||A null reference (`Nothing` in Visual Basic)| -||The `message` string.| +||A null reference (`Nothing` in Visual Basic)| +||The `message` string.| ]]> @@ -401,8 +401,8 @@ |Property|Value| |-|-| -||The `innerException` reference.| -||The `message` string.| +||The `innerException` reference.| +||The `message` string.| ]]> @@ -522,7 +522,7 @@ method cannot parse a row using the specified format, the exception is thrown. The exception contains the line number of the malformed line. + If the method cannot parse a row using the specified format, the exception is thrown. The exception contains the line number of the malformed line. ]]> @@ -566,13 +566,13 @@ returns a representation of the current exception that is intended to be understood by humans. Where the exception contains culture-sensitive data, the string representation returned by is required to take into account the current system culture. Although there are no exact requirements for the format of the returned string, it should attempt to reflect the value of the object as perceived by the user. + returns a representation of the current exception that is intended to be understood by humans. Where the exception contains culture-sensitive data, the string representation returned by is required to take into account the current system culture. Although there are no exact requirements for the format of the returned string, it should attempt to reflect the value of the object as perceived by the user. - The default implementation of obtains the name of the class that threw the current exception, the message, the result of calling on the inner exception, the result of calling , and the line number of the malformed line If any of these members is a null reference (`Nothing` in Visual Basic), its value is not included in the returned string. + The default implementation of obtains the name of the class that threw the current exception, the message, the result of calling on the inner exception, the result of calling , and the line number of the malformed line If any of these members is a null reference (`Nothing` in Visual Basic), its value is not included in the returned string. If there is no error message or if it is an empty string (""), then no error message is returned. The name of the inner exception and the stack trace are returned only if they are not a null reference (`Nothing` in Visual Basic). - This method overrides . + This method overrides . ]]> diff --git a/xml/Microsoft.VisualBasic.FileIO/RecycleOption.xml b/xml/Microsoft.VisualBasic.FileIO/RecycleOption.xml index 0d1e50d9449..5bb2c8f74cd 100644 --- a/xml/Microsoft.VisualBasic.FileIO/RecycleOption.xml +++ b/xml/Microsoft.VisualBasic.FileIO/RecycleOption.xml @@ -28,15 +28,15 @@ Specifies whether a file should be deleted permanently or placed in the **Recycle Bin**. - and methods. - - To protect users against accidental deletion of important files, the **Recycle Bin** collects deleted files and provides a method for restoring those files. You must explicitly delete the files from the **Recycle Bin** to make the deletion permanent. Until the files are deleted from the **Recycle Bin**, the disk space occupied by those files is unavailable for other uses. - - Sometimes it is beneficial to bypass the **Recycle Bin**, especially if you are deleting a large number of files (or a smaller number of very large files) that you are sure are no longer needed, and you want to reclaim the disk space. - + and methods. + + To protect users against accidental deletion of important files, the **Recycle Bin** collects deleted files and provides a method for restoring those files. You must explicitly delete the files from the **Recycle Bin** to make the deletion permanent. Until the files are deleted from the **Recycle Bin**, the disk space occupied by those files is unavailable for other uses. + + Sometimes it is beneficial to bypass the **Recycle Bin**, especially if you are deleting a large number of files (or a smaller number of very large files) that you are sure are no longer needed, and you want to reclaim the disk space. + ]]> diff --git a/xml/Microsoft.VisualBasic.FileIO/SearchOption.xml b/xml/Microsoft.VisualBasic.FileIO/SearchOption.xml index 4221c8a61a0..0873508f7ed 100644 --- a/xml/Microsoft.VisualBasic.FileIO/SearchOption.xml +++ b/xml/Microsoft.VisualBasic.FileIO/SearchOption.xml @@ -28,11 +28,11 @@ Specifies whether to search all or only top-level directories. - , , and methods. - + , , and methods. + ]]> diff --git a/xml/Microsoft.VisualBasic.FileIO/TextFieldParser.xml b/xml/Microsoft.VisualBasic.FileIO/TextFieldParser.xml index 9d41cf0ea3a..36317c2b7f6 100644 --- a/xml/Microsoft.VisualBasic.FileIO/TextFieldParser.xml +++ b/xml/Microsoft.VisualBasic.FileIO/TextFieldParser.xml @@ -713,7 +713,7 @@ ## Remarks This property is meaningful only if the property is set to `FieldType.Delimited`. - Defining the delimiters for a text file can also be accomplished with the method. + Defining the delimiters for a text file can also be accomplished with the method. The following table lists an example of a task involving the `Delimiters` property. @@ -1070,7 +1070,7 @@ ## Remarks This property is meaningful only if the property is set to `FieldType.FixedWidth`. If the last entry in the array is less than or equal to zero, the field is assumed to be of variable width. - The method can also be used to set field widths. + The method can also be used to set field widths. The following table lists examples of tasks involving the `FieldWidths` property. @@ -1751,7 +1751,7 @@ ## Remarks -This member is an explicit interface member implementation. It can be used only when the `TextFieldParser` instance is cast to an interface. The recommended alternative is to call the method. +This member is an explicit interface member implementation. It can be used only when the `TextFieldParser` instance is cast to an interface. The recommended alternative is to call the method. ]]> diff --git a/xml/Microsoft.VisualBasic.FileIO/UIOption.xml b/xml/Microsoft.VisualBasic.FileIO/UIOption.xml index 52ede661be7..bfe49b3cba8 100644 --- a/xml/Microsoft.VisualBasic.FileIO/UIOption.xml +++ b/xml/Microsoft.VisualBasic.FileIO/UIOption.xml @@ -28,11 +28,11 @@ Specifies which dialog boxes to show when copying, deleting, or moving files or directories. - , , , , , and methods. - + , , , , , and methods. + ]]> diff --git a/xml/Microsoft.VisualBasic.Logging/AspLog.xml b/xml/Microsoft.VisualBasic.Logging/AspLog.xml index 30be6f4b0fe..489b1ca308b 100644 --- a/xml/Microsoft.VisualBasic.Logging/AspLog.xml +++ b/xml/Microsoft.VisualBasic.Logging/AspLog.xml @@ -160,9 +160,9 @@ , sets its name to `FileLog`, and configures it to log messages with severity level and greater. The new object is then added to the collection. + This method creates a new , sets its name to `FileLog`, and configures it to log messages with severity level and greater. The new object is then added to the collection. - The calls the method if the property has not been configured. The trace source can be configured in the application's configuration file. + The calls the method if the property has not been configured. The trace source can be configured in the application's configuration file. ]]> diff --git a/xml/Microsoft.VisualBasic.Logging/FileLogTraceListener.xml b/xml/Microsoft.VisualBasic.Logging/FileLogTraceListener.xml index 32b8747c900..6f858d671d8 100644 --- a/xml/Microsoft.VisualBasic.Logging/FileLogTraceListener.xml +++ b/xml/Microsoft.VisualBasic.Logging/FileLogTraceListener.xml @@ -39,7 +39,7 @@ The class provides automated maintenance capabilities to archive log files as needed, on a daily or per-application basis. This automatic archival functionality helps reduce the maintenance responsibilities of developers and administrators. -An instance of can be added to the or collections to redirect output from logging to a text file. Instances of this class can also be added to `My.Application.Log` or `My.Log` (for Web applications) in Visual Basic applications. For more information, see [Walkthrough: Changing Where My.Application.Log Writes Information](/dotnet/visual-basic/developing-apps/programming/log-info/walkthrough-changing-where-my-application-log-writes-information). +An instance of can be added to the or collections to redirect output from logging to a text file. Instances of this class can also be added to `My.Application.Log` or `My.Log` (for Web applications) in Visual Basic applications. For more information, see [Walkthrough: Changing Where My.Application.Log Writes Information](/dotnet/visual-basic/developing-apps/programming/log-info/walkthrough-changing-where-my-application-log-writes-information). The main features of this class are: @@ -48,7 +48,7 @@ The main features of this class are: The explicit form of the file name is `baseName`[-`dateStamp`][-`version`].log, where: - The `baseName` part is the fundamental log name, specified by the property. - - The `dateStamp` part has the format "YYYY-MM-DD", and it is shown when is or . + - The `dateStamp` part has the format "YYYY-MM-DD", and it is shown when is or . - If more than one log file is needed with the same `baseName` and `dateStamp`, the `version` part, a positive `Integer`, is added to the file name. 2. *Multiple class instances*. If an instance of the class writes to a file that is in use: @@ -71,9 +71,9 @@ The main features of this class are: **Log Maintenance** -- The minimum frequency for creating new log files is determined by the property. When the value is or , a new log file is created at least once every day or week, and a date stamp is incorporated into the name. +- The minimum frequency for creating new log files is determined by the property. When the value is or , a new log file is created at least once every day or week, and a date stamp is incorporated into the name. - The maximum size (in bytes) of the log file is determined by the property. If the log file size exceeds this size, additional messages written to the log are discarded and, depending on the property, an exception is thrown. -- The property determines how much free space (in bytes) must be available. This helps ensure that the class will not consume all available disk space. Use the property to specify the behavior of log writes when there are less than bytes free. +- The property determines how much free space (in bytes) must be available. This helps ensure that the class will not consume all available disk space. Use the property to specify the behavior of log writes when there are less than bytes free. **Log-File Output Settings** @@ -84,9 +84,9 @@ The main features of this class are: **Log-File Output** -- The and methods write messages to the log file. These methods check the property, along with any existing logs with the same base name to determine if a new log should be created. -- The method flushes any messages currently in the output buffer to the log file. -- The method closes the log file so that it can be used by other processes. +- The and methods write messages to the log file. These methods check the property, along with any existing logs with the same base name to determine if a new log should be created. +- The method flushes any messages currently in the output buffer to the log file. +- The method closes the log file so that it can be used by other processes. **Enabling Output** @@ -273,11 +273,11 @@ When the `Append` property is `False`, the log file is opened in name. +- The output file is locked by another process. A new log file is created with a version number that is incorporated into the name. - The current file size is greater than what the property allows. Additional messages are discarded. Depending on the property, an exception is thrown. -- The existing file name is out of date according to the log-creation schedule specified by the property. A new log file is created. The date stamp is incorporated into the name. +- The existing file name is out of date according to the log-creation schedule specified by the property. A new log file is created. The date stamp is incorporated into the name. ]]> @@ -325,7 +325,7 @@ This behavior is overridden in the following scenarios: property provides the best performance for most applications, because it is more efficient to write multiple messages to the log file at one time. You can use the method to flush any messages currently in the log file's output buffer. You can also use the method, which implicitly flushes the stream before closing the log file. + The `False` setting for the property provides the best performance for most applications, because it is more efficient to write multiple messages to the log file at one time. You can use the method to flush any messages currently in the log file's output buffer. You can also use the method, which implicitly flushes the stream before closing the log file. ]]> @@ -377,7 +377,7 @@ This behavior is overridden in the following scenarios: - The `baseName` part is the fundamental log name, specified by the property. -- The `dateStamp` part has the format "YYYY-MM-DD", and it is shown when is set to or . +- The `dateStamp` part has the format "YYYY-MM-DD", and it is shown when is set to or . - If more than one log file is needed with the same `baseName` and `dateStamp`, the `iteration` part, a positive `Integer`, is added to the file name. @@ -429,7 +429,7 @@ This behavior is overridden in the following scenarios: method explicitly, because the class manages the underlying steam. + You do not need to call the method explicitly, because the class manages the underlying steam. ]]> @@ -701,7 +701,7 @@ This behavior is overridden in the following scenarios: method to write all buffered data to the current log file. + Use the method to write all buffered data to the current log file. ]]> @@ -755,7 +755,7 @@ This behavior is overridden in the following scenarios: - The `baseName` part is the fundamental log name, specified by the property. -- The `dateStamp` part has the format YYYY-MM-DD, and it is shown when is or . +- The `dateStamp` part has the format YYYY-MM-DD, and it is shown when is or . - If more than one log file is needed with the same `baseName` and `dateStamp`, the `iteration` part, a positive `Integer`, is added to the file name. @@ -850,7 +850,7 @@ This behavior is overridden in the following scenarios: and methods. + Use the property to configure the behavior of the and methods. ]]> @@ -900,7 +900,7 @@ This behavior is overridden in the following scenarios: ||The path for the executable file that started the application.| ||The path for the application data of a user, with the format:

`BasePath`\\`CompanyName`\\`ProductName`\\`ProductVersion`

A typical value for `BasePath` is:

C:\Documents and Settings\\`username`\Application Data

The values of `CompanyName`, `ProductName`, and `ProductVersion` come form the assembly.| ||The path of the current system's temporary folder.| -||If the string specified by is not empty, then use it as the path; otherwise use the path for the application data of a user.| +||If the string specified by is not empty, then use it as the path; otherwise use the path for the application data of a user.| ]]> @@ -943,7 +943,7 @@ This behavior is overridden in the following scenarios: ## Remarks Assign one of the enumeration values to the property to specify which date to include in the names of the log files. - The format of the date is YYYY-MM-DD. For more information on the format of the log file name, see . + The format of the date is YYYY-MM-DD. For more information on the format of the log file name, see . |**LogFileCreationSchedule value**|**Date in the log file name**| |---------------------------------------|-----------------------------------| @@ -999,7 +999,7 @@ This behavior is overridden in the following scenarios: ## Remarks Use this property to make sure that the log files do not grow too large. - If the log file size (in bytes) is greater than the value of this property, then when the class attempts to write a message to the log, the message is discarded and the failure is either silent or an exception is thrown depending on the value of the property. Otherwise, the message is written to the log, if the amount of free disk space (in bytes) is less than . + If the log file size (in bytes) is greater than the value of this property, then when the class attempts to write a message to the log, the message is discarded and the failure is either silent or an exception is thrown depending on the value of the property. Otherwise, the message is written to the log, if the amount of free disk space (in bytes) is less than . ]]> @@ -1049,7 +1049,7 @@ This behavior is overridden in the following scenarios: ## Remarks Use this property to make sure that the log files do not completely fill the disk. - If the amount of free disk space (in bytes) is less than the value of this property, then when the class attempts to write a message to the log, the message is discarded and the failure is either silent or an exception is thrown depending on the value of the property. Otherwise, the message is written to the log, if the log file size (in bytes) is greater than . + If the amount of free disk space (in bytes) is less than the value of this property, then when the class attempts to write a message to the log, the message is discarded and the failure is either silent or an exception is thrown depending on the value of the property. Otherwise, the message is written to the log, if the log file size (in bytes) is greater than . ]]> @@ -1070,7 +1070,7 @@ This behavior is overridden in the following scenarios: methods are not intended to be called by application code. These methods are called by members of the , , and classes to write trace data to output. + methods are not intended to be called by application code. These methods are called by members of the , , and classes to write trace data to output. ]]> @@ -1129,7 +1129,7 @@ This behavior is overridden in the following scenarios: 3. Writes the information to the log file. - For more information on creating new log files, see . + For more information on creating new log files, see . The following table lists the output fields in the order they appear. The fields are delimited by the string that the property specifies, and are followed by a line terminator. @@ -1216,7 +1216,7 @@ This behavior is overridden in the following scenarios: 3. Writes the information to the log file. - For more information on creating new log files, see . + For more information on creating new log files, see . This table lists the output fields in the order they appear. The fields are delimited by the string that the property specifies, and are followed by a line terminator. @@ -1225,7 +1225,7 @@ This behavior is overridden in the following scenarios: |`source`|Always|The value of `name`.| |`severity`|Always|The enumeration-value name of `eventType`.| |`id`|Always|The string representation of `id`.| -|`message`|Always|The string consisting of the string representation of each element in `data`, each separated by .| +|`message`|Always|The string consisting of the string representation of each element in `data`, each separated by .| |`callStack`|When the flag is set in the property.|The property of `eventCache`.| |`CorrelationID`|When the flag is set in the property.|The property of `eventCache`.| |`DateTime`|When the flag is set in the property.|The string representation of the property of `eventCache`. The invariant culture is used for the string conversion.| @@ -1254,7 +1254,7 @@ This behavior is overridden in the following scenarios: methods are not intended to be called by application code. These methods are called by members of the , , and classes to write trace data to output. + methods are not intended to be called by application code. These methods are called by members of the , , and classes to write trace data to output. ]]> @@ -1313,7 +1313,7 @@ This behavior is overridden in the following scenarios: 3. Writes the information to the log file. - For more information on creating new log files, see . + For more information on creating new log files, see . This table lists the output fields in the order in which they appear. The fields are delimited by the string that the property specifies, and are followed by a line terminator. @@ -1402,7 +1402,7 @@ This behavior is overridden in the following scenarios: 3. Writes the information to the log file. - For more information on creating new log file, see . + For more information on creating new log file, see . This table lists the output fields in the order in which they appear. The fields are delimited by the string that the property specifies, and followed by a line terminator. @@ -1466,9 +1466,9 @@ This behavior is overridden in the following scenarios: method writes a specific message to the log file, without any additional context information. + The method writes a specific message to the log file, without any additional context information. - Use the one of the methods to include the context information in the log output. + Use the one of the methods to include the context information in the log output. ]]> @@ -1514,9 +1514,9 @@ This behavior is overridden in the following scenarios: method writes a specific message to the log file, without any additional context information. + The method writes a specific message to the log file, without any additional context information. - Use the one of the methods to include the context information in the log output. + Use the one of the methods to include the context information in the log output. ]]> diff --git a/xml/Microsoft.VisualBasic.Logging/Log.xml b/xml/Microsoft.VisualBasic.Logging/Log.xml index 90745d7540b..0d6b8c243fe 100644 --- a/xml/Microsoft.VisualBasic.Logging/Log.xml +++ b/xml/Microsoft.VisualBasic.Logging/Log.xml @@ -234,9 +234,9 @@ Right now we only support WinApp as an application platform , sets its name to `FileLog`, and configures it to log messages with severity level and greater. The new object is then added to the collection. + This method creates a new , sets its name to `FileLog`, and configures it to log messages with severity level and greater. The new object is then added to the collection. - The calls the method if the property has not been configured. The trace source can be configured in the application's configuration file. + The calls the method if the property has not been configured. The trace source can be configured in the application's configuration file. ]]> diff --git a/xml/Microsoft.VisualBasic.MyServices.Internal/ContextValue`1.xml b/xml/Microsoft.VisualBasic.MyServices.Internal/ContextValue`1.xml index bfb9505b2fa..28b246456f1 100644 --- a/xml/Microsoft.VisualBasic.MyServices.Internal/ContextValue`1.xml +++ b/xml/Microsoft.VisualBasic.MyServices.Internal/ContextValue`1.xml @@ -81,7 +81,7 @@ ## Remarks This class supports `My` in Visual Basic. It is not intended to be used directly from your code. - This class stores an object in a context appropriate for the run time environment. The value of the property is initialized to `Nothing`. + This class stores an object in a context appropriate for the run time environment. The value of the property is initialized to `Nothing`. ]]> diff --git a/xml/Microsoft.VisualBasic.MyServices/FileSystemProxy.xml b/xml/Microsoft.VisualBasic.MyServices/FileSystemProxy.xml index b773398e910..a9ad3b16ac4 100644 --- a/xml/Microsoft.VisualBasic.MyServices/FileSystemProxy.xml +++ b/xml/Microsoft.VisualBasic.MyServices/FileSystemProxy.xml @@ -3688,9 +3688,9 @@ The `OpenTextFileWriter` method opens and initializes a stream for a file and then returns the object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. > [!NOTE] -> You must call the method on the object to make sure that all data is correctly written to the underlying stream. +> You must call the method on the object to make sure that all data is correctly written to the underlying stream. - If you are writing only a few strings to a file, it might be simpler to use the method. + If you are writing only a few strings to a file, it might be simpler to use the method. The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. @@ -3764,9 +3764,9 @@ The `OpenTextFileWriter` method opens and initializes a stream for a file and then returns the object for that stream. You can write to the steam as many times as necessary and then close it when you are finished. > [!NOTE] -> You must call the method on the object to make sure that all data is correctly written to the underlying stream. +> You must call the method on the object to make sure that all data is correctly written to the underlying stream. - If you are writing only a few strings to a file, it might be simpler to use the method. + If you are writing only a few strings to a file, it might be simpler to use the method. The following table lists an example of a task involving the `My.Computer.FileSystem.OpenTextFileWriter` method. @@ -3917,7 +3917,7 @@ ## Remarks The `ReadAllText` method of the `My.Computer.FileSystem` object allows you to read from a text file. The contents of the file are returned as a string. - The file encoding can be specified if the contents of the file are in an encoding such as ASCII or UTF-8. If you are reading from a file with extended characters, you need to specify the file encoding using another overload of the method. + The file encoding can be specified if the contents of the file are in an encoding such as ASCII or UTF-8. If you are reading from a file with extended characters, you need to specify the file encoding using another overload of the method. Do not make decisions about the contents of the file based on the name of the file. For example, the file Form1.vb may not be a Visual Basic source file. Verify all inputs before using the data in your application. @@ -4162,7 +4162,7 @@ method to move and rename the file. + This method cannot be used to move a file; use the method to move and rename the file. The following table lists an example of a task involving the `My.Computer.FileSystem.RenameFile` method. @@ -4379,14 +4379,14 @@ method. + The UTF-8 encoding is used to write to the file. To specify a different encoding, use a different overload of the method. If the specified file does not exist, it is created. If the specified encoding does not match the existing encoding of the file, the specified coding is ignored. > [!NOTE] -> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. +> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. @@ -4475,7 +4475,7 @@ If the specified encoding does not match the existing encoding of the file, the specified coding is ignored. > [!NOTE] -> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. +> The `WriteAllText` method opens a file, writes to it, and then closes it. Code that uses the `WriteAllText` method is simpler than code that uses a object. However, if you are adding strings to a file by using a loop, a object can provide better performance because you only have to open and close the file one time. For more information, see the method. The following table lists examples of tasks involving the `My.Computer.FileSystem.WriteAllText` method. diff --git a/xml/Microsoft.VisualBasic/AudioPlayMode.xml b/xml/Microsoft.VisualBasic/AudioPlayMode.xml index e0205e1e336..94a48c80aab 100644 --- a/xml/Microsoft.VisualBasic/AudioPlayMode.xml +++ b/xml/Microsoft.VisualBasic/AudioPlayMode.xml @@ -26,11 +26,11 @@ Indicates how to play sounds when calling audio methods. - method plays sounds. - + method plays sounds. + ]]> diff --git a/xml/Microsoft.VisualBasic/Collection.xml b/xml/Microsoft.VisualBasic/Collection.xml index 33f4f6b9135..43112653238 100644 --- a/xml/Microsoft.VisualBasic/Collection.xml +++ b/xml/Microsoft.VisualBasic/Collection.xml @@ -88,15 +88,15 @@ Dim coll As New Microsoft.VisualBasic.Collection() Once you have created a collection, you can do any of the following: -- Add an element with the method. +- Add an element with the method. -- Remove an element with the method. +- Remove an element with the method. -- Remove all elements with the method. +- Remove all elements with the method. - Find out how many elements the collection contains with the property. -- Check whether a specific element is present with the method. +- Check whether a specific element is present with the method. - Return a specific element from the collection with the property. @@ -228,7 +228,7 @@ Dim coll As New Microsoft.VisualBasic.Collection() ## Examples - The following example uses the `Add` method to add `child` objects - instances of a class called `child` containing a `Public` property `name` - to a collection called `family`. To see how this works, create a with two controls and set their properties to `Add` and `List`. Add the `child` class definition and the `family` declaration to the form code. Modify the `_Click` event handlers for the **Add** and **List** buttons as shown. The **Add** button allows you to add children. The **List** button displays the names of all the children. + The following example uses the `Add` method to add `child` objects - instances of a class called `child` containing a `Public` property `name` - to a collection called `family`. To see how this works, create a with two controls and set their properties to `Add` and `List`. Add the `child` class definition and the `family` declaration to the form code. Modify the `_Click` event handlers for the **Add** and **List** buttons as shown. The **Add** button allows you to add children. The **List** button displays the names of all the children. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Collection/Overview/Form1.vb" id="Snippet2"::: @@ -329,7 +329,7 @@ Dim coll As New Microsoft.VisualBasic.Collection() ## Remarks `Contains` returns `True` if the collection contains an element with a key exactly matching `Key`. Otherwise, `Contains` returns `False`. Case is ignored when matching key values. - A Visual Basic `Collection` can hold some elements that have keys and other elements without keys. This depends on whether the call to the method supplies an argument to the optional `Key` parameter. + A Visual Basic `Collection` can hold some elements that have keys and other elements without keys. This depends on whether the call to the method supplies an argument to the optional `Key` parameter. @@ -452,7 +452,7 @@ Dim coll As New Microsoft.VisualBasic.Collection() :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Collection/Overview/Class1.vb" id="Snippet7"::: - `GetEnumerator` constructs and returns an enumerator object, which implements the interface of the namespace. The enumerator object exposes the property and the and methods. For more information, see [For Each...Next Statement](/dotnet/visual-basic/language-reference/statements/for-each-next-statement). + `GetEnumerator` constructs and returns an enumerator object, which implements the interface of the namespace. The enumerator object exposes the property and the and methods. For more information, see [For Each...Next Statement](/dotnet/visual-basic/language-reference/statements/for-each-next-statement). ]]> @@ -1029,11 +1029,11 @@ MsgBox(CStr(customers(1))) Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first element in the collection. The method also brings the enumerator back to this position. At this position, the property is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . + Initially, the enumerator is positioned before the first element in the collection. The method also brings the enumerator back to this position. At this position, the property is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . - returns the same object until either or is called. sets to the next element. + returns the same object until either or is called. sets to the next element. - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returns `false`, is undefined. To set to the first element of the collection again, you can call followed by . + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returns `false`, is undefined. To set to the first element of the collection again, you can call followed by . An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. diff --git a/xml/Microsoft.VisualBasic/Conversion.xml b/xml/Microsoft.VisualBasic/Conversion.xml index d06900f1efe..e0e21485404 100644 --- a/xml/Microsoft.VisualBasic/Conversion.xml +++ b/xml/Microsoft.VisualBasic/Conversion.xml @@ -2862,7 +2862,7 @@ Dim i3 As Integer = CInt(Fix(sng)) ' Result: 175 Use the `Format` function to convert numeric values you want formatted as dates, times, or currency or in other user-defined formats. Unlike the `Str` function, the `Format` function does not include a leading space for the sign of `Number`. > [!NOTE] -> The `Str` function recognizes only the period (`.`) as a valid decimal separator. If different decimal separators are used (for example, in international applications), use the `CStr` or `Format` functions to convert a number to a string. To get the string representation of a number in a particular culture, use the number's `ToString(IFormatProvider)` method. For example, use when converting a value of type `Double` to a string. +> The `Str` function recognizes only the period (`.`) as a valid decimal separator. If different decimal separators are used (for example, in international applications), use the `CStr` or `Format` functions to convert a number to a string. To get the string representation of a number in a particular culture, use the number's `ToString(IFormatProvider)` method. For example, use when converting a value of type `Double` to a string. @@ -2950,7 +2950,7 @@ Val("&HFFFF") ``` > [!NOTE] -> The `Val` function recognizes only the period (`.`) as a valid decimal separator. When different decimal separators are used, as in international applications, use `CDbl` or `CInt` instead to convert a string to a number. To convert the string representation of a number in a particular culture to a numeric value, use the numeric type's `Parse(String, IFormatProvider)` method. For example, use when converting a string to a `Double`. +> The `Val` function recognizes only the period (`.`) as a valid decimal separator. When different decimal separators are used, as in international applications, use `CDbl` or `CInt` instead to convert a string to a number. To convert the string representation of a number in a particular culture to a numeric value, use the numeric type's `Parse(String, IFormatProvider)` method. For example, use when converting a string to a `Double`. An exception might be thrown in response to certain uncommon number formats. For example, the following code raises this exception. @@ -3045,7 +3045,7 @@ Val("&HFFFF") ``` > [!NOTE] -> The `Val` function recognizes only the period (`.`) as a valid decimal separator. When other decimal separators are used, as in international applications, use `CDbl` or `CInt` instead to convert a string to a number. To convert the string representation of a number in a particular culture to a numeric value, use the numeric type's `Parse(String, IFormatProvider)` method. For example, use when converting a string to a `Double`. +> The `Val` function recognizes only the period (`.`) as a valid decimal separator. When other decimal separators are used, as in international applications, use `CDbl` or `CInt` instead to convert a string to a number. To convert the string representation of a number in a particular culture to a numeric value, use the numeric type's `Parse(String, IFormatProvider)` method. For example, use when converting a string to a `Double`. > [!NOTE] > An exception might be thrown in response to certain uncommon number formats. For example, the following code raises this exception. @@ -3141,7 +3141,7 @@ Val("&HFFFF") ``` > [!NOTE] -> The `Val` function recognizes only the period (`.`) as a valid decimal separator. When other decimal separators are used, as in international applications, use `CDbl` or `CInt` instead to convert a string to a number. To convert the string representation of a number in a particular culture to a numeric value, use the numeric type's `Parse(String, IFormatProvider)` method. For example, use when converting a string to a `Double`. +> The `Val` function recognizes only the period (`.`) as a valid decimal separator. When other decimal separators are used, as in international applications, use `CDbl` or `CInt` instead to convert a string to a number. To convert the string representation of a number in a particular culture to a numeric value, use the numeric type's `Parse(String, IFormatProvider)` method. For example, use when converting a string to a `Double`. > [!NOTE] > An exception might be raised in response to certain uncommon number formats. For example, the following code raises this exception. diff --git a/xml/Microsoft.VisualBasic/DateAndTime.xml b/xml/Microsoft.VisualBasic/DateAndTime.xml index 4da87b1b1b6..b3671b0bc8a 100644 --- a/xml/Microsoft.VisualBasic/DateAndTime.xml +++ b/xml/Microsoft.VisualBasic/DateAndTime.xml @@ -129,7 +129,7 @@ Dim NextMonth As Date = DateAdd(DateInterval.Month, 1, #1/31/1995#) In this example, `DateAdd` returns `#2/28/1995#`, not `#2/31/1995#`. If `DateValue` is `#1/31/1996#`, it returns `#2/29/1996#` because 1996 is a leap year. > [!NOTE] -> `DateAdd` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. +> `DateAdd` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. Since every `Date` value is supported by a structure, its methods give you additional options in adding time intervals. For example, you can add a fractional number of days, rounded to the nearest millisecond, to a `Date` variable as follows: @@ -243,7 +243,7 @@ Dim NextMonth As Date = DateAdd(DateInterval.Month, 1, #1/31/1995#) In this example, `DateAdd` returns `#2/28/1995#`, not `#2/31/1995#`. If `DateValue` is `#1/31/1996#`, it returns `#2/29/1996#` because 1996 is a leap year. > [!NOTE] -> `DateAdd` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. +> `DateAdd` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. Since every `Date` value is supported by a structure, its methods give you additional options in adding time intervals. For example, you can add a fractional number of days, rounded to the nearest millisecond, to a `Date` variable as follows: @@ -372,7 +372,7 @@ NextTime = NextTime.AddDays(3.4) ' Increment by 3 2/5 days. For cultures such as Japanese that have multiple eras, the `DateDiff` method does not return a difference in years if the difference spans two or more eras. Instead, you can calculate the difference in values returned by the property, as shown in the following example: `date2.Year - date1.Year`. -- **Other Intervals.** Since every `Date` value is supported by a structure, its methods give you additional options in finding time intervals. For example, you can use the `Subtract` method in either of its overloaded forms: subtracts a from a `Date` variable to return another `Date` value, and subtracts a `Date` value to return a . You can time a process to find out how many milliseconds it takes, as the following example shows. +- **Other Intervals.** Since every `Date` value is supported by a structure, its methods give you additional options in finding time intervals. For example, you can use the `Subtract` method in either of its overloaded forms: subtracts a from a `Date` variable to return another `Date` value, and subtracts a `Date` value to return a . You can time a process to find out how many milliseconds it takes, as the following example shows. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Conversion/Val/Class1.vb" id="Snippet61"::: @@ -518,7 +518,7 @@ NextTime = NextTime.AddDays(3.4) ' Increment by 3 2/5 days. For cultures such as Japanese that have multiple eras, the `DateDiff` method does not return a difference in years if the difference spans two or more eras. Instead, you can calculate the difference in values returned by the property, as shown in the following example: `date2.Year - date1.Year`. -- **Other Intervals.** Since every `Date` value is supported by a structure, its methods give you additional options in finding time intervals. For example, you can use the `Subtract` method in either of its overloaded forms: subtracts a from a `Date` variable to return another `Date` value, and subtracts a `Date` value to return a . You can time a process to find out how many milliseconds it takes, as the following example shows. +- **Other Intervals.** Since every `Date` value is supported by a structure, its methods give you additional options in finding time intervals. For example, you can use the `Subtract` method in either of its overloaded forms: subtracts a from a `Date` variable to return another `Date` value, and subtracts a `Date` value to return a . You can time a process to find out how many milliseconds it takes, as the following example shows. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Conversion/Val/Class1.vb" id="Snippet61"::: @@ -914,7 +914,7 @@ Dim EndFeb As Date = DateSerial(-10, 3, 0) The `Date` data type includes time components. `DateSerial` sets all of these to 0, so the returned value represents the beginning of the calculated day. - Since every `Date` value is supported by a structure, its methods give you additional options in assembling a `Date` value. For example, you can use one of the overloaded constructors to populate a `Date` variable using the desired combination of components. The following example sets `NewDateTime` to May 6, 1978 at one tenth of a second before 8:30 in the morning: + Since every `Date` value is supported by a structure, its methods give you additional options in assembling a `Date` value. For example, you can use one of the overloaded constructors to populate a `Date` variable using the desired combination of components. The following example sets `NewDateTime` to May 6, 1978 at one tenth of a second before 8:30 in the morning: ```vb Dim NewDateTime As Date = New Date(1978, 5, 6, 8, 29, 59, 900) @@ -987,7 +987,7 @@ Dim NewDateTime As Date = New Date(1978, 5, 6, 8, 29, 59, 900) To get or set the current system time as a `String`, use the property. - To get the current system date or time in the format of your locale, or in a custom format, supply the property to the function, specifying either a predefined or user-defined date/time format. The following example demonstrates this. + To get the current system date or time in the format of your locale, or in a custom format, supply the property to the function, specifying either a predefined or user-defined date/time format. The following example demonstrates this. ```vb MsgBox("The formatted date is " & Format(Now, "dddd, d MMM yyyy")) @@ -1055,7 +1055,7 @@ MsgBox("The formatted date is " & Format(Now, "dddd, d MMM yyyy")) property of the class in the namespace. The default values are determined by **Control Panel** settings. You can override the Short Date format by setting the property of the class in the namespace. + If `StringDate` includes only numbers from 1 through 12 separated by valid date separators, `DateValue` recognizes the order for month, day, and year according to the Short Date format specified for your system. `DateValue` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. You can override the Short Date format by setting the property of the class in the namespace. `DateValue` recognizes month names in long, abbreviated, and numeric form. For example, in addition to recognizing 12/30/1991 and 12/30/91, `DateValue` also recognizes December 30, 1991 and Dec 30, 1991. @@ -1392,7 +1392,7 @@ Dim thisDay As Integer = Microsoft.VisualBasic.DateAndTime.Day(Now) The string returned by `MonthName` depends not only on the input arguments, but also on the **Regional Options** settings specified in the Windows **Control Panel**. > [!NOTE] -> `MonthName` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. +> `MonthName` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. @@ -1721,7 +1721,7 @@ MsgBox(TimeSerial(23, 75, 0)) If the values of the arguments result in a negative calculated time, the date information is set to 1/1/0001 and the time information is adjusted to be between 00:00:00 and 23:59:59. However, if the calculated time is less than negative 24 hours, an error occurs. - Since every `Date` value is supported by a structure, its methods give you additional options in assembling a `Date` value. For example, you can employ one of the overloaded constructors to populate a `Date` variable using the desired combination of components. The following example sets `newDateTime` to May 6, 1978 at one tenth of a second before 8:30 in the morning: + Since every `Date` value is supported by a structure, its methods give you additional options in assembling a `Date` value. For example, you can employ one of the overloaded constructors to populate a `Date` variable using the desired combination of components. The following example sets `newDateTime` to May 6, 1978 at one tenth of a second before 8:30 in the morning: ```vb Dim newDateTime As Date = New Date(1978, 5, 6, 8, 29, 59, 900) @@ -1793,7 +1793,7 @@ Dim newDateTime As Date = New Date(1978, 5, 6, 8, 29, 59, 900) To get or set the current system date as a `String`, use the property. - To get the current system date or time in the format of your locale, or in a custom format, supply the property to the function, specifying either a predefined or user-defined date/time format. The following example demonstrates this. + To get the current system date or time in the format of your locale, or in a custom format, supply the property to the function, specifying either a predefined or user-defined date/time format. The following example demonstrates this. ```vb MsgBox("The formatted time is " & Format(Now, "hh.mm.ss.fff tt")) @@ -1996,7 +1996,7 @@ MsgBox("The formatted time is " & Format(Now, "hh.mm.ss.fff tt")) The value returned by the `Weekday` function corresponds to the values of the `FirstDayOfWeek` enumeration; that is, 1 indicates Sunday and 7 indicates Saturday. > [!NOTE] -> `Weekday` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. +> `Weekday` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. The `DayOfWeek` argument can have one of the following settings. @@ -2078,7 +2078,7 @@ MsgBox("The formatted time is " & Format(Now, "hh.mm.ss.fff tt")) The string returned by `WeekdayName` depends not only on the input arguments, but also on the **Regional Options** settings specified in the Windows **Control Panel**. > [!NOTE] -> `WeekdayName` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. +> `WeekdayName` uses the current calendar setting from the property of the class in the namespace. The default values are determined by **Control Panel** settings. The `FirstDayOfWeekValue` argument can have one of the following settings. diff --git a/xml/Microsoft.VisualBasic/DateInterval.xml b/xml/Microsoft.VisualBasic/DateInterval.xml index da93cff23a4..1ebefe1a0e9 100644 --- a/xml/Microsoft.VisualBasic/DateInterval.xml +++ b/xml/Microsoft.VisualBasic/DateInterval.xml @@ -29,13 +29,13 @@ Indicates how to determine and format date intervals when calling date-related functions. - method. - + method. + ]]> diff --git a/xml/Microsoft.VisualBasic/ErrObject.xml b/xml/Microsoft.VisualBasic/ErrObject.xml index e01d6504009..a5d723a5dc6 100644 --- a/xml/Microsoft.VisualBasic/ErrObject.xml +++ b/xml/Microsoft.VisualBasic/ErrObject.xml @@ -40,7 +40,7 @@ . + The `ErrObject` module supports the `Err` object. For more information, see . @@ -180,7 +180,7 @@ End If property corresponds to a Visual Basic run-time error, then the string returned by the function is set in the `Description` property when the error is generated. + The `Description` property setting consists of a short description of the error. Use this property to alert the user to an error that you cannot or do not want to handle. When generating a user-defined error, assign a short description of your error to the `Description` property. If the `Description` property is not filled in, and the value of the property corresponds to a Visual Basic run-time error, then the string returned by the function is set in the `Description` property when the error is generated. diff --git a/xml/Microsoft.VisualBasic/FileSystem.xml b/xml/Microsoft.VisualBasic/FileSystem.xml index 0e81c3b375d..14b873677bb 100644 --- a/xml/Microsoft.VisualBasic/FileSystem.xml +++ b/xml/Microsoft.VisualBasic/FileSystem.xml @@ -6767,7 +6767,7 @@ Result = GetAttr(FName) And vbArchive The leftmost print position on an output line is always 1. When you use the `Print` or `PrintLine` functions to print to files, the rightmost print position is the current width of the output file, which you can set using the `FileWidth` function. - The `TAB` function can also be used with the `WriteLine` function. It cannot be used with or . + The `TAB` function can also be used with the `WriteLine` function. It cannot be used with or . > [!NOTE] > Make sure your tabular columns are wide enough to contain wide letters. @@ -6838,7 +6838,7 @@ Result = GetAttr(FName) And vbArchive The leftmost print position on an output line is always 1. When you use the `Print` or `PrintLine` functions to print to files, the rightmost print position is the current width of the output file, which you can set using the `FileWidth` function. - The `TAB` function can also be used with the `WriteLine` function. It cannot be used with or . + The `TAB` function can also be used with the `WriteLine` function. It cannot be used with or . > [!NOTE] > Make sure your tabular columns are wide enough to contain wide letters. diff --git a/xml/Microsoft.VisualBasic/Interaction.xml b/xml/Microsoft.VisualBasic/Interaction.xml index 9ae7492bb74..8b326faaad1 100644 --- a/xml/Microsoft.VisualBasic/Interaction.xml +++ b/xml/Microsoft.VisualBasic/Interaction.xml @@ -115,7 +115,7 @@ procID = Shell("C:\Windows\system32\calc.exe", AppWinStyle.NormalFocus) method. + You use `AppActivate` to bring an application's active window into focus. You might not have a handle or a reference to the active window, or even know which window is active at a given moment. In such a case, you cannot use the method. The `AppActivate` function changes the focus to the named application or window but does not affect whether it is maximized or minimized. Focus moves away from the activated application window when the user takes some action to change the focus or close the window. You can use the `Shell` function to start an application and set the window style. @@ -187,7 +187,7 @@ procID = Shell("C:\Windows\system32\calc.exe", AppWinStyle.NormalFocus) method. + You use `AppActivate` to bring an application's active window into focus. You might not have a handle or a reference to the active window, or even know which window is active at a given moment. In such a case, you cannot use the method. The `AppActivate` function changes the focus to the named application or window but does not affect whether it is maximized or minimized. Focus moves away from the activated application window when the user takes some action to change the focus or close the window. You can use the `Shell` function to start an application and set the window style. @@ -620,7 +620,7 @@ End Sub > Use `CreateObject` when there is no current instance of the object. If an instance of the object is already running, a new instance is started, and an object of the specified type is created. To use the current instance, or to start the application and have it load a file, use the `GetObject` function. If an object has registered itself as a single-instance object, only one instance of the object is created, no matter how many times `CreateObject` is executed. ## Creating Framework Objects - You can use the `CreateObject` function only to create a COM object. While there is no exact equivalent mechanism for creating a .NET Framework object, the in the namespace contains methods to create local or remote objects. In particular, the method or the method might be useful. + You can use the `CreateObject` function only to create a COM object. While there is no exact equivalent mechanism for creating a .NET Framework object, the in the namespace contains methods to create local or remote objects. In particular, the method or the method might be useful. > [!IMPORTANT] > The `CreateObject` function requires unmanaged code permission, which might affect its execution in partial-trust situations. For more information, see and [Code Access Permissions](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h846e9b3(v=vs.100)). @@ -779,17 +779,17 @@ End Sub function returns the text assigned to the specified environment string - that is, the text following the equal sign (=) in the environment-string table for that environment variable. If the string in `Expression` cannot be found in the environment-string table, a zero-length string ("") is returned. + If `Expression` contains a string, the function returns the text assigned to the specified environment string - that is, the text following the equal sign (=) in the environment-string table for that environment variable. If the string in `Expression` cannot be found in the environment-string table, a zero-length string ("") is returned. - If `Expression` contains an integer, the string occupying that numeric position in the environment-string table is returned. In this case, returns all of the text, including the name of the environment variable. If there is no environment string in the specified position, returns a zero-length string. + If `Expression` contains an integer, the string occupying that numeric position in the environment-string table is returned. In this case, returns all of the text, including the name of the environment variable. If there is no environment string in the specified position, returns a zero-length string. > [!IMPORTANT] -> The function requires environment permission, which might affect its execution in partial-trust situations. For more information, see and [Code Access Permissions](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h846e9b3(v=vs.100)). +> The function requires environment permission, which might affect its execution in partial-trust situations. For more information, see and [Code Access Permissions](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h846e9b3(v=vs.100)). ## Examples - This example uses the function to supply the entry number and length of the `PATH` statement from the environment-string table. + This example uses the function to supply the entry number and length of the `PATH` statement from the environment-string table. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Conversion/ErrorToString/Class1.vb" id="Snippet28"::: @@ -848,17 +848,17 @@ End Sub function returns the text assigned to the specified environment string - that is, the text following the equal sign (=) in the environment-string table for that environment variable. If the string in `Expression` cannot be found in the environment-string table, a zero-length string ("") is returned. + If `Expression` contains a string, the function returns the text assigned to the specified environment string - that is, the text following the equal sign (=) in the environment-string table for that environment variable. If the string in `Expression` cannot be found in the environment-string table, a zero-length string ("") is returned. - If `Expression` contains an integer, the string occupying that numeric position in the environment-string table is returned. In this case, returns all of the text, including the name of the environment variable. If there is no environment string in the specified position, returns a zero-length string. + If `Expression` contains an integer, the string occupying that numeric position in the environment-string table is returned. In this case, returns all of the text, including the name of the environment variable. If there is no environment string in the specified position, returns a zero-length string. > [!IMPORTANT] -> The function requires environment permission, which might affect its execution in partial-trust situations. For more information, see and [Code Access Permissions](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h846e9b3(v=vs.100)). +> The function requires environment permission, which might affect its execution in partial-trust situations. For more information, see and [Code Access Permissions](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h846e9b3(v=vs.100)). ## Examples - This example uses the function to supply the entry number and length of the `PATH` statement from the environment-string table. + This example uses the function to supply the entry number and length of the `PATH` statement from the environment-string table. :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Conversion/ErrorToString/Class1.vb" id="Snippet28"::: @@ -1059,7 +1059,7 @@ drawObj.SaveAs("C:\Drawings\sample.drw") ``` > [!NOTE] -> Use the `GetObject` function when there is a current instance of the object or if you want to create the object with a file loaded. If there is no current instance, and you do not want the object started with a file loaded, use the function. +> Use the `GetObject` function when there is a current instance of the object or if you want to create the object with a file loaded. If there is no current instance, and you do not want the object started with a file loaded, use the function. > > If an object has registered itself as an ActiveX single-instance object, only one instance of the object is created, no matter how many times `CreateObject` is called. With a single-instance object, `GetObject` always returns the same instance when called with the zero-length string (`""`) syntax, and it causes an error if the `PathName` argument is omitted. You cannot use `GetObject` to obtain a reference to a class created with Visual Basic. diff --git a/xml/Microsoft.VisualBasic/OpenMode.xml b/xml/Microsoft.VisualBasic/OpenMode.xml index 43fc2337376..e66c5e70638 100644 --- a/xml/Microsoft.VisualBasic/OpenMode.xml +++ b/xml/Microsoft.VisualBasic/OpenMode.xml @@ -29,19 +29,19 @@ Indicates how to open a file when calling file-access functions. - method. - - When sequentially accessing a file, you cannot change its data. You can read the data, append to it, or overwrite it with new data. If you open it for input, the contents of the file will be overwritten, even if you do not directly write to the file. - - When performing file I/O operations, the `My.Computer.FileSystem` object provides better performance and ease of use than earlier file I/O methods. For more information, see object. - + method. + + When sequentially accessing a file, you cannot change its data. You can read the data, append to it, or overwrite it with new data. If you open it for input, the contents of the file will be overwritten, even if you do not directly write to the file. + + When performing file I/O operations, the `My.Computer.FileSystem` object provides better performance and ease of use than earlier file I/O methods. For more information, see object. + ]]> diff --git a/xml/Microsoft.VisualBasic/SpcInfo.xml b/xml/Microsoft.VisualBasic/SpcInfo.xml index e33b1e7f553..c485eeac64b 100644 --- a/xml/Microsoft.VisualBasic/SpcInfo.xml +++ b/xml/Microsoft.VisualBasic/SpcInfo.xml @@ -37,13 +37,13 @@ This class supports the Visual Basic and functions. - and . - + and . + ]]> @@ -83,13 +83,13 @@ This field supports the Visual Basic and functions. - and . - + and . + ]]> diff --git a/xml/Microsoft.VisualBasic/Strings.xml b/xml/Microsoft.VisualBasic/Strings.xml index 34af5655721..172c302bd1d 100644 --- a/xml/Microsoft.VisualBasic/Strings.xml +++ b/xml/Microsoft.VisualBasic/Strings.xml @@ -387,7 +387,7 @@ `Chr` uses the class in the namespace to determine if the current thread is using a single-byte character set (SBCS) or a double-byte character set (DBCS). It then takes `CharCode` as a code point in the appropriate set. The range can be 0 through 255 for SBCS characters and -32768 through 65535 for DBCS characters. - The returned value depends on the code page for the current thread, which is contained in the property of the class in the namespace. You can obtain by specifying `System.Globalization.CultureInfo.CurrentCulture.TextInfo.ANSICodePage`. + The returned value depends on the code page for the current thread, which is contained in the property of the class in the namespace. You can obtain by specifying `System.Globalization.CultureInfo.CurrentCulture.TextInfo.ANSICodePage`. `ChrW` takes `CharCode` as a Unicode code point. The range is independent of the culture and code page settings for the current thread. Values from -32768 through -1 are treated the same as values in the range +32768 through +65535. @@ -461,7 +461,7 @@ `Chr` uses the class in the namespace to determine if the current thread is using a single-byte character set (SBCS) or a double-byte character set (DBCS). It then takes `CharCode` as a code point in the appropriate set. The range can be 0 through 255 for SBCS characters and -32768 through 65535 for DBCS characters. - The returned value depends on the code page for the current thread, which is contained in the property of the class in the namespace. You can obtain by specifying `System.Globalization.CultureInfo.CurrentCulture.TextInfo.ANSICodePage`. + The returned value depends on the code page for the current thread, which is contained in the property of the class in the namespace. You can obtain by specifying `System.Globalization.CultureInfo.CurrentCulture.TextInfo.ANSICodePage`. `ChrW` takes `CharCode` as a Unicode code point. The range is independent of the culture and code page settings for the current thread. Values from -32768 through -1 are treated the same as values in the range +32768 through +65535. @@ -736,7 +736,7 @@ method also provides similar functionality. + The method also provides similar functionality. If you are formatting a nonlocalized numeric string, you should use a user-defined numeric format to ensure that you get the look you want. @@ -1046,7 +1046,7 @@ The `Date` data type always contains both date and time information. For purposes of type conversion, Visual Basic considers 1/1/1 (January 1 of the year 1) to be a neutral value for the date, and 00:00:00 (midnight) to be a neutral value for the time. If you format a `Date` value as a date/time string, `FormatDateTime` does not include neutral values in the resulting string. For example, if you convert #1/1/0001 9:30:00# to a string, the result is "9:30:00 AM"; the date information is suppressed. However, the date information is still present in the original `Date` value and can be recovered with functions such as `DatePart`. > [!NOTE] -> If you pass the `Expression` argument as a `String` literal, `FormatDateTime` interprets it according to the setting of your application. However, if you pass it as a `Date` literal, use the format #mm/dd/yyyy#, because `FormatDateTime` always interprets a `Date` literal according to the English (US) culture. This is necessary because, if an application is developed and coded using `Date` literals from one culture, but is then executed on a platform with a different culture, the `Date` literals could be parsed incorrectly. +> If you pass the `Expression` argument as a `String` literal, `FormatDateTime` interprets it according to the setting of your application. However, if you pass it as a `Date` literal, use the format #mm/dd/yyyy#, because `FormatDateTime` always interprets a `Date` literal according to the English (US) culture. This is necessary because, if an application is developed and coded using `Date` literals from one culture, but is then executed on a platform with a different culture, the `Date` literals could be parsed incorrectly. The `NamedFormat` argument has the following settings. @@ -1869,7 +1869,7 @@ This function uses the application's culture information when manipulating the string so that the case changes are appropriate for the locale in which the application is being used. > [!IMPORTANT] -> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). +> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). @@ -1938,7 +1938,7 @@ This function uses the application's culture information when manipulating the string so that the case changes are appropriate for the locale in which the application is being used. > [!IMPORTANT] -> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). +> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). @@ -3476,7 +3476,7 @@ ## Examples - The first two `Mid` functions in this example return the specified number of characters from a string, starting from the given positions. (The last function illustrates the overload and only specifies the starting point for the string extraction.) + The first two `Mid` functions in this example return the specified number of characters from a string, starting from the given positions. (The last function illustrates the overload and only specifies the starting point for the string extraction.) :::code language="vb" source="~/snippets/visualbasic/Microsoft.VisualBasic/Conversion/Overview/Class1.vb" id="Snippet17"::: @@ -4089,7 +4089,7 @@ Dim aString As String = Replace(TestString, "o", "i") This function uses the application's culture information when manipulating the string so that the case changes are appropriate for the locale in which the application is being used. > [!IMPORTANT] -> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). +> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). The `Conversion` argument settings are: @@ -4525,7 +4525,7 @@ For more information about how .NET divides a string instance into text elements This function uses the application's culture information when manipulating the string so that the case changes are appropriate for the locale in which the application is being used. > [!IMPORTANT] -> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). +> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). @@ -4596,7 +4596,7 @@ For more information about how .NET divides a string instance into text elements This function uses the application's culture information when manipulating the string so that the case changes are appropriate for the locale in which the application is being used. > [!IMPORTANT] -> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). +> If your application makes security decisions based on the result of a comparison or case-change operation, then the operation should use the method, and pass or for the `comparisonType` argument. For more information, see [How Culture Affects Strings in Visual Basic](/dotnet/visual-basic/programming-guide/language-features/strings/how-culture-affects-strings). diff --git a/xml/Microsoft.VisualBasic/TabInfo.xml b/xml/Microsoft.VisualBasic/TabInfo.xml index 5338b640330..4d3fbb12dc1 100644 --- a/xml/Microsoft.VisualBasic/TabInfo.xml +++ b/xml/Microsoft.VisualBasic/TabInfo.xml @@ -37,13 +37,13 @@ This class supports the Visual Basic and functions. - and . - + and . + ]]> @@ -83,13 +83,13 @@ This field supports the Visual Basic and functions. - and . - + and . + ]]> diff --git a/xml/Microsoft.VisualBasic/VBCodeProvider.xml b/xml/Microsoft.VisualBasic/VBCodeProvider.xml index e53d60df88a..9b63469d517 100644 --- a/xml/Microsoft.VisualBasic/VBCodeProvider.xml +++ b/xml/Microsoft.VisualBasic/VBCodeProvider.xml @@ -359,7 +359,7 @@ In .NET Framework apps, you can obtain the value for `providerOptions` from the ## Examples - The following code example shows the use of the method to create a code fragment to be used in a CodeDOM graph. This code example is part of a larger example provided for the method of the class. + The following code example shows the use of the method to create a code fragment to be used in a CodeDOM graph. This code example is part of a larger example provided for the method of the class. :::code language="csharp" source="~/snippets/csharp/Microsoft.CSharp/CSharpCodeProvider/GenerateCodeFromMember/program.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/Microsoft.CSharp/CSharpCodeProvider/GenerateCodeFromMember/module1.vb" id="Snippet3"::: diff --git a/xml/Microsoft.VisualC.StlClr.Generic/ReverseBidirectionalIterator`1.xml b/xml/Microsoft.VisualC.StlClr.Generic/ReverseBidirectionalIterator`1.xml index d84bcae56b9..bd1c4b4a3ff 100644 --- a/xml/Microsoft.VisualC.StlClr.Generic/ReverseBidirectionalIterator`1.xml +++ b/xml/Microsoft.VisualC.StlClr.Generic/ReverseBidirectionalIterator`1.xml @@ -40,11 +40,11 @@ The type of an element in the controlled sequence. Defines an iterator that accesses elements in a container in the reverse direction. Elements can be accessed in the forward direction by using the decrement operator and in the backward direction by using the increment operator. The element that the iterator points to can be both written to and read from any number of times. Reverse bidirectional iterators can be used anywhere that a reverse input or reverse output iterator is required. - @@ -501,7 +501,7 @@ if the two iterators are the same object; otherwise, . - ]]> + ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/CriticalHandleMinusOneIsInvalid.xml b/xml/Microsoft.Win32.SafeHandles/CriticalHandleMinusOneIsInvalid.xml index 97224586fcd..2ffe97860d8 100644 --- a/xml/Microsoft.Win32.SafeHandles/CriticalHandleMinusOneIsInvalid.xml +++ b/xml/Microsoft.Win32.SafeHandles/CriticalHandleMinusOneIsInvalid.xml @@ -56,7 +56,7 @@ ## Remarks This class derives from the class. It describes the format of an invalid handle that uses a value of -1. Further derivations of this class (for example, file or registry handles) can specialize this further. - This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. + This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. > [!NOTE] > See the class for important information on critical handle security and thread safety. diff --git a/xml/Microsoft.Win32.SafeHandles/CriticalHandleZeroOrMinusOneIsInvalid.xml b/xml/Microsoft.Win32.SafeHandles/CriticalHandleZeroOrMinusOneIsInvalid.xml index 62b1a64db06..69693f5f286 100644 --- a/xml/Microsoft.Win32.SafeHandles/CriticalHandleZeroOrMinusOneIsInvalid.xml +++ b/xml/Microsoft.Win32.SafeHandles/CriticalHandleZeroOrMinusOneIsInvalid.xml @@ -58,7 +58,7 @@ Use the class when you need to wrap an unmanaged resource that does not have an existing managed wrapper. - This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. + This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. > [!NOTE] > See the class for important information on critical handle security and thread safety. diff --git a/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml index dcb1612f2a9..bfe137506e9 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml @@ -91,7 +91,7 @@ This class is derived from . A value of 0 or -1 is an invalid file handle. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. diff --git a/xml/Microsoft.Win32.SafeHandles/SafeHandleMinusOneIsInvalid.xml b/xml/Microsoft.Win32.SafeHandles/SafeHandleMinusOneIsInvalid.xml index c68008614d4..efb5c39f026 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeHandleMinusOneIsInvalid.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeHandleMinusOneIsInvalid.xml @@ -57,7 +57,7 @@ This class derives from the class. It describes the format of an invalid handle that uses a value of -1. Further derivations of this class (for example, file or registry handles) can specialize this further. See the class for an example of a class that derives from . > [!WARNING] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`-`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`-`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeHandleZeroOrMinusOneIsInvalid.xml b/xml/Microsoft.Win32.SafeHandles/SafeHandleZeroOrMinusOneIsInvalid.xml index a2ccee0cccd..52bd44e5bdc 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeHandleZeroOrMinusOneIsInvalid.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeHandleZeroOrMinusOneIsInvalid.xml @@ -57,7 +57,7 @@ This class derives from the class. It describes the format of an invalid handle. For example, some handles use -1 as an invalid handle value, while others use 0. Further derivations of this class (for example, file or registry handles) can specialize this further. See the class for an example of a class that derives from . > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. Use the class whenever you need to safely wrap an unmanaged resource that does not have an existing managed wrapper. diff --git a/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml index 2a78380cec6..6ef31aa4f2d 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml @@ -63,7 +63,7 @@ Use the property to obtain the safe handle. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml index 15ac8cec37b..187f328c5fc 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedViewHandle.xml @@ -57,7 +57,7 @@ Use the property to obtain the safe handle. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeNCryptKeyHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeNCryptKeyHandle.xml index b7280eb2d84..777de9110eb 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeNCryptKeyHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeNCryptKeyHandle.xml @@ -60,7 +60,7 @@ This class should be used when working with native code that expects an NCRYPT_KEY_HANDLE. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeNCryptProviderHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeNCryptProviderHandle.xml index 59ff954b088..e712e5e819c 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeNCryptProviderHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeNCryptProviderHandle.xml @@ -60,7 +60,7 @@ This class should be used when working with native code that expects an NCRYPT_PROV_HANDLE. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeNCryptSecretHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeNCryptSecretHandle.xml index 51a58f6336d..59dd8db07a9 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeNCryptSecretHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeNCryptSecretHandle.xml @@ -60,7 +60,7 @@ This class should be used when working with native code that expects an NCRYPT_SECRET_HANDLE. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafePipeHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafePipeHandle.xml index e79ee91c050..5d546357423 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafePipeHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafePipeHandle.xml @@ -64,7 +64,7 @@ This class is derived from . A value of 0 or -1 is an invalid pipe handle. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeProcessHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeProcessHandle.xml index de124d279db..f991a2136a0 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeProcessHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeProcessHandle.xml @@ -135,7 +135,7 @@ ## Remarks > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeRegistryHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeRegistryHandle.xml index 7e0e9e3fdce..22fced5cc4d 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeRegistryHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeRegistryHandle.xml @@ -46,10 +46,10 @@ object, and then use it to create registry keys with the method. + You can use platform invoke on the native `RegCreateKeyEx` Windows function to obtain a object, and then use it to create registry keys with the method. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. ]]> diff --git a/xml/Microsoft.Win32.SafeHandles/SafeWaitHandle.xml b/xml/Microsoft.Win32.SafeHandles/SafeWaitHandle.xml index aaa599a729f..109863f88a0 100644 --- a/xml/Microsoft.Win32.SafeHandles/SafeWaitHandle.xml +++ b/xml/Microsoft.Win32.SafeHandles/SafeWaitHandle.xml @@ -78,7 +78,7 @@ The class is used by the class. It is a wrapper for Win32 mutexes and auto and manual reset events. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). ## Examples diff --git a/xml/Microsoft.Win32/CommonDialog.xml b/xml/Microsoft.Win32/CommonDialog.xml index 35ff1f8b97a..db69480b764 100644 --- a/xml/Microsoft.Win32/CommonDialog.xml +++ b/xml/Microsoft.Win32/CommonDialog.xml @@ -137,7 +137,7 @@ handles dialog initialization by centering the dialog window, relative to the screen, and to set focus to the default control. + handles dialog initialization by centering the dialog window, relative to the screen, and to set focus to the default control. ]]> @@ -229,7 +229,7 @@ performs initialization tasks for all common dialogs before calling . Since requires an owner window, attempts to assign one in the following order of precedence: + performs initialization tasks for all common dialogs before calling . Since requires an owner window, attempts to assign one in the following order of precedence: - The current application's *active window*. @@ -278,7 +278,7 @@ performs initialization tasks for all common dialogs before calling . + performs initialization tasks for all common dialogs before calling . In the current implementation, the derived classes ( and ) will only return `true` or `false`. @@ -326,7 +326,7 @@ performs initialization tasks for all common dialogs before calling . Additionally, the dialog that is eventually shown is assigned an owner window, which is specified by the `owner` parameter. + performs initialization tasks for all common dialogs before calling . Additionally, the dialog that is eventually shown is assigned an owner window, which is specified by the `owner` parameter. In the current implementation, the derived classes ( and ) will only return `true` or `false`. diff --git a/xml/Microsoft.Win32/FileDialog.xml b/xml/Microsoft.Win32/FileDialog.xml index f65cbaeaea9..dada7e10f44 100644 --- a/xml/Microsoft.Win32/FileDialog.xml +++ b/xml/Microsoft.Win32/FileDialog.xml @@ -267,7 +267,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side ## Remarks The extension string must contain the leading period. For example, set the property to ".txt" to select all text files. - By default, the property attempts to determine the extension to filter the displayed file list from the property. If the extension cannot be determined from the property, will be used instead. + By default, the property attempts to determine the extension to filter the displayed file list from the property. If the extension cannot be determined from the property, will be used instead. @@ -353,7 +353,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side is greater than one) then contains the first selected file name. If no file name is selected, this property contains rather than `null`. + If more than one file name is selected (length of is greater than one) then contains the first selected file name. If no file name is selected, this property contains rather than `null`. ]]> @@ -462,7 +462,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side is either `null` or , all files are displayed, and folders are always displayed. + If is either `null` or , all files are displayed, and folders are always displayed. You can specify a subset of file types to be displayed by setting the property. Each file type can represent a specific type of file, such as the following: @@ -510,7 +510,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side - "*.\*" - The following are complete examples of valid string values: + The following are complete examples of valid string values: - `Word Documents|*.doc` @@ -528,7 +528,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side ![Using the FileDialog.Filter in the Open Dialog Box](~/add/media/filedialogfilterfigure1.png "Using the FileDialog.Filter in the Open Dialog Box") - The user can choose a file type from this list to filter by. By default, the first item in the list (for example, the first file type) is selected when the or is displayed. To specify that another file type to be selected, you set the property before showing the or (by calling ). + The user can choose a file type from this list to filter by. By default, the first item in the list (for example, the first file type) is selected when the or is displayed. To specify that another file type to be selected, you set the property before showing the or (by calling ). @@ -720,9 +720,9 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side raises the event. + raises the event. - A type that derives from may override . The overridden method must call on the base class if needs to be raised. + A type that derives from may override . The overridden method must call on the base class if needs to be raised. ]]> @@ -944,9 +944,9 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side with all path information removed. Removing the paths makes the value appropriate for use in partial trust applications, since it prevents applications from discovering information about the local file system. + This value is the with all path information removed. Removing the paths makes the value appropriate for use in partial trust applications, since it prevents applications from discovering information about the local file system. - If more than one file name is selected (length of is greater than one) then this property contains only the first selected file name. + If more than one file name is selected (length of is greater than one) then this property contains only the first selected file name. See [Safe File Upload from an XBAP Sample](/previous-versions/dotnet/netframework-3.5/aa358504(v=vs.90)). @@ -990,7 +990,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side . + See . ]]> @@ -1028,7 +1028,7 @@ Open and save file dialog boxes have a **Favorite Links** panel on the left side is null or , a default, localized value is used, such as "Save As" or "Open". + If is null or , a default, localized value is used, such as "Save As" or "Open". ]]> diff --git a/xml/Microsoft.Win32/IntranetZoneCredentialPolicy.xml b/xml/Microsoft.Win32/IntranetZoneCredentialPolicy.xml index ba9f2557551..c3801d56d21 100644 --- a/xml/Microsoft.Win32/IntranetZoneCredentialPolicy.xml +++ b/xml/Microsoft.Win32/IntranetZoneCredentialPolicy.xml @@ -29,7 +29,7 @@ > [!NOTE] > policies are invoked only if the or the that is associated with the request has credentials that are not `null`. Setting this policy has no effect on requests that do not specify credentials. - Use the property to set the policy. The that handles authentication for the request will invoke the method before performing the authentication. If the requested resource is in a different domain than the client, the method returns `false`, and authentication is not performed. + Use the property to set the policy. The that handles authentication for the request will invoke the method before performing the authentication. If the requested resource is in a different domain than the client, the method returns `false`, and authentication is not performed. This policy affects all instances of with non-null credentials in the current application domain. The policy cannot be overridden on individual requests. diff --git a/xml/Microsoft.Win32/Registry.xml b/xml/Microsoft.Win32/Registry.xml index 50e429b2c10..902bd0896d2 100644 --- a/xml/Microsoft.Win32/Registry.xml +++ b/xml/Microsoft.Win32/Registry.xml @@ -50,7 +50,7 @@ For more information about this API, see Microsoft.Win32.Registry class. method to create an instance of the particular subkey of interest. You can then use other operations in `RegistryKey` to manipulate that key. +The following code example demonstrates how to retrieve the subkeys of the `HKEY_USERS` key and print their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in `RegistryKey` to manipulate that key. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.Users Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/Overview/source.cs" id="Snippet1"::: @@ -108,7 +108,7 @@ The following code example stores values of several data types in an example key Both conventional applications and OLE applications use data that is stored under this key. This key also provides backward compatibility with the Windows 3.1 registration database by storing information for DDE and OLE support. File viewers and user interface extensions store their OLE class identifiers in this key, and processing servers are registered in this key. ## Examples - The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. + The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.ClassesRoot Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/ClassesRoot/source.cs" id="Snippet1"::: @@ -162,7 +162,7 @@ The following code example stores values of several data types in an example key ## Examples - The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. + The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.CurrentConfig Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/CurrentConfig/source.cs" id="Snippet1"::: @@ -214,7 +214,7 @@ The following code example stores values of several data types in an example key ## Examples - The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. + The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.CurrentUser Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/CurrentUser/source.cs" id="Snippet1"::: @@ -322,12 +322,12 @@ The following code example stores values of several data types in an example key Valid root names are HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT, HKEY_USERS, HKEY_PERFORMANCE_DATA, HKEY_CURRENT_CONFIG, and HKEY_DYN_DATA. For example, in Visual Basic the string "HKEY_CURRENT_USER\MyTestKey" accesses key/value pairs for the subkey "MyTestKey" in the HKEY_CURRENT_USER root. - When the method retrieves expandable string values (), it expands environment strings using data from the local environment. If a value containing expandable references to environment variables has been stored as a string (), rather than as an expandable string (), does not expand it. You can expand such a string after it has been retrieved by calling the method. + When the method retrieves expandable string values (), it expands environment strings using data from the local environment. If a value containing expandable references to environment variables has been stored as a string (), rather than as an expandable string (), does not expand it. You can expand such a string after it has been retrieved by calling the method. > [!NOTE] -> The recommended way to retrieve data from HKEY_PERFORMANCE_DATA is to use the class rather than the method. +> The recommended way to retrieve data from HKEY_PERFORMANCE_DATA is to use the class rather than the method. - The and methods open and close registry keys each time they are used, so they do not perform as well as the methods of the class if you access a large number of values. + The and methods open and close registry keys each time they are used, so they do not perform as well as the methods of the class if you access a large number of values. also provides methods that allow you to add an access control list (ACL) to a registry key, to test the data type of a value before retrieving it, and to delete keys. @@ -405,7 +405,7 @@ The following code example stores values of several data types in an example key ## Examples - The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. + The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.LocalMachine Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/LocalMachine/source.cs" id="Snippet1"::: @@ -456,9 +456,9 @@ The following code example stores values of several data types in an example key Although you use the registry to collect performance data, the data is not stored in the registry database. Instead, accessing the registry with this key causes the system to collect the data from the appropriate system object managers. - To obtain performance data from the local system, use the method, with the Registry.PerformanceData key. The first call opens the key (you do not need to explicitly open the key first). However, be sure to use the method to close the handle to the key when you are finished obtaining performance data. The user cannot install or remove a software component while its performance data is in use. + To obtain performance data from the local system, use the method, with the Registry.PerformanceData key. The first call opens the key (you do not need to explicitly open the key first). However, be sure to use the method to close the handle to the key when you are finished obtaining performance data. The user cannot install or remove a software component while its performance data is in use. - To obtain performance data from a remote system, you must use the method, with the computer name of the remote system and the Registry.PerformanceData key. This call retrieves a key representing the performance data for the remote system. To retrieve the data, call using this key, rather than the Registry.PerformanceData key. + To obtain performance data from a remote system, you must use the method, with the computer name of the remote system and the Registry.PerformanceData key. This call retrieves a key representing the performance data for the remote system. To retrieve the data, call using this key, rather than the Registry.PerformanceData key. > [!NOTE] > On Windows Server 2003, a user must at least belong to the Performance Monitor Users group in order to access subkeys of this base key. @@ -466,7 +466,7 @@ The following code example stores values of several data types in an example key ## Examples - The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. Note that this example can often return no results, since there might be no performance data. + The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. Note that this example can often return no results, since there might be no performance data. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.PerformanceData Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/PerformanceData/source.cs" id="Snippet1"::: @@ -569,13 +569,13 @@ The following code example stores values of several data types in an example key Valid root names include HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT, HKEY_USERS, HKEY_PERFORMANCE_DATA, HKEY_CURRENT_CONFIG, and HKEY_DYN_DATA. > [!NOTE] -> The method opens a registry key, sets the value, and closes the key each time it is called. If you need to modify a large number of values, the method might provide better performance. The class also provides methods that allow you to add an access control list (ACL) to a registry key, to test the data type of a value before retrieving it, and to delete keys. +> The method opens a registry key, sets the value, and closes the key each time it is called. If you need to modify a large number of values, the method might provide better performance. The class also provides methods that allow you to add an access control list (ACL) to a registry key, to test the data type of a value before retrieving it, and to delete keys. - This overload of stores 64-bit integers as strings (). To store 64-bit numbers as values, use the method overload. + This overload of stores 64-bit integers as strings (). To store 64-bit numbers as values, use the method overload. - This overload of stores all string values as objects, even if they contain expandable references to environment variables. To save string values as expandable strings (), use the method overload. + This overload of stores all string values as objects, even if they contain expandable references to environment variables. To save string values as expandable strings (), use the method overload. - This overload is equivalent to calling the method overload with . + This overload is equivalent to calling the method overload with . ## Examples The following code example stores values of several data types in an example key, creating the key as it does so, and then retrieves and displays the values. The example demonstrates storing and retrieving the default (nameless) name/value pair, and the use of `defaultValue` when a name/value pair does not exist. @@ -589,10 +589,10 @@ The following code example stores values of several data types in an example key is . - does not begin with a valid registry root. - - -or- - + does not begin with a valid registry root. + + -or- + is longer than the maximum length allowed (255 characters). The is read-only, and thus cannot be written to; for example, it is a root-level node. The user does not have the permissions required to create or modify registry keys. @@ -672,7 +672,7 @@ The following code example stores values of several data types in an example key Valid root names include HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT, HKEY_USERS, HKEY_PERFORMANCE_DATA, HKEY_CURRENT_CONFIG, and HKEY_DYN_DATA. > [!NOTE] -> The method opens a registry key, sets the value, and closes the key each time it is called. If you need to modify a large number of values, the method might provide better performance. The class also provides methods that allow you to add an access control list (ACL) to a registry key, to test the data type of a value before retrieving it, and to delete keys. +> The method opens a registry key, sets the value, and closes the key each time it is called. If you need to modify a large number of values, the method might provide better performance. The class also provides methods that allow you to add an access control list (ACL) to a registry key, to test the data type of a value before retrieving it, and to delete keys. If the type of the specified `value` does not match the specified `valueKind`, and the data cannot be converted, is thrown. For example, you can store a as a , but only if its value is less than the maximum value of a . You cannot store a single string value as a . @@ -691,14 +691,14 @@ The following code example stores values of several data types in an example key is . - does not begin with a valid registry root. - - -or- - - is longer than the maximum length allowed (255 characters). - - -or- - + does not begin with a valid registry root. + + -or- + + is longer than the maximum length allowed (255 characters). + + -or- + The type of did not match the registry data type specified by , therefore the data could not be converted properly. The is read-only, and thus cannot be written to; for example, it is a root-level node, or the key has not been opened with write access. The user does not have the permissions required to create or modify registry keys. @@ -744,7 +744,7 @@ The following code example stores values of several data types in an example key This key contains a branch for each user of the computer. The default configuration is supplied for new users on the local computer and for the default current user if the user has not changed preferences. ## Examples - The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. + The following example demonstrates how to retrieve the subkeys of this key, and prints their names to the screen. Use the method to create an instance of the particular subkey of interest. You can then use other operations in to manipulate that key. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Registry.Users Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/Registry/Overview/source.cs" id="Snippet1"::: diff --git a/xml/Microsoft.Win32/RegistryHive.xml b/xml/Microsoft.Win32/RegistryHive.xml index cc847121337..d67e30288fa 100644 --- a/xml/Microsoft.Win32/RegistryHive.xml +++ b/xml/Microsoft.Win32/RegistryHive.xml @@ -43,20 +43,20 @@ Represents the possible values for a top-level node on a foreign machine. - method to represent the top-level node of a requested key on a foreign (remote) machine. The node that can be opened with the OpenRemoteBaseKey method must be one of these top-level `RegistryKeys`. Further access to the subkeys of the identified node is available using methods in , so long as the user has appropriate permission. - - - -## Examples - The following code example shows how to open a registry key on a remote computer and enumerate the values of the key. The remote computer must be running the remote registry service. Specify the name of the remote computer as a command-line argument when invoking the program. - + method to represent the top-level node of a requested key on a foreign (remote) machine. The node that can be opened with the OpenRemoteBaseKey method must be one of these top-level `RegistryKeys`. Further access to the subkeys of the identified node is available using methods in , so long as the user has appropriate permission. + + + +## Examples + The following code example shows how to open a registry key on a remote computer and enumerate the values of the key. The remote computer must be running the remote registry service. Specify the name of the remote computer as a command-line argument when invoking the program. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryKey.OpenRemoteBaseKey/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryHive/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/Microsoft.Win32/RegistryHive/Overview/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/Microsoft.Win32/RegistryHive/Overview/source.vb" id="Snippet1"::: + ]]> diff --git a/xml/Microsoft.Win32/RegistryKey.xml b/xml/Microsoft.Win32/RegistryKey.xml index 1408ad2c9df..b3ea8281cb2 100644 --- a/xml/Microsoft.Win32/RegistryKey.xml +++ b/xml/Microsoft.Win32/RegistryKey.xml @@ -61,7 +61,7 @@ The registry acts as a central repository of information for the operating system and the applications on a computer. The registry is organized in a hierarchical format, based on a logical ordering of the elements stored within it (please see for the base-level items in this hierarchy). When storing information in the registry, select the appropriate location based on the type of information being stored. Be sure to avoid destroying information created by other applications, because this can cause those applications to exhibit unexpected behavior, and can also have an adverse effect upon your own application. > [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. Registry keys are the base unit of organization in the registry, and can be compared to folders in File Explorer. A particular key can have subkeys, just as a folder can have subfolders. Each key can be deleted, as long as the user has the appropriate permissions to do so, and the key is not a base key or at the level directly under the base keys. Each key can also have multiple values associated with it (a value can be compared to a file), which are used to store the information - for example, information about an application installed on the computer. Each value holds one particular piece of information, which can be retrieved or updated when required. For instance, you can create a for your company, under the key HKEY_LOCAL_MACHINE\Software, and then a subkey for each application that your company creates. Each subkey holds the information specific to that application, such as color settings, screen location and size, or recognized file extensions. @@ -274,7 +274,7 @@ > [!CAUTION] > Do not expose objects in such a way that a malicious program could create thousands of meaningless subkeys or key/value pairs. For example, do not allow callers to enter arbitrary keys or values. - In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. ]]> @@ -348,7 +348,7 @@ > [!CAUTION] > Do not expose objects in such a way that a malicious program could create thousands of meaningless subkeys or key/value pairs. For example, do not allow callers to enter arbitrary keys or values. - In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. ]]> @@ -420,7 +420,7 @@ method creates a registry key that has the access control specified by the `registrySecurity` parameter. The object that is returned represents the registry key, but that object is not restricted by the access control specified in the `registrySecurity` parameter. + The method creates a registry key that has the access control specified by the `registrySecurity` parameter. The object that is returned represents the registry key, but that object is not restricted by the access control specified in the `registrySecurity` parameter. If `permissionCheck` is , the key is opened for read/write access. If `permissionCheck` is , the key is opened for read access. @@ -431,7 +431,7 @@ > [!CAUTION] > Do not expose objects in such a way that a malicious program could create thousands of meaningless subkeys or key/value pairs. For example, do not allow callers to enter arbitrary keys or values. - In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. ]]> @@ -507,7 +507,7 @@ > [!CAUTION] > Do not expose objects in such a way that a malicious program could create thousands of meaningless subkeys or key/value pairs. For example, do not allow callers to enter arbitrary keys or values. - In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. ]]> @@ -719,14 +719,14 @@ . + To delete child subkeys, use . Use caution when deleting registry keys. ## Examples - The following example demonstrates how to use . + The following example demonstrates how to use . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryKey2/CPP/source2.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/Overview/source2.cs" id="Snippet5"::: @@ -796,7 +796,7 @@ . + To delete child subkeys, use . Use caution when deleting registry keys. @@ -876,7 +876,7 @@ You must have appropriate permissions to delete the subkey and its tree. > [!CAUTION] -> Deleting a particular key will remove all entries below the key in the tree. No warning will be provided. If you want to delete a subkey only when it has no child subkeys, use the method. +> Deleting a particular key will remove all entries below the key in the tree. No warning will be provided. If you want to delete a subkey only when it has no child subkeys, use the method. @@ -1232,7 +1232,7 @@ ## Remarks It is not necessary to call `Flush` to write out changes to a key. Registry changes are flushed to disk when the registry uses its lazy flusher. Lazy flushing occurs automatically and regularly after a system-specified time interval. Registry changes are also flushed to disk at system shutdown. - Unlike , the `Flush` function returns only when all the data has been written to the registry. + Unlike , the `Flush` function returns only when all the data has been written to the registry. The `Flush` function might also write out parts of or all of the other keys. Calling this function excessively can have a negative effect on an application's performance. @@ -1422,7 +1422,7 @@ method overload with the bitwise combination of the following flags: , , and . You can use that overload to search for other permissions. + This method overload is equivalent to calling the method overload with the bitwise combination of the following flags: , , and . You can use that overload to search for other permissions. The user must have rights to call this method. @@ -1617,20 +1617,20 @@ > [!NOTE] > A registry key can have one value that is not associated with any name. When this unnamed value is displayed in the registry editor, the string "(Default)" appears instead of a name. To retrieve this unnamed value, specify either `null` or the empty string ("") for `name`. - When the method retrieves expandable string values (), it expands environment strings using data from the local environment. To retrieve expandable string values from the registry on a remote computer, use the method overload to specify that you do not want environment strings expanded. + When the method retrieves expandable string values (), it expands environment strings using data from the local environment. To retrieve expandable string values from the registry on a remote computer, use the method overload to specify that you do not want environment strings expanded. > [!NOTE] -> If a value containing expandable references to environment variables has been stored as a string (), rather than as an expandable string (), does not expand it. You can expand such a string after it has been retrieved by calling the method. +> If a value containing expandable references to environment variables has been stored as a string (), rather than as an expandable string (), does not expand it. You can expand such a string after it has been retrieved by calling the method. > [!NOTE] -> The recommended way to retrieve data from the key is to use the class rather than the method. +> The recommended way to retrieve data from the key is to use the class rather than the method. > -> does not support reading values of type REG_NONE or REG_LINK. In both cases, the default value (`null`) is returned instead of the actual value. +> does not support reading values of type REG_NONE or REG_LINK. In both cases, the default value (`null`) is returned instead of the actual value. ## Examples - The following code example creates a test key and adds values of different data types to the key. The example then reads the name/value pairs and displays them to the console, using the method to retrieve the corresponding registry data types. + The following code example creates a test key and adds values of different data types to the key. The example then reads the name/value pairs and displays them to the console, using the method to retrieve the corresponding registry data types. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryValueKind/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/GetValue/source2.cs" id="Snippet1"::: @@ -1706,25 +1706,25 @@ to handle the case where a name does not exist yet - for example, the first time your application is run. Whenever you call this overload, use the `defaultValue` parameter to specify the value to return if `name` does not exist. + Use this overload of to handle the case where a name does not exist yet - for example, the first time your application is run. Whenever you call this overload, use the `defaultValue` parameter to specify the value to return if `name` does not exist. > [!NOTE] > A registry key can have one value that is not associated with any name. When this unnamed value is displayed in the registry editor, the string "(Default)" appears instead of a name. To retrieve this unnamed value, specify either `null` or the empty string ("") for `name`. - When the method retrieves expandable string values (), it expands environment strings using data from the local environment. To retrieve expandable string values from the registry on a remote computer, use the overload to specify that you do not want environment strings expanded. + When the method retrieves expandable string values (), it expands environment strings using data from the local environment. To retrieve expandable string values from the registry on a remote computer, use the overload to specify that you do not want environment strings expanded. > [!NOTE] -> If a value containing expandable references to environment variables has been stored as a string (), rather than as an expandable string (), the method does not expand it. You can expand such a string after it has been retrieved by calling the method. +> If a value containing expandable references to environment variables has been stored as a string (), rather than as an expandable string (), the method does not expand it. You can expand such a string after it has been retrieved by calling the method. > [!NOTE] -> The recommended way to retrieve data from the key is to use the class rather than the method. +> The recommended way to retrieve data from the key is to use the class rather than the method. > -> does not support reading values of type REG_NONE or REG_LINK. In both cases, the default value (`null`) is returned instead of the actual value. +> does not support reading values of type REG_NONE or REG_LINK. In both cases, the default value (`null`) is returned instead of the actual value. ## Examples - The following code example creates a test key with a value and retrieves that value. The example then attempts to retrieve a nonexistent value from the key; in this case the method returns the specified default value. + The following code example creates a test key with a value and retrieves that value. The example then attempts to retrieve a nonexistent value from the key; in this case the method returns the specified default value. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic RegistryKey.GetValue Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/GetValue/source.cs" id="Snippet1"::: @@ -1812,7 +1812,7 @@ > [!NOTE] > A registry key can have one value that is not associated with any name. When this unnamed value is displayed in the registry editor, the string "(Default)" appears instead of a name. To retrieve this unnamed value, specify either `null` or the empty string ("") for `name`. > -> does not support reading values of type REG_NONE or REG_LINK. In both cases, the default value (`null`) is returned instead of the actual value. +> does not support reading values of type REG_NONE or REG_LINK. In both cases, the default value (`null`) is returned instead of the actual value. @@ -1900,7 +1900,7 @@ ## Examples - The following code example creates a test key and adds values of different data types to the key. The example then reads the name/value pairs and displays them to the console, using the method to retrieve the corresponding registry data types. + The following code example creates a test key and adds values of different data types to the key. The example then reads the name/value pairs and displays them to the console, using the method to retrieve the corresponding registry data types. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryValueKind/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/GetValue/source2.cs" id="Snippet1"::: @@ -1971,7 +1971,7 @@ ## Remarks If no value names for the key are found, an empty array is returned. - A registry key can have a default value - that is, a name/value pair in which the name is the empty string (""). If a default value has been set for a registry key, the array returned by the method includes the empty string. + A registry key can have a default value - that is, a name/value pair in which the name is the empty string (""). If a default value has been set for a registry key, the array returned by the method includes the empty string. @@ -2369,16 +2369,16 @@ method that allows you to specify write access, such as the overload or the overload. + You must open a key before it can be manipulated with other methods and properties. To modify a key, you must open it with an overload of the method that allows you to specify write access, such as the overload or the overload. If the specified subkey cannot be found, then `null` is returned. - In order to use the method, you must have an instance of . To get an instance of , use the one of the static members of the class. + In order to use the method, you must have an instance of . To get an instance of , use the one of the static members of the class. ## Examples - The following code example creates a test key and uses the method to open it, demonstrating both overloads of the method. + The following code example creates a test key and uses the method to open it, demonstrating both overloads of the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/RegistryKey.OpenSubKey/CPP/opensubkey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/OpenSubKey/opensubkey.cs" id="Snippet1"::: @@ -2461,7 +2461,7 @@ If `permissionCheck` is , the key is opened for reading and writing; if `permissionCheck` is or , the key is opened for reading unless the parent key was opened with . - In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. @@ -2549,12 +2549,12 @@ If `writable` is `true`, the key will be opened for reading and writing, otherwise, the key will be opened as read-only. - In order to use the method, you must have an instance of the method. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the method. To get an instance of , use one of the static members of the class. ## Examples - The following code example creates a test key and uses the method to open it, demonstrating both overloads of the method. + The following code example creates a test key and uses the method to open it, demonstrating both overloads of the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/RegistryKey.OpenSubKey/CPP/opensubkey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/OpenSubKey/opensubkey.cs" id="Snippet1"::: @@ -2634,7 +2634,7 @@ method that allows you to specify write access. + You must open a key before it can be manipulated with other methods and properties. To modify a key, you must open it with an overload of the method that allows you to specify write access. ]]> @@ -2710,7 +2710,7 @@ The access specified for `permissionCheck` takes precedence over the access specified for `rights`. For example, if you specify for `permissionCheck` and for `rights`, an attempt to write to the subkey throws an exception. - In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. + In order to use the method, you must have an instance of the class. To get an instance of , use one of the static members of the class. ]]> @@ -2778,10 +2778,10 @@ method to obtain a object representing the existing Windows access control security, modify that object, and then use the method to update security for the key. + To modify permissions for a registry key, use the method to obtain a object representing the existing Windows access control security, modify that object, and then use the method to update security for the key. > [!CAUTION] -> The object specified for `registrySecurity` replaces the existing security for the registry key. To add permissions for a new user, use the method to obtain the existing access control security, and then modify it. +> The object specified for `registrySecurity` replaces the existing security for the registry key. To add permissions for a new user, use the method to obtain the existing access control security, and then modify it. @@ -2871,9 +2871,9 @@ If the specified `name` does not exist in the key, it is created and the associated value is set to `value`. - This overload of stores 64-bit integers as strings (). To store 64-bit numbers as values, use the overload that specifies . + This overload of stores 64-bit integers as strings (). To store 64-bit numbers as values, use the overload that specifies . - This overload of stores all string values as , even if they contain expandable references to environment variables. To save string values as expandable strings (), use the overload that specifies . + This overload of stores all string values as , even if they contain expandable references to environment variables. To save string values as expandable strings (), use the overload that specifies . Numeric types other than 32-bit integers are stored as strings by this method overload. Enumeration elements are stored as strings containing the element names. @@ -2881,7 +2881,7 @@ > Do not expose objects in such a way that a malicious program could create thousands of meaningless subkeys or key/value pairs. For example, do not allow callers to enter arbitrary keys or values. ## Examples - The following code example shows how the method determines the registry data type when it sets values. The example creates a test key and adds values of different data types to the key. The example then reads the name/value pairs and displays them to the console, using the method to display the corresponding registry data types. + The following code example shows how the method determines the registry data type when it sets values. The example creates a test key and adds values of different data types to the key. The example then reads the name/value pairs and displays them to the console, using the method to display the corresponding registry data types. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryKey.SetValue1/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/SetValue/source.cs" id="Snippet1"::: @@ -2978,7 +2978,7 @@ If the specified `name` does not exist in the key, it is created, and the associated value is set to `value`. > [!NOTE] -> Specifying the registry data type is the same as using the overload. +> Specifying the registry data type is the same as using the overload. If the type of the specified `value` does not match the specified `valueKind`, and the data cannot be converted, is thrown. For example, you can store a as a , but only if its value is less than the maximum value of a . You cannot store a single string value as a . @@ -2989,7 +2989,7 @@ > Do not expose objects in such a way that a malicious program could create thousands of meaningless subkeys or key/value pairs. For example, do not allow callers to enter arbitrary keys or values. ## Examples - The following code example creates a test key and uses the method to store several values, specifying the registry data type for each value. The example then reads the name/value pairs and displays them to the console, using the method to display the corresponding registry data types. + The following code example creates a test key and uses the method to store several values, specifying the registry data type for each value. The example then reads the name/value pairs and displays them to the console, using the method to display the corresponding registry data types. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryValueKind/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/GetValue/source2.cs" id="Snippet1"::: @@ -3107,7 +3107,7 @@ . +This method has the same effect as calling . ]]> @@ -3219,7 +3219,7 @@ This method has the same effect as calling method and specifying either `null` or the empty string ("") for `name`. If the default value has never been set, it does not contribute to the total count returned by the property; once it has been set, however, it is always counted. + Each registry key has a default value that is not associated with any name. This unnamed value can be set by using the method and specifying either `null` or the empty string ("") for `name`. If the default value has never been set, it does not contribute to the total count returned by the property; once it has been set, however, it is always counted. diff --git a/xml/Microsoft.Win32/RegistryOptions.xml b/xml/Microsoft.Win32/RegistryOptions.xml index e3cf6cc9ff5..8b5fb1c33f2 100644 --- a/xml/Microsoft.Win32/RegistryOptions.xml +++ b/xml/Microsoft.Win32/RegistryOptions.xml @@ -36,11 +36,11 @@ Specifies options to use when creating a registry key. - method overloads that take an `options` parameter. - + method overloads that take an `options` parameter. + ]]> diff --git a/xml/Microsoft.Win32/RegistryValueKind.xml b/xml/Microsoft.Win32/RegistryValueKind.xml index d6de7fddf9b..ca83ebd1a79 100644 --- a/xml/Microsoft.Win32/RegistryValueKind.xml +++ b/xml/Microsoft.Win32/RegistryValueKind.xml @@ -37,22 +37,22 @@ Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry. - enumeration defines the set of supported registry data types and the value that is used for unsupported types (Unknown). Starting in the .NET Framework 4, you can specify not to use a data type with the None value. - - Use the method to determine the data type of a registry key value before retrieving the value. When you set a registry key value, use the method to specify the registry data type explicitly. - - - -## Examples - The following code example creates a registry key and sets several values for that key, using to specify the registry data types. The example then uses to check the registry data types, in order to retrieve the values and display them. - + enumeration defines the set of supported registry data types and the value that is used for unsupported types (Unknown). Starting in the .NET Framework 4, you can specify not to use a data type with the None value. + + Use the method to determine the data type of a registry key value before retrieving the value. When you set a registry key value, use the method to specify the registry data type explicitly. + + + +## Examples + The following code example creates a registry key and sets several values for that key, using to specify the registry data types. The example then uses to check the registry data types, in order to retrieve the values and display them. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Microsoft.Win32.RegistryValueKind/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/GetValue/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/Microsoft.Win32/RegistryKey/GetValue/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/Microsoft.Win32/RegistryKey/GetValue/source.vb" id="Snippet1"::: + ]]> diff --git a/xml/Microsoft.Win32/RegistryValueOptions.xml b/xml/Microsoft.Win32/RegistryValueOptions.xml index 25627e5d51c..c7a0448609e 100644 --- a/xml/Microsoft.Win32/RegistryValueOptions.xml +++ b/xml/Microsoft.Win32/RegistryValueOptions.xml @@ -37,20 +37,20 @@ Specifies optional behavior when retrieving name/value pairs from a registry key. - method overload. - - - -## Examples - The following code sample creates a test key, adds a value with an embedded environment variable, and retrieves the value in both expanded and unexpanded forms. - + method overload. + + + +## Examples + The following code sample creates a test key, adds a value with an embedded environment variable, and retrieves the value in both expanded and unexpanded forms. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/RegistryValueOptions/CPP/RegistryValueOptions.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/Microsoft.Win32/RegistryKey/GetValue/source1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/Microsoft.Win32/RegistryKey/GetValue/source1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/Microsoft.Win32/RegistryKey/GetValue/source1.vb" id="Snippet1"::: + ]]> diff --git a/xml/Microsoft.Win32/RegistryView.xml b/xml/Microsoft.Win32/RegistryView.xml index 5ad4621c6db..7f4e5f2a327 100644 --- a/xml/Microsoft.Win32/RegistryView.xml +++ b/xml/Microsoft.Win32/RegistryView.xml @@ -34,7 +34,7 @@ On the 64-bit version of Windows, portions of the registry are stored separately for 32-bit and 64-bit applications. There is a 32-bit view for 32-bit applications and a 64-bit view for 64-bit applications. -You can specify a registry view when you use the , , and methods on a object. +You can specify a registry view when you use the , , and methods on a object. If you request a 64-bit view on a 32-bit operating system, the returned keys will be in the 32-bit view. diff --git a/xml/Microsoft.Win32/SystemEvents.xml b/xml/Microsoft.Win32/SystemEvents.xml index 9a56e5783cf..b83af17810a 100644 --- a/xml/Microsoft.Win32/SystemEvents.xml +++ b/xml/Microsoft.Win32/SystemEvents.xml @@ -45,7 +45,7 @@ ## Remarks The class provides the ability to respond to specific types of system events. - When a system event is raised, any delegates attached to the event are called using the thread that monitors for system events. Therefore, you should make any calls from your event handlers thread-safe. If you need to call a system event that is not exposed as a member of this class, you can use the method. + When a system event is raised, any delegates attached to the event are called using the thread that monitors for system events. Therefore, you should make any calls from your event handlers thread-safe. If you need to call a system event that is not exposed as a member of this class, you can use the method. > [!CAUTION] > Do not perform time-consuming processing on the thread that raises a system event handler because it might prevent other applications from functioning. diff --git a/xml/Microsoft.Windows.Themes/BulletChrome.xml b/xml/Microsoft.Windows.Themes/BulletChrome.xml index c5ca5bbc2b4..7e82dd8b155 100644 --- a/xml/Microsoft.Windows.Themes/BulletChrome.xml +++ b/xml/Microsoft.Windows.Themes/BulletChrome.xml @@ -63,7 +63,7 @@ is dependent on which theme is active on the user's system. The properties of this class allow WPF to set the appearance based on the current theme. + The actual appearance of the is dependent on which theme is active on the user's system. The properties of this class allow WPF to set the appearance based on the current theme. In XAML usage, a object element can also have child content, which can be a single that sets the property. @@ -222,7 +222,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -363,7 +363,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -482,7 +482,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -594,9 +594,9 @@ is a or . + This property only applies when the is a or . - If the object used for the bullet supports an `IsThreeState` property, and the value of that property is `true`, then a value of `null` is potentially user-settable. Otherwise, the value of cannot be set to `null` by user action, but it can be set that way in markup or code. + If the object used for the bullet supports an `IsThreeState` property, and the value of that property is `true`, then a value of `null` is potentially user-settable. Otherwise, the value of cannot be set to `null` by user action, but it can be set that way in markup or code. ## Dependency Property Information @@ -604,7 +604,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`| (however, this property might not be set in all themes)| +|Metadata properties set to `true`| (however, this property might not be set in all themes)| ## XAML Attribute Usage @@ -760,7 +760,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1037,7 +1037,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`| (however, this property might not be set in all themes)| +|Metadata properties set to `true`| (however, this property might not be set in all themes)| ]]> @@ -1179,7 +1179,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`| (however, this property might not be set in all themes)| +|Metadata properties set to `true`| (however, this property might not be set in all themes)| ]]> diff --git a/xml/Microsoft.Windows.Themes/ButtonChrome.xml b/xml/Microsoft.Windows.Themes/ButtonChrome.xml index 5e6fb6a8407..be2e49fdc41 100644 --- a/xml/Microsoft.Windows.Themes/ButtonChrome.xml +++ b/xml/Microsoft.Windows.Themes/ButtonChrome.xml @@ -265,7 +265,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -382,7 +382,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -501,7 +501,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -756,7 +756,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`| (however, this property might not be set in all themes)| +|Metadata properties set to `true`| (however, this property might not be set in all themes)| ]]> @@ -898,7 +898,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`| (however, this property might not be set in all themes)| +|Metadata properties set to `true`| (however, this property might not be set in all themes)| ]]> @@ -1040,7 +1040,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`| (however, this property might not be set in all themes)| +|Metadata properties set to `true`| (however, this property might not be set in all themes)| ]]> @@ -1159,7 +1159,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1242,7 +1242,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/Microsoft.Windows.Themes/ClassicBorderDecorator.xml b/xml/Microsoft.Windows.Themes/ClassicBorderDecorator.xml index ee7b37f68d3..db47cf65c09 100644 --- a/xml/Microsoft.Windows.Themes/ClassicBorderDecorator.xml +++ b/xml/Microsoft.Windows.Themes/ClassicBorderDecorator.xml @@ -28,7 +28,7 @@ as the . Any other brush will remove the Classic look and render a border of , except in the case of elements, which always render in the Classic look. + To achieve the Classic look, specify as the . Any other brush will remove the Classic look and render a border of , except in the case of elements, which always render in the Classic look. ## XAML Object Element Usage @@ -152,7 +152,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -223,7 +223,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -287,7 +287,7 @@ as the . Any other brush will remove the Classic look and render a border of , except in the case of elements, which always render in the Classic look. + To achieve the Classic look, specify as the . Any other brush will remove the Classic look and render a border of , except in the case of elements, which always render in the Classic look. ## Dependency Property Information @@ -295,7 +295,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -366,7 +366,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -430,7 +430,7 @@ to draw the border according to the . If is not set to , a flat style is drawn. + This brush is used to tell to draw the border according to the . If is not set to , a flat style is drawn. ## XAML Attribute Usage diff --git a/xml/Microsoft.Windows.Themes/DataGridHeaderBorder.xml b/xml/Microsoft.Windows.Themes/DataGridHeaderBorder.xml index f682ab03b86..ae251ca72c5 100644 --- a/xml/Microsoft.Windows.Themes/DataGridHeaderBorder.xml +++ b/xml/Microsoft.Windows.Themes/DataGridHeaderBorder.xml @@ -82,7 +82,7 @@ or properties are set on the , the rendering reverts back to the default implementation. + If the or properties are set on the , the rendering reverts back to the default implementation. ## XAML Object Element Usage @@ -362,7 +362,7 @@ is `false`, the hover look will not be applied even when is `true`. + If is `false`, the hover look will not be applied even when is `true`. ]]> diff --git a/xml/Microsoft.Windows.Themes/ListBoxChrome.xml b/xml/Microsoft.Windows.Themes/ListBoxChrome.xml index 49239640140..8cf9be82270 100644 --- a/xml/Microsoft.Windows.Themes/ListBoxChrome.xml +++ b/xml/Microsoft.Windows.Themes/ListBoxChrome.xml @@ -195,7 +195,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -288,7 +288,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -381,7 +381,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> diff --git a/xml/Microsoft.Windows.Themes/ScrollChrome.xml b/xml/Microsoft.Windows.Themes/ScrollChrome.xml index 01c78e33877..2d06b6bf9cf 100644 --- a/xml/Microsoft.Windows.Themes/ScrollChrome.xml +++ b/xml/Microsoft.Windows.Themes/ScrollChrome.xml @@ -377,7 +377,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -630,7 +630,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -760,7 +760,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -924,7 +924,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1082,7 +1082,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1279,7 +1279,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/Microsoft.Windows.Themes/SystemDropShadowChrome.xml b/xml/Microsoft.Windows.Themes/SystemDropShadowChrome.xml index d39c5e09ba0..f62f74265cb 100644 --- a/xml/Microsoft.Windows.Themes/SystemDropShadowChrome.xml +++ b/xml/Microsoft.Windows.Themes/SystemDropShadowChrome.xml @@ -292,7 +292,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -479,7 +479,7 @@ | Item | Value | |------------------|----------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.IdentityModel.Claims/Claim.xml b/xml/System.IdentityModel.Claims/Claim.xml index 111a40e97e2..05ce82faa64 100644 --- a/xml/System.IdentityModel.Claims/Claim.xml +++ b/xml/System.IdentityModel.Claims/Claim.xml @@ -867,7 +867,7 @@ method to provide equality comparisons for objects. The comparison consists of three comparisons on the values of the , , and properties. The comparison algorithm that is used on the property depends upon the value of the property. The following table details the comparison algorithm that is used for the specified claim type. + This method overrides the method to provide equality comparisons for objects. The comparison consists of three comparisons on the values of the , , and properties. The comparison algorithm that is used on the property depends upon the value of the property. The following table details the comparison algorithm that is used for the specified claim type. |Claim type|Comparison| |----------------|----------------| @@ -918,7 +918,7 @@ method. + This method generates the same hash code for two objects that are equal according to the method. ]]> diff --git a/xml/System.IdentityModel.Claims/ClaimSet.xml b/xml/System.IdentityModel.Claims/ClaimSet.xml index 65bd584eb93..f0200366a4d 100644 --- a/xml/System.IdentityModel.Claims/ClaimSet.xml +++ b/xml/System.IdentityModel.Claims/ClaimSet.xml @@ -58,7 +58,7 @@ ## Remarks After the class has been created, it cannot be changed. - Examining the content of a for particular types of claims is a common task when using claim-based authorization. To examine a for the presence of particular claims, use the method. The method provides better performance than iterating directly over the . + Examining the content of a for particular types of claims is a common task when using claim-based authorization. To examine a for the presence of particular claims, use the method. The method provides better performance than iterating directly over the . @@ -156,7 +156,7 @@ method. + To find the specified claim, call the method. ]]> @@ -204,7 +204,7 @@ method. + To find the specified claim, call the method. ]]> @@ -292,7 +292,7 @@ contains the claim without returning the claim, call the method. + To determine if this contains the claim without returning the claim, call the method. diff --git a/xml/System.IdentityModel.Claims/ClaimTypes.xml b/xml/System.IdentityModel.Claims/ClaimTypes.xml index 7ede3f2fdff..2a822434be3 100644 --- a/xml/System.IdentityModel.Claims/ClaimTypes.xml +++ b/xml/System.IdentityModel.Claims/ClaimTypes.xml @@ -34,17 +34,17 @@ Represents the pre-defined types of claims that an entity can claim. This class cannot be inherited. - class to search for a particular type of claim in a or to create a claim. To search for a particular type of claim in a , use the method and use the properties of this class to specify the claim type for the `claimType` parameter. When the constructor for the class is used to create a new claim, use the properties of the class to specify the `claimType` parameter. For many of the claim types, the class has static properties that return a claim of a specific type. For instance, the method returns a claim using the claim type. - - - -## Examples + class to search for a particular type of claim in a or to create a claim. To search for a particular type of claim in a , use the method and use the properties of this class to specify the claim type for the `claimType` parameter. When the constructor for the class is used to create a new claim, use the properties of the class to specify the `claimType` parameter. For many of the claim types, the class has static properties that return a claim of a specific type. For instance, the method returns a claim using the claim type. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_claimtypes/cs/service.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_claimtypes/vb/service.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_claimtypes/vb/service.vb" id="Snippet1"::: + ]]> @@ -77,12 +77,12 @@ Gets the URI for a claim that specifies the anonymous user. The URI for a claim that specifies the anonymous user. - @@ -115,11 +115,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies details about whether an identity is authenticated. The URI for a claim that specifies details about whether an identity is authenticated. - @@ -153,11 +153,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies an authorization decision on an entity. The URI for a claim that specifies an authorization decision on an entity. - @@ -191,11 +191,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the country/region in which an entity resides. The URI for a claim that specifies a country/region in which an entity resides. - @@ -228,11 +228,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the date of birth of an entity. The URI for a claim that specifies the date of birth of an entity. - @@ -265,13 +265,13 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a deny-only security identifier (SID) for an entity. The URI for a claim that specifies a deny-only SID for an entity. - @@ -305,11 +305,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the DNS name associated with the computer name or with the alternative name of either the subject or issuer of an X.509 certificate. The URI for a claim that specifies the DNS name associated with the computer name or with the alternative name of either the subject or issuer of an X.509 certificate. - @@ -343,11 +343,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the email address of an entity. The URI for a claim that specifies the email address of an entity. - @@ -381,11 +381,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the gender of an entity. The URI for a claim that specifies the gender of an entity. - @@ -418,11 +418,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the given name of an entity. The URI for a claim that specifies the given name of an entity. - @@ -455,11 +455,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a hash value. The URI for a claim that specifies a hash value. - @@ -493,11 +493,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the home phone number of an entity. The URI for a claim that specifies the home phone number of an entity. - @@ -530,11 +530,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the locale in which an entity resides. The URI for a claim that specifies the locale in which an entity resides. - @@ -567,11 +567,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the mobile phone number of an entity. The URI for a claim that specifies the mobile phone number of an entity. - @@ -604,11 +604,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the name of an entity. The URI for a claim that specifies the name of an entity. - @@ -642,11 +642,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the name of an entity. The URI for a claim that specifies the name of an entity. - @@ -679,11 +679,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the alternative phone number of an entity. The URI for a claim that specifies the alternative phone number of an entity. - @@ -716,11 +716,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the postal code of an entity. The URI for a claim that specifies the postal code of an entity. - @@ -753,11 +753,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the private personal identifier (PPI) of an entity. The URI for a claim that specifies the private personal identifier (PPI) of an entity. - @@ -790,11 +790,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies an RSA key. The URI for a claim that specifies an RSA key. - @@ -828,11 +828,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a security identifier (SID). The URI for a claim that specifies a security identifier (SID). - @@ -866,11 +866,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a service principal name (SPN) claim. The URI for a claim that specifies a service principal name (SPN) claim. - @@ -904,11 +904,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the state or province in which an entity resides. The URI for a claim that specifies the state or province in which an entity resides. - @@ -941,11 +941,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the street address of an entity. The URI for a claim that specifies the street address of an entity. - @@ -978,11 +978,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the surname of an entity. The URI for a claim that specifies the surname of an entity. - @@ -1015,13 +1015,13 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that identifies the system entity. The URI for a claim that identifies the system entity. - is typically used to identify the issuer of a claim when the issuer is the current application. - - The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/system`. - + is typically used to identify the issuer of a claim when the issuer is the current application. + + The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/system`. + ]]> @@ -1054,13 +1054,13 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a thumbprint. The URI for a claim that specifies a thumbprint. - @@ -1094,12 +1094,12 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a user principal name (UPN). The URI for a claim that specifies UPN. - @@ -1133,11 +1133,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies a URI. The URI for a claim that specifies a URI. - @@ -1171,11 +1171,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the URI for a claim that specifies the Web page of an entity. The URI for a claim that specifies the Web page of an entity. - @@ -1208,11 +1208,11 @@ The string returned by this property is `http://schemas.xmlsoap.org/ws/2005/05/i Gets the string that contains the URI for a distinguished name claim of an X.509 certificate. The URI for a distinguished name claim of an X.509 certificate. - diff --git a/xml/System.IdentityModel.Claims/DefaultClaimSet.xml b/xml/System.IdentityModel.Claims/DefaultClaimSet.xml index 1ab0e13d03b..6352d3f0b11 100644 --- a/xml/System.IdentityModel.Claims/DefaultClaimSet.xml +++ b/xml/System.IdentityModel.Claims/DefaultClaimSet.xml @@ -91,7 +91,7 @@ ## Remarks Use this constructor when the is self-issued. For example, a claim set for an anonymous user is self-issued. - This constructor calls the method. + This constructor calls the method. ]]> @@ -139,7 +139,7 @@ ## Remarks Use this constructor when the is self-issued. For example, a claim set for an anonymous user is self-issued. - This constructor calls the method. + This constructor calls the method. ]]> @@ -180,7 +180,7 @@ method. + This constructor calls the method. ]]> @@ -232,7 +232,7 @@ method. + This constructor calls the method. ]]> @@ -280,7 +280,7 @@ method. + To find claims that match a claim type and right, call the method. ]]> @@ -443,7 +443,7 @@ method. + The constructors that take at least one parameter call the method. ]]> @@ -558,7 +558,7 @@ method contains the and properties for every claim in the . + The string returned by method contains the and properties for every claim in the . ]]> diff --git a/xml/System.IdentityModel.Claims/WindowsClaimSet.xml b/xml/System.IdentityModel.Claims/WindowsClaimSet.xml index a8ad238221d..484edae3a88 100644 --- a/xml/System.IdentityModel.Claims/WindowsClaimSet.xml +++ b/xml/System.IdentityModel.Claims/WindowsClaimSet.xml @@ -60,13 +60,13 @@ A that specifies the Windows identity. Initializes a new instance of the class by using the Windows user identity specified by the object. - @@ -98,11 +98,11 @@ to include the claims representing the Windows groups to which this user belongs; otherwise, . Initializes a new instance of the class by using the Windows user identity specified by the object. - @@ -251,14 +251,14 @@ Releases all resources used by the . - method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so that the garbage collector can reclaim the memory that the occupied. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - + method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so that the garbage collector can reclaim the memory that the occupied. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + > [!NOTE] -> Always call the method before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. - +> Always call the method before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. + ]]> @@ -330,11 +330,11 @@ Searches for the claim that matches the specified claim type and rights in the . A object that enables you to enumerate the claims that match the specified criteria. - class to specify the `claimType` parameter. - + class to specify the `claimType` parameter. + ]]> @@ -390,11 +390,11 @@ Gets the issuer for this . A that represents the issuer of this claim set. - is . - + is . + ]]> diff --git a/xml/System.IdentityModel.Claims/X509CertificateClaimSet.xml b/xml/System.IdentityModel.Claims/X509CertificateClaimSet.xml index 80046a57409..c5176cf4126 100644 --- a/xml/System.IdentityModel.Claims/X509CertificateClaimSet.xml +++ b/xml/System.IdentityModel.Claims/X509CertificateClaimSet.xml @@ -131,14 +131,14 @@ Releases all resources used by the . - method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the occupied. - -> [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. - + method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the occupied. + +> [!NOTE] +> Always call before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. + ]]> @@ -279,11 +279,11 @@ Gets the issuer for this . The issuer for this . - follows the same model as the X.509 chain for an X.509 certificate. For instance, the root is self-issued and maps to a Certificate Authority. When a certificate in the chain is unavailable, the root is an anonymous issuer. - + follows the same model as the X.509 chain for an X.509 certificate. For instance, the root is self-issued and maps to a Certificate Authority. When a certificate in the chain is unavailable, the root is an anonymous issuer. + ]]> diff --git a/xml/System.IdentityModel.Configuration/ICustomIdentityConfiguration.xml b/xml/System.IdentityModel.Configuration/ICustomIdentityConfiguration.xml index 9b45719d0b3..abd10a95670 100644 --- a/xml/System.IdentityModel.Configuration/ICustomIdentityConfiguration.xml +++ b/xml/System.IdentityModel.Configuration/ICustomIdentityConfiguration.xml @@ -13,13 +13,13 @@ Defines methods that enable a class to load custom configuration. - interface can load custom configuration from XML. - - Several of the Windows Identity Foundation (WIF) classes implement the interface to provide the capability for you to define custom configuration of derived classes from a configuration file. Many of the WIF classes provide a base implementation of this method to provide the default configuration for the objects they represent. - + interface can load custom configuration from XML. + + Several of the Windows Identity Foundation (WIF) classes implement the interface to provide the capability for you to define custom configuration of derived classes from a configuration file. Many of the WIF classes provide a base implementation of this method to provide the default configuration for the objects they represent. + ]]> @@ -46,11 +46,11 @@ The XML nodes that contain the custom configuration. Each node in the list is of type . Loads custom configuration from XML. Override this method to provide custom handling of configuration elements. - method is called by the configuration infrastructure. When this method is called, the `nodelist` parameter contains the top-level child elements of the parent element that configures the object class from the configuration file. For example, a class derived from , will have the child elements of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element passed in the `nodelist` parameter. The `nodelist` is composed entirely of objects. Each of these may have attributes and child elements depending on the configuration schema defined for the class that is being configured. - + method is called by the configuration infrastructure. When this method is called, the `nodelist` parameter contains the top-level child elements of the parent element that configures the object class from the configuration file. For example, a class derived from , will have the child elements of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element passed in the `nodelist` parameter. The `nodelist` is composed entirely of objects. Each of these may have attributes and child elements depending on the configuration schema defined for the class that is being configured. + ]]> diff --git a/xml/System.IdentityModel.Configuration/IdentityConfiguration.xml b/xml/System.IdentityModel.Configuration/IdentityConfiguration.xml index ed14b99c0ff..170f4a89ac4 100644 --- a/xml/System.IdentityModel.Configuration/IdentityConfiguration.xml +++ b/xml/System.IdentityModel.Configuration/IdentityConfiguration.xml @@ -593,7 +593,7 @@ method to load the token handler configuration. + If there is no configuration file, if the named section does not exist, or if `element` is `null`, then no exception is thrown; instead the instance is loaded with a set of default values. This method calls the method to load the token handler configuration. ]]> @@ -686,7 +686,7 @@ methods to configure the token handlers. + This method calls the methods to configure the token handlers. ]]> diff --git a/xml/System.IdentityModel.Configuration/IdentityConfigurationElementCollection.xml b/xml/System.IdentityModel.Configuration/IdentityConfigurationElementCollection.xml index e090f5983dd..a40c2150add 100644 --- a/xml/System.IdentityModel.Configuration/IdentityConfigurationElementCollection.xml +++ b/xml/System.IdentityModel.Configuration/IdentityConfigurationElementCollection.xml @@ -22,11 +22,11 @@ Represents the collection of elements in a configuration file. This class cannot be inherited. - ` elements. Each identity configuration is identified by a unique name specified in its `name` attribute. Each `` element is represented by an object. The property of each object contains the name of the identity configuration. The class wraps a collection that contains all of the `` elements read from the file. The name of the identity configuration is used as a key to retrieve the corresponding when you call the method. - + ` elements. Each identity configuration is identified by a unique name specified in its `name` attribute. Each `` element is represented by an object. The property of each object contains the name of the identity configuration. The class wraps a collection that contains all of the `` elements read from the file. The name of the identity configuration is used as a key to retrieve the corresponding when you call the method. + ]]> <identityConfiguration> diff --git a/xml/System.IdentityModel.Configuration/SecurityTokenServiceConfiguration.xml b/xml/System.IdentityModel.Configuration/SecurityTokenServiceConfiguration.xml index 827ae993a48..2439f3398cf 100644 --- a/xml/System.IdentityModel.Configuration/SecurityTokenServiceConfiguration.xml +++ b/xml/System.IdentityModel.Configuration/SecurityTokenServiceConfiguration.xml @@ -23,7 +23,7 @@ :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenserviceconfiguration.cs" id="Snippet2"::: - The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. The method initializes an instance of the `PassiveSTS.CustomSecurityTokenService` class using the properties set on the `CustomSecurityTokenServiceConfiguration` class shown in the previous example. + The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. The method initializes an instance of the `PassiveSTS.CustomSecurityTokenService` class using the properties set on the `CustomSecurityTokenServiceConfiguration` class shown in the previous example. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/default.aspx.cs" id="Snippet1"::: @@ -278,7 +278,7 @@ ## Examples The code examples that are used in the topics are taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT) and it includes an implementation of a passive STS that is capable of serving an SWT token. For an example of how to implement an active STS, you can see the `Federation Metadata` sample. For information about these samples and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). The following code shows a custom implementation of the class to support a passive STS that processes SWT tokens. The configuration is initialized and stored in the HTTP application state the first time the static `Current` property is accessed. The constructor initializes the properties of the custom configuration with the type of the custom STS, a custom issuer token resolver, and the default token type (the URI of the SWT token type). It also adds an SWT token handler to the default handler collection. - The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. The method initializes an instance of the `PassiveSTS.CustomSecurityTokenService` class using the properties set on the current `CustomSecurityTokenServiceConfiguration` object. The `CustomSecurityTokenServiceConfiguration.Current` property is implemented by the `CustomSecurityTokenServiceConfiguration` class and returns the instance of the class that is saved in the HTTP application state. + The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. The method initializes an instance of the `PassiveSTS.CustomSecurityTokenService` class using the properties set on the current `CustomSecurityTokenServiceConfiguration` object. The `CustomSecurityTokenServiceConfiguration.Current` property is implemented by the `CustomSecurityTokenServiceConfiguration` class and returns the instance of the class that is saved in the HTTP application state. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/default.aspx.cs" id="Snippet1"::: diff --git a/xml/System.IdentityModel.Metadata/MetadataSerializer.xml b/xml/System.IdentityModel.Metadata/MetadataSerializer.xml index 079ebc33188..82148ba194c 100644 --- a/xml/System.IdentityModel.Metadata/MetadataSerializer.xml +++ b/xml/System.IdentityModel.Metadata/MetadataSerializer.xml @@ -42,11 +42,11 @@ Initializes a new instance of the class with a default token serializer. - and properties are initialized to the following values: , , and . - + and properties are initialized to the following values: , , and . + ]]> @@ -70,11 +70,11 @@ The token serializer that will be used to serialize security tokens. Initializes a new instance of the class that uses the specified token serializer. - and properties are initialized to the following values: , , and . - + and properties are initialized to the following values: , , and . + ]]> @@ -432,11 +432,11 @@ Gets the X.509 certificate created from the specified key identifier. The X.509 certificate that was created from the specified key identifier. - . You can override this method to support other kinds of key identifier clauses. This method is invoked by the method. - + . You can override this method to support other kinds of key identifier clauses. This method is invoked by the method. + ]]> @@ -574,11 +574,11 @@ Reads the <saml:Attribute> element. The Saml2 attribute. - @@ -1013,10 +1013,10 @@ The descriptor. An instance of the or class. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1045,18 +1045,18 @@ Reads an entity descriptor or an entities descriptor. The descriptor. An instance of the or class. - methods. - + methods. + ]]> - is . - - -or- - + is . + + -or- + is . The reader is not positioned on an or an element. @@ -1140,14 +1140,14 @@ Reads role descriptor attributes. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + The property of is . @@ -1178,16 +1178,16 @@ if an element is read; otherwise, . To be added. - is . - - -or- - - is . - - -or- - - The property of is . - + is . + + -or- + + is . + + -or- + + The property of is . + The property of is . @@ -1271,10 +1271,10 @@ Reads SSO descriptor attributes. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1305,10 +1305,10 @@ if an element is read; otherwise, . To be added. - is . - - -or- - + is . + + -or- + is . @@ -1337,10 +1337,10 @@ Reads web service descriptor attributes. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1371,24 +1371,24 @@ if an element is read; otherwise, . To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - - The property of is . - - -or- - - The property of is . - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + + The property of is . + + -or- + + The property of is . + The parameter reader/roleDescriptor/roleDescriptor.TargetScopes/roleDescriptor.TargetScopes/roleDescriptor.TokenTypesOffered is null. @@ -1498,11 +1498,11 @@ The signing certificate. Validates the X.509 certificate that signed the metadata document against the trusted issuers list specified by the property. This method is invoked by the method. - @@ -1558,18 +1558,18 @@ Writes an application service descriptor. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + The property of is . @@ -1598,10 +1598,10 @@ Writes the <saml:Attribute> element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1630,18 +1630,18 @@ Writes a contact person. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + The property of is . @@ -1756,18 +1756,18 @@ Writes an entities descriptor. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + The property of is . @@ -1796,18 +1796,18 @@ Writes an entity descriptor. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + The property of is . @@ -1836,18 +1836,18 @@ Writes an IDPSSO descriptor. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + The property of is . @@ -1878,14 +1878,14 @@ Writes an indexed endpoint. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . @@ -1914,10 +1914,10 @@ Writes a key descriptor. To be added. - is . - - -or- - + is . + + -or- + is . @@ -1948,14 +1948,14 @@ Writes a localized name. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . @@ -1986,14 +1986,14 @@ Writes a localized URI. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . @@ -2031,10 +2031,10 @@ Writes the federation metadata to the specified stream. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2063,10 +2063,10 @@ Writes the federation metadata to the specified XML writer. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2095,10 +2095,10 @@ Writes the metadata. To be added. - is . - - -or- - + is . + + -or- + is . is not assignable from or . @@ -2129,10 +2129,10 @@ Writes an organization. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2163,14 +2163,14 @@ Writes an endpoint. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . @@ -2199,14 +2199,14 @@ Writes role descriptor attributes. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + The property of is . @@ -2235,16 +2235,16 @@ Writes the role descriptor element. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - + is . + + -or- + + is . + + -or- + + The property of is . + The property of is . @@ -2273,18 +2273,18 @@ Writes a security token service descriptor. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + The property of is . @@ -2313,14 +2313,14 @@ Writes an SPSSO descriptor. To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + The property of is . @@ -2349,10 +2349,10 @@ Writes the SSO descriptor attributes. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2381,10 +2381,10 @@ Writes the SSO descriptor element. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2413,10 +2413,10 @@ Writes the web service descriptor attributes. To be added. - is . - - -or- - + is . + + -or- + is . @@ -2445,24 +2445,24 @@ Writes a web service descriptor element. To be added. - is . - - -or- - - is . - - -or- - - The property of is . - - -or- - - The property of is . - - -or- - - The property of is . - + is . + + -or- + + is . + + -or- + + The property of is . + + -or- + + The property of is . + + -or- + + The property of is . + The parameter reader/roleDescriptor/roleDescriptor.TargetScopes/roleDescriptor.TargetScopes/roleDescriptor.TokenTypesOffered is null. diff --git a/xml/System.IdentityModel.Policy/AuthorizationContext.xml b/xml/System.IdentityModel.Policy/AuthorizationContext.xml index 2c80c72daad..c16b7a68e17 100644 --- a/xml/System.IdentityModel.Policy/AuthorizationContext.xml +++ b/xml/System.IdentityModel.Policy/AuthorizationContext.xml @@ -186,7 +186,7 @@ method is typically only used by the infrastructure. + The method is typically only used by the infrastructure. ]]> @@ -315,7 +315,7 @@ to specify the of one or more identities that are related to the . The `Principal` property is used by an to specify the that is associated with an . + Windows Communication Foundation reserves two properties: `Identities` and `Principal`. The `Identities` property is used by an to specify the of one or more identities that are related to the . The `Principal` property is used by an to specify the that is associated with an . ]]> diff --git a/xml/System.IdentityModel.Policy/EvaluationContext.xml b/xml/System.IdentityModel.Policy/EvaluationContext.xml index d5ebfa02266..18d01adba5c 100644 --- a/xml/System.IdentityModel.Policy/EvaluationContext.xml +++ b/xml/System.IdentityModel.Policy/EvaluationContext.xml @@ -39,7 +39,7 @@ ## Remarks Claims are added to an by authorization policies. An authorization policy takes a set of claims, such as those found in a security token, and adds additional claims based on the current set. For instance, an authorization policy might evaluate a claim that contains the date of birth and add a claim that states the user is over 21 years old and add an Over21 claim to the . - Classes that implement the interface do not authorize users, but they enable the class to do so. The calls the method for each authorization policy in effect. The method determines whether additional claims should be added for the user based on the current claims. An authorization policy's method may be called multiple times, as claims are added to the by other authorization policies. When all authorization policies in effect are done, the class makes authorization decisions based upon the final set of claims. The class then creates an that contains an immutable set of claims that reflects these authorization decisions. + Classes that implement the interface do not authorize users, but they enable the class to do so. The calls the method for each authorization policy in effect. The method determines whether additional claims should be added for the user based on the current claims. An authorization policy's method may be called multiple times, as claims are added to the by other authorization policies. When all authorization policies in effect are done, the class makes authorization decisions based upon the final set of claims. The class then creates an that contains an immutable set of claims that reflects these authorization decisions. An evaluation context contains a set of objects: an expiration time, which specifies the span of time during which the evaluation context is valid, and a unique identifier. @@ -111,7 +111,7 @@ ## Remarks The claims are added to the set of claims contained within the property. - Each time the method is called to add claims to the evaluation context, the property should be incremented. + Each time the method is called to add claims to the evaluation context, the property should be incremented. ]]> @@ -148,7 +148,7 @@ method. + To add claims to this collection, for example from an authorization policy, use the method. ]]> @@ -187,7 +187,7 @@ ## Remarks The class uses the property to determine if another evaluation round is required. Each time an authorization policy calls the `AddToTarget` method to add claims to the evaluation context, the property is incremented. - The class examines the property after calling the method on all authorization policies again. If the property has been incremented during evaluation, the class calls the method on any authorization policies that returned `false` the last time the method was called on that authorization policy. + The class examines the property after calling the method on all authorization policies again. If the property has been incremented during evaluation, the class calls the method on any authorization policies that returned `false` the last time the method was called on that authorization policy. ]]> @@ -224,7 +224,7 @@ namespace that implement the interface (authorization policies) add a property named `Identities` to the. collection. The `Identities` property contains an object of type that contains one or more instances that represent identity information that is provided by the authorization policies. + The classes in the namespace that implement the interface (authorization policies) add a property named `Identities` to the. collection. The `Identities` property contains an object of type that contains one or more instances that represent identity information that is provided by the authorization policies. ]]> @@ -264,7 +264,7 @@ method multiple times only has an effect if the `expirationTime` parameter has a value that is earlier than the previously specified value. + Calling the method multiple times only has an effect if the `expirationTime` parameter has a value that is earlier than the previously specified value. ]]> diff --git a/xml/System.IdentityModel.Policy/IAuthorizationPolicy.xml b/xml/System.IdentityModel.Policy/IAuthorizationPolicy.xml index e60278854b4..72fcb1500f4 100644 --- a/xml/System.IdentityModel.Policy/IAuthorizationPolicy.xml +++ b/xml/System.IdentityModel.Policy/IAuthorizationPolicy.xml @@ -56,7 +56,7 @@ ## Remarks Implement the interface to add or map one set of claims to another. An authorization policy examines a set of claims and adds additional claims based on the current set. For example, an authorization policy might evaluate a claim that contains the date of birth and add a claim that asserts that the user is over 21 years old and add an Over21 claim to the . - Classes that implement the interface do not authorize users, but they enable the class to do so. The calls the method for each authorization policy in effect. The method determines whether additional claims should be added for the user, based on the current context. An authorization policy's method may be called multiple times, as claims are added to the by other authorization policies. When all authorization policies in effect are done, the class makes authorization decisions based upon the final set of claims. The class then creates an that contains an immutable set of claims that reflects these authorization decisions. + Classes that implement the interface do not authorize users, but they enable the class to do so. The calls the method for each authorization policy in effect. The method determines whether additional claims should be added for the user, based on the current context. An authorization policy's method may be called multiple times, as claims are added to the by other authorization policies. When all authorization policies in effect are done, the class makes authorization decisions based upon the final set of claims. The class then creates an that contains an immutable set of claims that reflects these authorization decisions. @@ -113,9 +113,9 @@ ## Remarks > [!NOTE] -> Implementers of the interface should expect the method to be called multiple times by different threads. +> Implementers of the interface should expect the method to be called multiple times by different threads. - Implementers of the interface can use the `state` parameter to track state between calls to the method. If a state object is set inside a given call to the method, the same object instance is passed to each and every subsequent call to the method in the current evaluation process. + Implementers of the interface can use the `state` parameter to track state between calls to the method. If a state object is set inside a given call to the method, the same object instance is passed to each and every subsequent call to the method in the current evaluation process. diff --git a/xml/System.IdentityModel.Protocols.WSTrust/EndpointReference.xml b/xml/System.IdentityModel.Protocols.WSTrust/EndpointReference.xml index e40ef38a21f..4004128f3c7 100644 --- a/xml/System.IdentityModel.Protocols.WSTrust/EndpointReference.xml +++ b/xml/System.IdentityModel.Protocols.WSTrust/EndpointReference.xml @@ -76,7 +76,7 @@ method. + The collection contains all of the child elements of the wsa:EndpointReference element except the wsa:Address element. The collection is populated by the method. The property contains the value of the wsa:Address element. @@ -127,7 +127,7 @@ overload topic for details. + See the overload topic for details. ]]> @@ -159,7 +159,7 @@ overload topic for details. + See the overload topic for details. ]]> diff --git a/xml/System.IdentityModel.Protocols.WSTrust/RequestSecurityToken.xml b/xml/System.IdentityModel.Protocols.WSTrust/RequestSecurityToken.xml index 9f6db6a77a3..a50439ff7b5 100644 --- a/xml/System.IdentityModel.Protocols.WSTrust/RequestSecurityToken.xml +++ b/xml/System.IdentityModel.Protocols.WSTrust/RequestSecurityToken.xml @@ -30,7 +30,7 @@ ## Examples The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT) and it includes an implementation of a passive STS that is capable of serving an SWT token. The STS is implemented by a class that is derived from . Many of the methods of the class that are called from its token issuance pipeline take a object as one if their parameters. For information about this sample and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). - The following code example shows an implementation of the method. The method takes a as one of its parameters and properties of this parameter are used to set properties on the object that is returned by the method. + The following code example shows an implementation of the method. The method takes a as one of its parameters and properties of this parameter are used to set properties on the object that is returned by the method. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet5"::: diff --git a/xml/System.IdentityModel.Selectors/AudienceUriMode.xml b/xml/System.IdentityModel.Selectors/AudienceUriMode.xml index 3cee4618de9..bb0305b7b8a 100644 --- a/xml/System.IdentityModel.Selectors/AudienceUriMode.xml +++ b/xml/System.IdentityModel.Selectors/AudienceUriMode.xml @@ -25,7 +25,7 @@ - Specify the set of valid URIs, by adding the URIs to the collection. - Optionally, override the method to specify the validation algorithm to use for the allowed URI. + Optionally, override the method to specify the validation algorithm to use for the allowed URI. ]]> diff --git a/xml/System.IdentityModel.Selectors/CustomUserNameSecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/CustomUserNameSecurityTokenAuthenticator.xml index 601fb2ca812..cdd33bd2436 100644 --- a/xml/System.IdentityModel.Selectors/CustomUserNameSecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/CustomUserNameSecurityTokenAuthenticator.xml @@ -17,13 +17,13 @@ Authenticates a security token using a custom authentication scheme. - class when the Windows authentication provided by the class isn't sufficient. The class authenticates the user name and password in a security token as a Windows account. - - To provide a custom authentication scheme, derive a class from the class, implement the authentication scheme, and then pass that class to the constructor for the class. - + class when the Windows authentication provided by the class isn't sufficient. The class authenticates the user name and password in a security token as a Windows account. + + To provide a custom authentication scheme, derive a class from the class, implement the authentication scheme, and then pass that class to the constructor for the class. + ]]> @@ -48,11 +48,11 @@ A that authenticates the user name and password using a custom authentication scheme. Initializes a new instance of the class using the specified validator. - specified in the `validator` parameter is used by the method to authenticate the user. - + specified in the `validator` parameter is used by the method to authenticate the user. + ]]> @@ -85,17 +85,17 @@ Authenticates the specified user name and password and returns the set of authorization policies for security tokens. A of type that contains the set of authorization policies in effect for this application. - method uses the passed into the constructor to authenticate the user. - - When the username and password cannot be validated, throw the . - - When there are no authorization policies in effect for this application, return an empty of type . - - When the method returns `null`, Windows Communication Foundation throws a . - + method uses the passed into the constructor to authenticate the user. + + When the username and password cannot be validated, throw the . + + When there are no authorization policies in effect for this application, return an empty of type . + + When the method returns `null`, Windows Communication Foundation throws a . + ]]> diff --git a/xml/System.IdentityModel.Selectors/KerberosSecurityTokenProvider.xml b/xml/System.IdentityModel.Selectors/KerberosSecurityTokenProvider.xml index e6ea317c7af..c65c393058c 100644 --- a/xml/System.IdentityModel.Selectors/KerberosSecurityTokenProvider.xml +++ b/xml/System.IdentityModel.Selectors/KerberosSecurityTokenProvider.xml @@ -30,7 +30,7 @@ class doesn't need to be called directly, as it is called when a client sends a SOAP message that requires a security token. Specifically, a client specifies the type of security token needed using the class and the class calls the method to get a security token. When the security token needed is a security token, the method calls the method. + In most instances the class doesn't need to be called directly, as it is called when a client sends a SOAP message that requires a security token. Specifically, a client specifies the type of security token needed using the class and the class calls the method to get a security token. When the security token needed is a security token, the method calls the method. ]]> @@ -203,9 +203,9 @@ method is called by the class when a client sends a SOAP message and a security token is needed. + The method is called by the class when a client sends a SOAP message and a security token is needed. - The method calls the method. + The method calls the method. ]]> @@ -242,7 +242,7 @@ property is `null` and the method is called, the current context of the calling thread () is used as a client identity. + When the value of the property is `null` and the method is called, the current context of the calling thread () is used as a client identity. ]]> diff --git a/xml/System.IdentityModel.Selectors/RsaSecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/RsaSecurityTokenAuthenticator.xml index 18f5c1160d2..34257d2bf4d 100644 --- a/xml/System.IdentityModel.Selectors/RsaSecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/RsaSecurityTokenAuthenticator.xml @@ -91,7 +91,7 @@ method is called on the authorization policy that is returned from this method, a claim of type is added to the property of the that is passed into the method. + When the method is called on the authorization policy that is returned from this method, a claim of type is added to the property of the that is passed into the method. ]]> diff --git a/xml/System.IdentityModel.Selectors/SamlSecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/SamlSecurityTokenAuthenticator.xml index f9837fe0567..80bb2f9e4ba 100644 --- a/xml/System.IdentityModel.Selectors/SamlSecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/SamlSecurityTokenAuthenticator.xml @@ -110,7 +110,7 @@ - Specify the set of valid URIs, by adding the URIs to the collection. -- Optionally, override the method to specify the validation algorithm to use for the allowed URI. +- Optionally, override the method to specify the validation algorithm to use for the allowed URI. ]]> @@ -148,7 +148,7 @@ > [!NOTE] > When the property is set to , an incoming non-endorsing must contain a and the collection must contain a URI that matches one of the valid URIs specified in the collection. A non-endorsing or bearer token is a security token that is included in the message and not used to sign any part of the message. -- Optionally, override the method to specify the validation algorithm to use for the allowed URI. +- Optionally, override the method to specify the validation algorithm to use for the allowed URI. ]]> @@ -182,7 +182,7 @@ method does not authenticate the security token; that is performed by the method. + The method does not authenticate the security token; that is performed by the method. ]]> @@ -345,7 +345,7 @@ method is called by the method when the property is set to or . + The method is called by the method when the property is set to or . ]]> diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/SecurityTokenAuthenticator.xml index 9f959b6441c..ab571587bb8 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenAuthenticator.xml @@ -44,7 +44,7 @@ ## Remarks The class and the classes that derive from it authenticate security tokens. Typically, you would only derive a class directly from when you create a custom security token. If you wanted to override the default authentication or authorization behaviors for built-in security tokens, derive from one of the classes that derive from , such as . - When you derive a class from , override the following two methods: and . The method determines whether this security token authenticator can authenticate a specific security token. The method authenticates the security token and establishes a set of authorization policies for authorization. The authorization policies map the claims found in the security token to claims required by the application. + When you derive a class from , override the following two methods: and . The method determines whether this security token authenticator can authenticate a specific security token. The method authenticates the security token and establishes a set of authorization policies for authorization. The authorization policies map the claims found in the security token to claims required by the application. ]]> @@ -113,7 +113,7 @@ method checks whether the token parameter is `null` and then calls the method to determine whether this security token authenticator can authenticate the security token type for `token`. + The method checks whether the token parameter is `null` and then calls the method to determine whether this security token authenticator can authenticate the security token type for `token`. ]]> @@ -158,7 +158,7 @@ method is called by the method to determine whether this security token authenticator can authenticate the security token type for `token`. This does not authenticate the security token; that is performed by the method. + The method is called by the method to determine whether this security token authenticator can authenticate the security token type for `token`. This does not authenticate the security token; that is performed by the method. ]]> @@ -200,7 +200,7 @@ method checks whether the `token` parameter is `null`, calls the method to determine if this security token authenticator can authenticate this security token, and then if it can, calls the method. + The method checks whether the `token` parameter is `null`, calls the method to determine if this security token authenticator can authenticate this security token, and then if it can, calls the method. ]]> @@ -251,17 +251,17 @@ method to authenticate a specific security token type. + Override the method to authenticate a specific security token type. - When the method is overridden, follow these guidelines: + When the method is overridden, follow these guidelines: - When the security token passed into the `token` parameter cannot be validated, throw a exception. -- When there are no authorization policies in effect for this application, return an empty of type . +- When there are no authorization policies in effect for this application, return an empty of type . When this method returns `null`, Windows Communication Foundation throws a exception. - The method is called by the method. + The method is called by the method. ]]> diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenManager.xml b/xml/System.IdentityModel.Selectors/SecurityTokenManager.xml index 8e24d2c02d4..83d7bfd3da3 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenManager.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenManager.xml @@ -39,13 +39,13 @@ Represents a security token manager that specifies how security tokens are provided, authenticated, and serialized. - class when you need a custom security token, security token authenticator, or security token provider. Use a custom security token to handle credentials that WCF does not support. Use a custom security token authenticator when the authentication methods WCF provides are not sufficient. A class returns a security token authenticator in the method. A security token provider provides security tokens for outgoing SOAP messages. A class returns a security token provider in the method. - - For more information about using custom security token authenticators and security token providers, see [Custom Credential and Credential Validation](/dotnet/framework/wcf/extending/custom-credential-and-credential-validation). For more information about creating a custom security token, see [How to: Create a Custom Token](/dotnet/framework/wcf/extending/how-to-create-a-custom-token). - + class when you need a custom security token, security token authenticator, or security token provider. Use a custom security token to handle credentials that WCF does not support. Use a custom security token authenticator when the authentication methods WCF provides are not sufficient. A class returns a security token authenticator in the method. A security token provider provides security tokens for outgoing SOAP messages. A class returns a security token provider in the method. + + For more information about using custom security token authenticators and security token providers, see [Custom Credential and Credential Validation](/dotnet/framework/wcf/extending/custom-credential-and-credential-validation). For more information about creating a custom security token, see [How to: Create a Custom Token](/dotnet/framework/wcf/extending/how-to-create-a-custom-token). + ]]> @@ -110,11 +110,11 @@ Gets a security token authenticator that meets the specified security token requirements. A that authenticates security tokens in incoming SOAP messages that meet the specified requirements. - class provides types that can provide security tokens for outgoing SOAP messages and authenticate security tokens in incoming SOAP messages. The method returns a class that can authenticate security tokens that match the criteria specified in the `tokenRequirement` parameter. - + class provides types that can provide security tokens for outgoing SOAP messages and authenticate security tokens in incoming SOAP messages. The method returns a class that can authenticate security tokens that match the criteria specified in the `tokenRequirement` parameter. + ]]> @@ -151,11 +151,11 @@ Gets a security token provider that meets the specified security token requirements. A that provides security tokens that meet the specified requirements for outgoing SOAP messages. - class provides types that can provide security tokens for outgoing SOAP messages and authenticate security tokens in incoming SOAP messages. The method returns a class that can authenticate security tokens that can provide security tokens that match the criteria specified in the `tokenRequirement` parameter. - + class provides types that can provide security tokens for outgoing SOAP messages and authenticate security tokens in incoming SOAP messages. The method returns a class that can authenticate security tokens that can provide security tokens that match the criteria specified in the `tokenRequirement` parameter. + ]]> @@ -192,11 +192,11 @@ Gets an XML serializer that can serialize security tokens in the specified version of the WS-* specifications. A to serialize the security tokens. - and return an instance of that class for the method. The class, which derives from the class, is capable of serializing and deserializing the security tokens that ship with WCF. Thus, to add support for a custom token to the serializer, override the virtual methods in the class, add code that checks whether the desired security token is the custom token, and, if not, call the base class method. - + and return an instance of that class for the method. The class, which derives from the class, is capable of serializing and deserializing the security tokens that ship with WCF. Thus, to add support for a custom token to the serializer, override the virtual methods in the class, add code that checks whether the desired security token is the custom token, and, if not, call the base class method. + ]]> diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml b/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml index 6695951f865..59ce1536571 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml @@ -39,21 +39,21 @@ Represents a security token provider that handles security tokens for a SOAP message sender. - class when custom security tokens are required. The role of a security token provider is to get a security token when a SOAP message is sent by a client and a security token is used to authenticate the client or to protect the SOAP message. Specifically, the method is called to get a security token. The security token provider can also be called to cancel and renew a security using the and methods. - - Classes that derive from the class implement the method to determine which security token provider is required for a given security token. - - The and classes provide the default implementations for built-in security token types. For custom security token scenarios, you must derive a class from one of the , , or classes and provide the functionality to create the security token provider, security token authenticator, and security token serializer for the custom security token. For more information about creating a custom token, see [How to: Create a Custom Token](/dotnet/framework/wcf/extending/how-to-create-a-custom-token). - - - -## Examples + class when custom security tokens are required. The role of a security token provider is to get a security token when a SOAP message is sent by a client and a security token is used to authenticate the client or to protect the SOAP message. Specifically, the method is called to get a security token. The security token provider can also be called to cancel and renew a security using the and methods. + + Classes that derive from the class implement the method to determine which security token provider is required for a given security token. + + The and classes provide the default implementations for built-in security token types. For custom security token scenarios, you must derive a class from one of the , , or classes and provide the functionality to create the security token provider, security token authenticator, and security token serializer for the custom security token. For more information about creating a custom token, see [How to: Create a Custom Token](/dotnet/framework/wcf/extending/how-to-create-a-custom-token). + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/securitytokenprovider/cs/samlsecuritytokenprovider.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/securitytokenprovider/vb/samlsecuritytokenprovider.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/securitytokenprovider/vb/samlsecuritytokenprovider.vb" id="Snippet0"::: + ]]> @@ -125,16 +125,16 @@ Begins an asynchronous operation to cancel a security token. The that references the asynchronous cancel operation. - - The method is called by the method. - + The method is called by the method. + The asynchronous methods, which have a prefix of Begin and End, do not need to be overridden in derived classes. The base class provides an asynchronous implementation that is based on the synchronous methods. @@ -177,18 +177,18 @@ Begins an asynchronous operation to cancel a security token. The that references the asynchronous cancel operation. - - When you inherit from the class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you need to provide your own asynchronous implementation. - - The method is called by the method. - + When you inherit from the class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you need to provide your own asynchronous implementation. + + The method is called by the method. + The asynchronous methods, which have a prefix of Begin and End, do not need to be overridden in derived classes. The base class provides an asynchronous implementation that is based on the synchronous methods. @@ -229,11 +229,11 @@ Begins an asynchronous operation to get a security token. The that references the asynchronous close operation. - method calls the method. - + method calls the method. + ]]> @@ -277,13 +277,13 @@ Begins an asynchronous operation to get a security token. The that references the asynchronous operation. - class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. - - The method calls the method. - + class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. + + The method calls the method. + ]]> @@ -329,11 +329,11 @@ Begins an asynchronous operation that renews a security token. The that references the asynchronous operation. - method calls the method. - + method calls the method. + ]]> @@ -379,13 +379,13 @@ Begins an asynchronous operation that renews a security token. The that references the asynchronous operation. - class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. - - The method calls the method. - + class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. + + The method calls the method. + ]]> @@ -423,13 +423,13 @@ The to cancel. Cancels a security token. - method calls method. - + method calls method. + ]]> @@ -466,13 +466,13 @@ Cancels a security token. The that represents the asynchronous token cancellation operation. - method calls method. - + method calls method. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -512,15 +512,15 @@ The to cancel. Cancels a security token. - method calls method. - - When the method is overridden and the security token passed into the token parameter cannot be canceled, throw the exception. - + method calls method. + + When the method is overridden and the security token passed into the token parameter cannot be canceled, throw the exception. + ]]> @@ -557,15 +557,15 @@ Cancels a security token. The that represents the asynchronous token cancellation operation. - method calls method. - - When the method is overridden and the security token passed into the token parameter cannot be canceled, throw the exception. - + method calls method. + + When the method is overridden and the security token passed into the token parameter cannot be canceled, throw the exception. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -603,13 +603,13 @@ The that is returned by a call to the method. Completes an asynchronous operation to cancel a security token. - method calls method. - + method calls method. + ]]> @@ -648,15 +648,15 @@ The that is returned by a call to the method. Completes an asynchronous operation to cancel a security token. - class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. - - The method calls method. - + class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. + + The method calls method. + ]]> @@ -693,11 +693,11 @@ Completes an asynchronous operation to get a security token. The that represents the security token. - method calls the method. - + method calls the method. + ]]> @@ -734,13 +734,13 @@ Completes an asynchronous operation to get a security token. The that represents the security token. - class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. - - The method calls the method. - + class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. + + The method calls the method. + ]]> @@ -777,11 +777,11 @@ Completes an asynchronous operation to renew a security token. The that represents the security token that is renewed. - method calls the method. - + method calls the method. + ]]> @@ -818,13 +818,13 @@ Completes an asynchronous operation to renew the security token. The that represents the security token that is renewed. - class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. - - The method calls the method. - + class you are not required to override the asynchronous methods, as the base class provides asynchronous support based upon the synchronous methods. Therefore, you are not required to override the method, unless you must provide your own asynchronous implementation. + + The method calls the method. + ]]> @@ -861,15 +861,15 @@ Gets a security token. The that represents the security token to get. - method is called by the class when a client sends a SOAP message and a security token is required. - - The method calls the method. - - In most cases the `timeout` parameter is not used by derived classes of such as . However, sometimes retrieving a security token involves distributed messaging. An example is used in a federated service. In these cases the `timeout` parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions. - + method is called by the class when a client sends a SOAP message and a security token is required. + + The method calls the method. + + In most cases the `timeout` parameter is not used by derived classes of such as . However, sometimes retrieving a security token involves distributed messaging. An example is used in a federated service. In these cases the `timeout` parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions. + ]]> @@ -904,15 +904,15 @@ Gets a security token. The that represents the asynchronous read operation and wraps the that represents the security token to get. - method is called by the class when a client sends a SOAP message and a security token is required. - - The method calls the method. - - In most cases the `timeout` parameter is not used by derived classes of such as . However, sometimes retrieving a security token involves distributed messaging. An example is used in a federated service. In these cases the `timeout` parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions. - + method is called by the class when a client sends a SOAP message and a security token is required. + + The method calls the method. + + In most cases the `timeout` parameter is not used by derived classes of such as . However, sometimes retrieving a security token involves distributed messaging. An example is used in a federated service. In these cases the `timeout` parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -951,21 +951,21 @@ Gets a security token. The that represents the security token to get. - method is overridden and the security token passed into the token parameter cannot be obtained, throw the exception. - - The method is called by the class when a client sends a SOAP message and a security token is required. - - The method calls the method. - - - -## Examples + method is overridden and the security token passed into the token parameter cannot be obtained, throw the exception. + + The method is called by the class when a client sends a SOAP message and a security token is required. + + The method calls the method. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/securitytokenprovider/cs/samlsecuritytokenprovider.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/securitytokenprovider/vb/samlsecuritytokenprovider.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/securitytokenprovider/vb/samlsecuritytokenprovider.vb" id="Snippet1"::: + ]]> @@ -1000,14 +1000,14 @@ Gets a security token. The that represents the asynchronous read operation and wraps the that represents the security token to get. - method is overridden and the security token passed into the token parameter cannot be obtained, throw the exception. - - The method is called by the class when a client sends a SOAP message and a security token is required. - - The method calls the method. + method is overridden and the security token passed into the token parameter cannot be obtained, throw the exception. + + The method is called by the class when a client sends a SOAP message and a security token is required. + + The method calls the method. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1049,13 +1049,13 @@ Renews a security token. The that represents the security token that is renewed. - method calls the method. - + method calls the method. + ]]> @@ -1092,13 +1092,13 @@ Renews a security token. The that represents the asynchronous read operation and wraps the that represents the security token that is renewed. - method calls the method. - + method calls the method. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1139,15 +1139,15 @@ Renews a security token. The that represents the security token that is renewed. - method is overridden and the security token passed into the token parameter cannot be renewed, throw the exception. - - The method calls the method. - + method is overridden and the security token passed into the token parameter cannot be renewed, throw the exception. + + The method calls the method. + ]]> @@ -1184,15 +1184,15 @@ Renews a security token. The that represents the asynchronous read operation and wraps the that represents the security token that is renewed. - method is overridden and the security token passed into the token parameter cannot be renewed, throw the exception. - - The method calls the method. - + method is overridden and the security token passed into the token parameter cannot be renewed, throw the exception. + + The method calls the method. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1228,11 +1228,11 @@ if the security token can be cancelled; otherwise, . The default is . - @@ -1266,11 +1266,11 @@ if the security token can be renewed; otherwise, . The default is . - diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenRequirement.xml b/xml/System.IdentityModel.Selectors/SecurityTokenRequirement.xml index 11323fcd72d..b04cd1719b0 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenRequirement.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenRequirement.xml @@ -42,7 +42,7 @@ class, unless a custom security token, security token manager, security token provider, or security token authenticator are created. The class is used by a security token manager to specify what is required of a security token, such as the key size, key type, and how the key can be used. When a security token can be identified that matches the specified criteria, a and can be obtained to provide security tokens for outgoing SOAP messages and to authenticate security tokens for incoming SOAP messages, respectively. For example, the default security token manager for outgoing SOAP messages has the method that takes a parameter that can be called to obtain a security token provider that matches the criteria specified in the security token requirement. + Application code typically does not need to use the class, unless a custom security token, security token manager, security token provider, or security token authenticator are created. The class is used by a security token manager to specify what is required of a security token, such as the key size, key type, and how the key can be used. When a security token can be identified that matches the specified criteria, a and can be obtained to provide security tokens for outgoing SOAP messages and to authenticate security tokens for incoming SOAP messages, respectively. For example, the default security token manager for outgoing SOAP messages has the method that takes a parameter that can be called to obtain a security token provider that matches the criteria specified in the security token requirement. @@ -55,13 +55,13 @@ - + - + - + - + ]]> @@ -132,7 +132,7 @@ method first calls the method to determine if the property specified in the `propertyName` parameter has been set. Secondly, the method verifies that when a property value is returned that it can be set to the type specified in the `TValue` parameter. + The method first calls the method to determine if the property specified in the `propertyName` parameter has been set. Secondly, the method verifies that when a property value is returned that it can be set to the type specified in the `TValue` parameter. ]]> @@ -668,7 +668,7 @@ method. + To get the property value of the specified property and verify that property value can be set to the type specified in the `TValue` parameter, call the method. ]]> diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenResolver.xml b/xml/System.IdentityModel.Selectors/SecurityTokenResolver.xml index 23165ce31fb..f819eebe7db 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenResolver.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenResolver.xml @@ -51,7 +51,7 @@ class to retrieve a key or security token when you have a key identifier or key identifier clause. The and methods retrieve a token given that there is a key identifier or key identifier clause. The and retrieve a key given that there is a key identifier clause. The methods with a `Try` prefix return `false` when the retrieval is unsuccessful, whereas the methods without a `Try` prefix throw an exception. + Use the class to retrieve a key or security token when you have a key identifier or key identifier clause. The and methods retrieve a token given that there is a key identifier or key identifier clause. The and retrieve a key given that there is a key identifier clause. The methods with a `Try` prefix return `false` when the retrieval is unsuccessful, whereas the methods without a `Try` prefix throw an exception. ]]> @@ -121,7 +121,7 @@ and methods on the specified security tokens to resolve key identifiers and key identifier clauses. + The security token resolver that is returned from this method, uses the and methods on the specified security tokens to resolve key identifiers and key identifier clauses. ]]> @@ -199,7 +199,7 @@ and methods differ in what happens when the key identifier clause cannot be resolved to a key. The method returns `false`, whereas the method throws an exception. + The and methods differ in what happens when the key identifier clause cannot be resolved to a key. The method returns `false`, whereas the method throws an exception. ]]> @@ -252,7 +252,7 @@ and methods differ in what happens when the key identifier cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. + The and methods differ in what happens when the key identifier cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. ]]> @@ -296,7 +296,7 @@ and methods differ in what happens when the key identifier clause cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. + The and methods differ in what happens when the key identifier clause cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. ]]> @@ -340,7 +340,7 @@ and methods differ in what happens when the key identifier clause cannot be resolved to a key. The method returns `false`, whereas the method throws an exception. + The and methods differ in what happens when the key identifier clause cannot be resolved to a key. The method returns `false`, whereas the method throws an exception. ]]> @@ -386,7 +386,7 @@ method is called by the and methods. + The method is called by the and methods. ]]> @@ -439,7 +439,7 @@ and methods differ in what happens when the key identifier cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. + The and methods differ in what happens when the key identifier cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. ]]> @@ -485,7 +485,7 @@ and methods differ in what happens when the key identifier clause cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. + The and methods differ in what happens when the key identifier clause cannot be resolved to a security token. The method returns `false`, whereas the method throws an exception. ]]> @@ -540,7 +540,7 @@ method is called by the and methods. + The method is called by the and methods. ]]> @@ -584,7 +584,7 @@ method is called by the and methods. + The method is called by the and methods. ]]> diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenSerializer.xml b/xml/System.IdentityModel.Selectors/SecurityTokenSerializer.xml index 93baa6930ce..85eac6cfb7c 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenSerializer.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenSerializer.xml @@ -39,11 +39,11 @@ Represents a class that can read and write key identifiers, key identifier clauses, and security tokens. - class to read and write , , and classes as XML. The class has methods to determine whether this class can read and write these entities and to actually read and write them. For security tokens, these methods are , , , and . - + class to read and write , , and classes as XML. The class has methods to determine whether this class can read and write these entities and to actually read and write them. For security tokens, these methods are , , , and . + ]]> @@ -107,11 +107,11 @@ when the specified XML element can be read; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -151,11 +151,11 @@ when the specified key identifier clause can be read; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -195,11 +195,11 @@ when the specified element can be read; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -239,11 +239,11 @@ when the specified key identifier clause can be read; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -283,11 +283,11 @@ when the security token can be read; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -327,11 +327,11 @@ when the security token can be read; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -371,11 +371,11 @@ when this serializer can write the specified key identifier; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -415,11 +415,11 @@ when this serializer can write the specified key identifier clause; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -459,11 +459,11 @@ when this serializer can write the specified key identifier clause; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -503,11 +503,11 @@ when this serializer can write the specified key identifier; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -547,11 +547,11 @@ when the security token can be written; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -591,11 +591,11 @@ when the security token can be written; otherwise, . - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -634,11 +634,11 @@ Reads the key identifier using specified XML reader. A that represents the key identifier that is read. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -677,11 +677,11 @@ Reads the key identifier clause using specified XML reader. A that represents the key identifier that is read. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -720,11 +720,11 @@ Reads the key identifier clause using specified XML reader. Called by the base class. A that represents the key identifier that is read. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -763,11 +763,11 @@ Reads the key identifier clause using specified XML reader. Called by the base class. A that represents the key identifier that is read. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> @@ -808,18 +808,18 @@ Reads the security token pointed at by the specified XML reader. A that represents the security token that is read. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -857,18 +857,18 @@ Reads the security token pointed at by the specified XML reader. Called by the base class. A that represents the security token that is read. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -905,18 +905,18 @@ A that represents the key identifier to write. Writes the specified key identifier using the specified XML writer. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -953,18 +953,18 @@ A that represents the key identifier clause to write. Writes the specified key identifier clause using the specified XML writer. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -1001,18 +1001,18 @@ A that represents the key identifier clause to write. Writes the specified key identifier clause using the specified XML writer. Called by the base class. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -1049,18 +1049,18 @@ A that represents the key identifier to write. Writes the specified key identifier using the specified XML writer. Called by the base class. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -1097,18 +1097,18 @@ A that represents the security token to write. Writes the specified security token using the specified XML writer. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . @@ -1145,18 +1145,18 @@ A that represents the security token to write. Writes the specified security token using the specified XML writer. Called by the base class. - class must override the method. The method calls the method. - + class must override the method. The method calls the method. + ]]> - is . - - -or- - + is . + + -or- + is . diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenVersion.xml b/xml/System.IdentityModel.Selectors/SecurityTokenVersion.xml index 51ca3e98045..82707ca8aed 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenVersion.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenVersion.xml @@ -39,13 +39,13 @@ Represents the specifications, such as the WS-*specifications, that security tokens are defined in. - class to determine which version of the WS-* specifications that security tokens confirm to in a SOAP message. - - Use the method to create a that is capable of serializing and deserializing security tokens according to the set of specifications that are associated with a class deriving from the class. - + class to determine which version of the WS-* specifications that security tokens confirm to in a SOAP message. + + Use the method to create a that is capable of serializing and deserializing security tokens according to the set of specifications that are associated with a class deriving from the class. + ]]> diff --git a/xml/System.IdentityModel.Selectors/UserNamePasswordValidator.xml b/xml/System.IdentityModel.Selectors/UserNamePasswordValidator.xml index 0dfa0a14539..5da2cd22d8e 100644 --- a/xml/System.IdentityModel.Selectors/UserNamePasswordValidator.xml +++ b/xml/System.IdentityModel.Selectors/UserNamePasswordValidator.xml @@ -20,7 +20,7 @@ class to specify how a username and password is validated. This can be done by deriving a class from and overriding the method. For more information about creating a custom user name and password validator, see [How to: Use a Custom User Name and Password Validator](/dotnet/framework/wcf/feature-details/how-to-use-a-custom-user-name-and-password-validator). + Use the class to specify how a username and password is validated. This can be done by deriving a class from and overriding the method. For more information about creating a custom user name and password validator, see [How to: Use a Custom User Name and Password Validator](/dotnet/framework/wcf/feature-details/how-to-use-a-custom-user-name-and-password-validator). ]]> @@ -133,7 +133,7 @@ method to specify how the username and password is validated. If the username and password do not pass validation, then throw a . +Override the method to specify how the username and password is validated. If the username and password do not pass validation, then throw a . ]]> diff --git a/xml/System.IdentityModel.Selectors/UserNameSecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/UserNameSecurityTokenAuthenticator.xml index 028053d45c2..964c7f0dea3 100644 --- a/xml/System.IdentityModel.Selectors/UserNameSecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/UserNameSecurityTokenAuthenticator.xml @@ -29,9 +29,7 @@ ||Allows an application to provide a custom authentication scheme for user names and passwords. The authentication scheme is provided using a class deriving from the class.| ||Authenticates the user name and password as a Windows account.| - Most custom authentication schemes can use the use the class and implement a class that derives from the class. However, if additional flexibility is needed, you can derive a class from the class and override the method. - - + Most custom authentication schemes can use the class and implement a class that derives from the class. However, if additional flexibility is needed, you can derive a class from the class and override the method. ## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/usernamesecuritytokenauthenticator/cs/mytokenauthenticator.cs" id="Snippet0"::: @@ -87,7 +85,7 @@ method does not authenticate the security token; that is performed by the method. + The method does not authenticate the security token; that is performed by the method. ]]> @@ -120,7 +118,7 @@ method calls the method to authenticate the `token` parameter using its user name and password. + The method calls the method to authenticate the `token` parameter using its user name and password. ]]> @@ -155,13 +153,13 @@ method to authenticate security tokens. + Override the method to authenticate security tokens. - When the method is overridden, follow these guidelines: + When the method is overridden, follow these guidelines: - When the security token passed into the `token` parameter cannot be validated, throw the exception. -- When there are no authorization policies in effect for this application, return an empty of type . +- When there are no authorization policies in effect for this application, return an empty of type . When this method returns `null`, Windows Communication Foundation throws a exception. diff --git a/xml/System.IdentityModel.Selectors/UserNameSecurityTokenProvider.xml b/xml/System.IdentityModel.Selectors/UserNameSecurityTokenProvider.xml index 78c38c07629..3059deb19b1 100644 --- a/xml/System.IdentityModel.Selectors/UserNameSecurityTokenProvider.xml +++ b/xml/System.IdentityModel.Selectors/UserNameSecurityTokenProvider.xml @@ -27,11 +27,11 @@ Represents a security token provider that provides security tokens for a SOAP message sender. - class doesn't need to be called directly, as it is called when a client sends a SOAP message that requires a security token. Specifically, a client specifies the type of security token needed using the class and the class calls the method to get a security token. When the security token needed is a security token, the method calls the method. - + class doesn't need to be called directly, as it is called when a client sends a SOAP message that requires a security token. Specifically, a client specifies the type of security token needed using the class and the class calls the method to get a security token. When the security token needed is a security token, the method calls the method. + ]]> @@ -69,11 +69,11 @@ The password of the user to get a security token for. Initializes a new instance of the class using the specified username and password. - method gets a token based on the specified username and password. - + method gets a token based on the specified username and password. + ]]> @@ -110,13 +110,13 @@ Gets a security token based on the username and password specified in the constructor. The that represents the security token to get. - method is called by the class when a client sends a SOAP message and an security token is needed. - - The method calls the method. - + method is called by the class when a client sends a SOAP message and an security token is needed. + + The method calls the method. + ]]> diff --git a/xml/System.IdentityModel.Selectors/WindowsSecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/WindowsSecurityTokenAuthenticator.xml index f058e592b98..108a26e038b 100644 --- a/xml/System.IdentityModel.Selectors/WindowsSecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/WindowsSecurityTokenAuthenticator.xml @@ -127,7 +127,7 @@ method does not authenticate the security token; that is performed by the method. + The method does not authenticate the security token; that is performed by the method. ]]> diff --git a/xml/System.IdentityModel.Selectors/WindowsUserNameSecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/WindowsUserNameSecurityTokenAuthenticator.xml index 2977ff54864..56568b83e09 100644 --- a/xml/System.IdentityModel.Selectors/WindowsUserNameSecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/WindowsUserNameSecurityTokenAuthenticator.xml @@ -20,7 +20,7 @@ method uses Windows authentication to authenticate a user name and password. + The method uses Windows authentication to authenticate a user name and password. To provide a custom authentication scheme, see the class. diff --git a/xml/System.IdentityModel.Selectors/X509CertificateValidator.xml b/xml/System.IdentityModel.Selectors/X509CertificateValidator.xml index 10911cbad1c..88b0ee55fec 100644 --- a/xml/System.IdentityModel.Selectors/X509CertificateValidator.xml +++ b/xml/System.IdentityModel.Selectors/X509CertificateValidator.xml @@ -54,10 +54,7 @@ class to specify how an X.509 certificate is deemed valid. This can be done using by deriving a class from and overriding the method. - - +Use the class to specify how an X.509 certificate is deemed valid. This can be done by deriving a class from and overriding the method. ## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_x509certificatevalidator/cs/source.cs" id="Snippet1"::: @@ -187,7 +184,7 @@ method instead of the property to specify the context or to set chain policy. Chain policy can be used to specify the Enhanced Key Usage (EKU) for which the chain should be validated, or specify revocation checking. + Use the method instead of the property to specify the context or to set chain policy. Chain policy can be used to specify the Enhanced Key Usage (EKU) for which the chain should be validated, or specify revocation checking. The return value for this static method can be supplied as a parameter to the constructors for the class that take a validator. @@ -233,7 +230,7 @@ method instead of the property to specify the context or to set chain policy. Chain policy can be used to specify the Enhanced Key Usage (EKU) for which the chain should be validated, or specify revocation checking. + Use the method instead of the property to specify the context or to set chain policy. Chain policy can be used to specify the Enhanced Key Usage (EKU) for which the chain should be validated, or specify revocation checking. The value of this static property can be supplied as a parameter to one of the constructors for the class. @@ -428,7 +425,7 @@ method to specify how the X.509 certificate is validated. + Override the method to specify how the X.509 certificate is validated. When the X.509 certificate that is passed into the `certificate` parameter does not pass validation, throw the . diff --git a/xml/System.IdentityModel.Selectors/X509SecurityTokenAuthenticator.xml b/xml/System.IdentityModel.Selectors/X509SecurityTokenAuthenticator.xml index c1d8b0310ca..599adfd75ed 100644 --- a/xml/System.IdentityModel.Selectors/X509SecurityTokenAuthenticator.xml +++ b/xml/System.IdentityModel.Selectors/X509SecurityTokenAuthenticator.xml @@ -79,7 +79,7 @@ method is called to authenticate the token, the X.509 certificate is not mapped to a Windows identity and the certificate is validated using a certificate chain. + When the method is called to authenticate the token, the X.509 certificate is not mapped to a Windows identity and the certificate is validated using a certificate chain. ]]> @@ -116,7 +116,7 @@ class provides a set of pre-defined certificate validation models, such as the property. These validation models can be passed to the `validator` parameter. When an application requires a custom validation method, derive a class from and override the method. The method is called by the method. + The class provides a set of pre-defined certificate validation models, such as the property. These validation models can be passed to the `validator` parameter. When an application requires a custom validation method, derive a class from and override the method. The method is called by the method. By default, the does not map the X.509 certificate to a Windows identity. @@ -157,9 +157,9 @@ class provides a set of pre-defined certificate validation models, such as the property. These validation models can be passed to the `validator` parameter. When an application requires a custom validation method, derive a class from and override the method. The method is called by the method. + The class provides a set of pre-defined certificate validation models, such as the property. These validation models can be passed to the `validator` parameter. When an application requires a custom validation method, derive a class from and override the method. The method is called by the method. - When the method is called to authenticate the token and `mapToWindows` is `true`, the X.509 certificate is mapped to a Windows account and claims are added to the with the Windows groups that the user belongs to. How the X.509 certificate is mapped to a Windows account depends upon the security token type: + When the method is called to authenticate the token and `mapToWindows` is `true`, the X.509 certificate is mapped to a Windows account and claims are added to the with the Windows groups that the user belongs to. How the X.509 certificate is mapped to a Windows account depends upon the security token type: - When the security token is of type , the X.509 certificate is mapped using the property. @@ -207,7 +207,7 @@ ## Remarks Pass `false` to the `includeWindowsGroups` parameter when the Windows group information is not required to improve performance. - The class has several static properties, such as the property that can be passed to the `validator` parameter. These properties provide common validation methods for X.509 certificates. When a custom validation method is required, derive a class from and override the method. The method is called by the method. + The class has several static properties, such as the property that can be passed to the `validator` parameter. These properties provide common validation methods for X.509 certificates. When a custom validation method is required, derive a class from and override the method. The method is called by the method. When `true` is passed into the `mapToWindows` parameter, the X.509 certificate is mapped to a Windows account and relevant claims are added to the , such as the Windows groups that the user belongs to. When the security token is of type , the property is using the identity that is specified in the token; otherwise, the X.509 certificate is mapped to a Windows identity using a Kerberos S4U logon based on the user principal name SubjectAltNames extension of the X.509 certificate. @@ -251,7 +251,7 @@ method does not authenticate the security token; that is performed by the method. + The method does not authenticate the security token; that is performed by the method. ]]> @@ -327,15 +327,15 @@ method is overridden, follow these guidelines: + When the method is overridden, follow these guidelines: - When the security token passed into the `token` parameter cannot be validated, throw the exception. -- When there are no authorization policies in effect for this application, return an empty of type . +- When there are no authorization policies in effect for this application, return an empty of type . When this method returns `null`, Windows Communication Foundation throws a exception. - The method calls the method of the validation method specified in the constructor to authenticate the `token` parameter. + The method calls the method of the validation method specified in the constructor to authenticate the `token` parameter. ]]> diff --git a/xml/System.IdentityModel.Selectors/X509SecurityTokenProvider.xml b/xml/System.IdentityModel.Selectors/X509SecurityTokenProvider.xml index 79cc760fa39..cbab66c2ab1 100644 --- a/xml/System.IdentityModel.Selectors/X509SecurityTokenProvider.xml +++ b/xml/System.IdentityModel.Selectors/X509SecurityTokenProvider.xml @@ -34,7 +34,7 @@ class directly, as it is called when a client sends a SOAP message that requires a security token. Specifically, a client specifies the type of security token required, using the class and the class calls the method to get a security token. When the security token required is an security token, the method calls the method. + In most instances it is not necessary to call the class directly, as it is called when a client sends a SOAP message that requires a security token. Specifically, a client specifies the type of security token required, using the class and the class calls the method to get a security token. When the security token required is an security token, the method calls the method. ]]> @@ -83,7 +83,7 @@ method gets a security token based on the certificate specified in the `certificate` parameter. + The method gets a security token based on the certificate specified in the `certificate` parameter. ]]> @@ -120,7 +120,7 @@ method gets a security token based on the certificate that matches the specified certificate store criteria. + The method gets a security token based on the certificate that matches the specified certificate store criteria. ]]> @@ -156,7 +156,7 @@ method gets a security token based on the certificate represented by the property. + The method gets a security token based on the certificate represented by the property. ]]> @@ -230,9 +230,9 @@ method is called by the class when a client sends a SOAP message and an security token is required. + The method is called by the class when a client sends a SOAP message and an security token is required. - The method calls the method. + The method calls the method. ]]> diff --git a/xml/System.IdentityModel.Services.Configuration/FederationConfiguration.xml b/xml/System.IdentityModel.Services.Configuration/FederationConfiguration.xml index d312b7ce21f..e788acd09b9 100644 --- a/xml/System.IdentityModel.Services.Configuration/FederationConfiguration.xml +++ b/xml/System.IdentityModel.Services.Configuration/FederationConfiguration.xml @@ -38,7 +38,7 @@ ## Remarks > [!IMPORTANT] -> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. +> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. ]]> @@ -62,10 +62,10 @@ ` configuration section. This constructor calls the constructor with the `loadConfig` parameter `true`. + The properties in the new instance are initialized by loading settings from the `` configuration section. This constructor calls the constructor with the `loadConfig` parameter `true`. > [!WARNING] -> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. +> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. ]]> @@ -97,7 +97,7 @@ ## Remarks > [!WARNING] -> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. +> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. The `system.identityModel` section must be specified in a `
` element under the `` element in the configuration file or an exception is thrown. @@ -107,7 +107,7 @@ ``` - If `loadConfig` is `true` and only a single `` element is specified, settings are loaded using that element. If multiple `` elements are specified, the method attempts to load settings from the element that is unnamed of that has the . If such an element does not exist, the method returns without loading settings. This results in an exception when the method is called. + If `loadConfig` is `true` and only a single `` element is specified, settings are loaded using that element. If multiple `` elements are specified, the method attempts to load settings from the element that is unnamed of that has the . If such an element does not exist, the method returns without loading settings. This results in an exception when the method is called. > [!WARNING] > Microsoft recommends that if you specify multiple `` elements in the `system.identityModel.services` configuration section that at least one of them is unnamed or has its name set to an empty string. @@ -141,7 +141,7 @@ ## Remarks > [!WARNING] -> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. +> Before the new instance is used by any of the configured HTTP modules, call the method to ensure that the instance is properly initialized. If this constructor is called then a `` configuration section with a `` element that has the specified name must exist in the configuration file. @@ -292,7 +292,7 @@ ## Remarks This method ensures that the current instance is properly initialized before it is used by the HTTP Modules to process incoming requests. It should only be called once. Check the property before calling the method. This method sets the property is set `true`. - The default implementation creates a default cookie handler if there is not one already configured through the property and calls the method on the identity configuration object that is configured through the property. You can override this method to modify this behavior or to provide additional initialization in derived classes. + The default implementation creates a default cookie handler if there is not one already configured through the property and calls the method on the identity configuration object that is configured through the property. You can override this method to modify this behavior or to provide additional initialization in derived classes. This method should be invoked before the class is used by the HTTP Modules to process incoming requests. @@ -324,7 +324,7 @@ object has already been initialized. The method should be called once and only once. + Use this property to check whether the object has already been initialized. The method should be called once and only once. The `set` operation is `protected`. @@ -357,7 +357,7 @@ method is called by the constructors to set the properties of the newly created object from the specified `` element. + The method is called by the constructors to set the properties of the newly created object from the specified `` element. If `element` is `null`, the instance is loaded with default values. diff --git a/xml/System.IdentityModel.Services/AttributeRequestMessage.xml b/xml/System.IdentityModel.Services/AttributeRequestMessage.xml index b5f28997e4f..9a682a5eab4 100644 --- a/xml/System.IdentityModel.Services/AttributeRequestMessage.xml +++ b/xml/System.IdentityModel.Services/AttributeRequestMessage.xml @@ -249,7 +249,7 @@ method before writing the message. + This method calls the method before writing the message. ]]> diff --git a/xml/System.IdentityModel.Services/ChunkedCookieHandler.xml b/xml/System.IdentityModel.Services/ChunkedCookieHandler.xml index 3e78c04e035..ffb5dcbb115 100644 --- a/xml/System.IdentityModel.Services/ChunkedCookieHandler.xml +++ b/xml/System.IdentityModel.Services/ChunkedCookieHandler.xml @@ -16,13 +16,13 @@ Represents a cookie handler that writes cookie data so that cookies never exceed a set size. - class presents the cookie as a logical entity, so that, in the case of cookies with a size that exceeds a specified threshold (the chunk size), a single call to the method breaks the data into a series of actual client-side cookies, none of which exceeds the chunk size. - - Cookie names are constructed based on the `name` parameter to the , , or methods. The cookie names are constructed by appending a number to the base name: name, name1, name2, and so on. - + class presents the cookie as a logical entity, so that, in the case of cookies with a size that exceeds a specified threshold (the chunk size), a single call to the method breaks the data into a series of actual client-side cookies, none of which exceeds the chunk size. + + Cookie names are constructed based on the `name` parameter to the , , or methods. The cookie names are constructed by appending a number to the base name: name, name1, name2, and so on. + ]]> @@ -51,11 +51,11 @@ Initializes a new instance of the class that uses the default chunk size. - . - + . + ]]> @@ -79,11 +79,11 @@ The chunk size that will be used to write cookies. Initializes a new instance of the class that uses a specified chunk size. - diff --git a/xml/System.IdentityModel.Services/ClaimsPrincipalPermission.xml b/xml/System.IdentityModel.Services/ClaimsPrincipalPermission.xml index 511c3b2bd9e..267d1129ba0 100644 --- a/xml/System.IdentityModel.Services/ClaimsPrincipalPermission.xml +++ b/xml/System.IdentityModel.Services/ClaimsPrincipalPermission.xml @@ -35,23 +35,23 @@ class provides the capability to perform imperative access checks by using the that is configured for an application. By invoking the method or the static method, you can provide protection to resources from within the execution path of your code according to the authorization policy defined for your claims authentication manager. Declarative access checks can be performed by using the class. + The class provides the capability to perform imperative access checks by using the that is configured for an application. By invoking the method or the static method, you can provide protection to resources from within the execution path of your code according to the authorization policy defined for your claims authentication manager. Declarative access checks can be performed by using the class. > [!IMPORTANT] > The class uses the claims authorization manager configured by the that is set under the property. This is true in all cases, even in scenarios where WS-Federation is not used; for example, active (WCF) Web applications and Console applications. You can specify the claims authorization manager either in configuration or programmatically. To specify the claims authorization manager in a configuration file, set the [<claimsAuthorizationManager>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/claimsauthorizationmanager) element under an [<identityConfiguration>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/identityconfiguration) element and ensure that this identity configuration is referenced by the [<federationConfiguration>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/federationconfiguration) element that is loaded by the runtime (for example, by setting the `identityConfigurationName` attribute). To set the claims authorization manager programmatically, provide a handler for the event. On one level, the functionality provided by is similar to the role-based access checks (RBAC) provided through the class; however, the class performs checks based on the claims presented by the active principal. This enables far more granularity than is available through pure RBAC, where many permissions are typically collected under a single role. Perhaps, more importantly, claims-based authorization enables better separation of business logic and authorization policy because permission can be demanded for a specific action on a resource in code and back-end policy can be used to configure which claims the presenting entity must possess in order to satisfy the demand. Like RBAC, performs a user-based access check, that is, unlike code access security implemented by classes that derive from the class and use a stack walk to ensure that all callers of the code have been granted a permission, performs its check only on the current principal. - The static method checks access for a specified action on a specified resource. The resource and action are both strings and are typically URIs. You can also initialize an instance of with an action and a resource and call the method. Although the constructor only takes a single resource and action, objects can be combined through the and methods. A permission created by using these methods may contain multiple resource-action pairs. + The static method checks access for a specified action on a specified resource. The resource and action are both strings and are typically URIs. You can also initialize an instance of with an action and a resource and call the method. Although the constructor only takes a single resource and action, objects can be combined through the and methods. A permission created by using these methods may contain multiple resource-action pairs. - Both methods determine access by invoking the method of the configured claims authorization manager with an composed of the active principal (), the resource, and the action. They throw a if the current principal is not authorized to perform the action on the resource; otherwise, execution proceeds. + Both methods determine access by invoking the method of the configured claims authorization manager with an composed of the active principal (), the resource, and the action. They throw a if the current principal is not authorized to perform the action on the resource; otherwise, execution proceeds. - In the case of a that contains multiple resource-action pairs, the method is invoked for each of the resource-action pairs contained in the permission. For the call to to succeed, the active principal must be authorized for all of the resource-action pairs contained in the permission. + In the case of a that contains multiple resource-action pairs, the method is invoked for each of the resource-action pairs contained in the permission. For the call to to succeed, the active principal must be authorized for all of the resource-action pairs contained in the permission. ## Examples - The following example shows how to protect a resource by using the method, the method, or a declaration. In each case, the configured is invoked to evaluate the current principal against the specified resource and action. If the current principal is not authorized for the specified action on the specified resource, a is thrown; otherwise, execution proceeds. + The following example shows how to protect a resource by using the method, the method, or a declaration. In each case, the configured is invoked to evaluate the current principal against the specified resource and action. If the current principal is not authorized for the specified action on the specified resource, a is thrown; otherwise, execution proceeds. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Services/ClaimsPrincipalPermission/Overview/program.cs" id="Snippet1"::: @@ -111,9 +111,9 @@ object is initialized with the specified resource-action pair. You can call the method to perform an access check. + The object is initialized with the specified resource-action pair. You can call the method to perform an access check. - Although the constructor only takes a single resource and action, objects can be combined through the and methods. The permission created through these methods may contain multiple resource-action pairs. + Although the constructor only takes a single resource and action, objects can be combined through the and methods. The permission created through these methods may contain multiple resource-action pairs. ]]> @@ -158,12 +158,12 @@ ## Remarks The principal must be authorized for the specified action on the specified resource or the exception is thrown. - The method of the configured claims authorization manager is invoked with an composed of the active principal (), the resource, and the action. + The method of the configured claims authorization manager is invoked with an composed of the active principal (), the resource, and the action. ## Examples - The following example shows how to protect a resource by using the method. The configured claims authorization manager is invoked to evaluate the current principal against the specified resource and action. If the current principal is not authorized for the specified action on the specified resource, a is thrown; otherwise, execution proceeds. + The following example shows how to protect a resource by using the method. The configured claims authorization manager is invoked to evaluate the current principal against the specified resource and action. If the current principal is not authorized for the specified action on the specified resource, a is thrown; otherwise, execution proceeds. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Services/ClaimsPrincipalPermission/Overview/program.cs" id="Snippet2"::: @@ -235,14 +235,14 @@ ## Remarks The current principal must be authorized for all of the resource-action pairs associated with this instance or the exception is thrown. - Although the constructor only takes a single resource and action, objects can be combined through the and methods. The permission created through these methods may contain multiple resource-action pairs. + Although the constructor only takes a single resource and action, objects can be combined through the and methods. The permission created through these methods may contain multiple resource-action pairs. - The method invokes the method of the configured claims authorization manager with an composed of the active principal (), the resource, and the action for each of the resource-action pairs contained in the permission. For the to succeed the active principal must be authorized for all of the resource-action pairs that are contained in the permission. + The method invokes the method of the configured claims authorization manager with an composed of the active principal (), the resource, and the action for each of the resource-action pairs contained in the permission. For the to succeed the active principal must be authorized for all of the resource-action pairs that are contained in the permission. ## Examples - The following example shows how to protect a resource by using the method. The configured claims authorization manager is invoked to evaluate the current principal against the specified resource and action. If the current principal is not authorized for the specified action on the specified resource, a is thrown; otherwise, execution proceeds. + The following example shows how to protect a resource by using the method. The configured claims authorization manager is invoked to evaluate the current principal against the specified resource and action. If the current principal is not authorized for the specified action on the specified resource, a is thrown; otherwise, execution proceeds. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Services/ClaimsPrincipalPermission/Overview/program.cs" id="Snippet3"::: @@ -284,7 +284,7 @@ method. + Reconstructs a permission from the XML encoding created by a call to the method. ]]> @@ -322,7 +322,7 @@ to succeed on the new permission, the current principal only needs to be authorized for the resource-action pairs that were common to the current permission and the specified permission. + The permission that is returned has only the resource-action pairs that were present both in the current permission and in the specified permission. Resource-action pairs that existed in only one or the other of the permissions are not included. For a to succeed on the new permission, the current principal only needs to be authorized for the resource-action pairs that were common to the current permission and the specified permission. ]]> @@ -358,7 +358,7 @@ , the returns `false`. + The current permission is a subset of the specified permission if all of the resource-action pairs contained in the current permission are also present in the specified permission. If `target` is `null` or is not an instance of , the returns `false`. ]]> @@ -416,7 +416,7 @@ method. + The principal can be reconstructed from its XML encoded form by calling the method. ]]> @@ -451,7 +451,7 @@ to succeed on the new permission, the current principal must be authorized for all of the resource-action pairs that existed in the current permission and all of the resource-action pairs that existed in the specified permission. + The permission that is returned has all of the resource-action pairs that are present in the current permission and all of the resource-action pairs that are present the specified permission. For a to succeed on the new permission, the current principal must be authorized for all of the resource-action pairs that existed in the current permission and all of the resource-action pairs that existed in the specified permission. ]]> diff --git a/xml/System.IdentityModel.Services/ClaimsPrincipalPermissionAttribute.xml b/xml/System.IdentityModel.Services/ClaimsPrincipalPermissionAttribute.xml index 8a177107f34..2727fe17619 100644 --- a/xml/System.IdentityModel.Services/ClaimsPrincipalPermissionAttribute.xml +++ b/xml/System.IdentityModel.Services/ClaimsPrincipalPermissionAttribute.xml @@ -93,7 +93,7 @@ declaration or an exception will be thrown when the method is invoked to create the permission. + You must also specify the `Operation` and `Resource` properties in your declaration or an exception will be thrown when the method is invoked to create the permission. ]]> @@ -128,7 +128,7 @@ object is created by using the value of the property and the property. You must specify the `Operation` and `Resource` properties in your declaration or an exception will be thrown when the method is invoked to create the permission. + The object is created by using the value of the property and the property. You must specify the `Operation` and `Resource` properties in your declaration or an exception will be thrown when the method is invoked to create the permission. ]]> @@ -156,7 +156,7 @@ declaration or an exception will be thrown when the method is called to create the permission. + The operation is the action for which the current principal should be authorized on the specified resource. You must set the `Operation` property in your declaration or an exception will be thrown when the method is called to create the permission. ]]> @@ -184,7 +184,7 @@ declaration or an exception will be thrown when the method is called to create the permission. + The resource on which the current principal should be authorized to perform the specified action. You must set the `Resource` property in your declaration or an exception will be thrown when the method is called to create the permission. ]]> diff --git a/xml/System.IdentityModel.Services/CookieHandler.xml b/xml/System.IdentityModel.Services/CookieHandler.xml index f493ba3d759..54d1687a446 100644 --- a/xml/System.IdentityModel.Services/CookieHandler.xml +++ b/xml/System.IdentityModel.Services/CookieHandler.xml @@ -23,7 +23,7 @@ Windows Identity Foundation (WIF) ships with a cookie handler called the chunked cookie handler that is implemented by the class. The chunked cookie handler splits the session token across one or more cookies according to a specified chunk size. This is to meet size limitations on individual cookies imposed by many browsers. - You can derive from to create your own cookie handler. When you do so, you must override the , , and methods to perform the actual work of deleting, reading, and writing the session cookie. These methods typically read the cookie from the collection and write or delete cookies through the collection. The object through which you can access the request and response is provided as a parameter to each of these methods. In addition to the required methods, you can optionally override other virtual methods properties exposed by the class to customize the behavior of your handler. + You can derive from to create your own cookie handler. When you do so, you must override the , , and methods to perform the actual work of deleting, reading, and writing the session cookie. These methods typically read the cookie from the collection and write or delete cookies through the collection. The object through which you can access the request and response is provided as a parameter to each of these methods. In addition to the required methods, you can optionally override other virtual methods properties exposed by the class to customize the behavior of your handler. Several properties are exposed by the class that specify default behavior and properties for the session cookie. The , , and properties supply the base name for the cookie, the domain in which it is valid and the path under which it is stored on the client. The property specifies whether the cookie is accessible to client-side scripts. The property specifies whether the cookie should be transmitted only over secure (HTTPS) connections. If set, the property is used to set the expiration time for persistent sessions, that is for sessions that remain valid even after the browser is closed. All of these properties have equivalent properties that are typically set on the underlying object (or objects) by the "core" methods of the handler. For more information see the documentation for each property. @@ -262,7 +262,7 @@ methods to do the actual work of deleting the cookie. The methods will ensure that name and path are non-empty strings. + Called from the overloaded methods to do the actual work of deleting the cookie. The methods will ensure that name and path are non-empty strings. ]]> @@ -618,7 +618,7 @@ methods to do the actual work of reading the cookie. The methods will ensure that `name` is a non-empty string. + Called from the overloaded methods to do the actual work of reading the cookie. The methods will ensure that `name` is a non-empty string. ]]> @@ -874,7 +874,7 @@ methods to do the actual work of writing the cookie. The methods will ensure that `value` is a non-empty byte array and that `name` and `path` are non-empty strings. + Called from the overloaded methods to do the actual work of writing the cookie. The methods will ensure that `value` is a non-empty byte array and that `name` and `path` are non-empty strings. ]]> diff --git a/xml/System.IdentityModel.Services/FederatedAuthentication.xml b/xml/System.IdentityModel.Services/FederatedAuthentication.xml index f0e0238e77b..fbb28790e3c 100644 --- a/xml/System.IdentityModel.Services/FederatedAuthentication.xml +++ b/xml/System.IdentityModel.Services/FederatedAuthentication.xml @@ -19,7 +19,7 @@ class. The method provides an extension point through which other application-defined modules that derive from and that are configured for the application can be accessed. + You can access the modules that are configured for the web application through the static properties exposed by the class. The method provides an extension point through which other application-defined modules that derive from and that are configured for the application can be accessed. The property references a singleton instance of that provides configuration settings for the HTTP modules. The first time the property is accessed by one of the HTTP modules, a instance is initialized from the [<federationConfiguration>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/federationconfiguration) element in the configuration file and the is raised to provide an application with the opportunity to modify the configuration object before it is used to initialize module properties. The same instance is returned on each subsequent access of the property. @@ -78,7 +78,7 @@ On subsequent accesses, the same configuration instance is returned. - Depending on whether specific modules are present, the property is accessed from within the following methods during initialization: , , and . + Depending on whether specific modules are present, the property is accessed from within the following methods during initialization: , , and . > [!IMPORTANT] > The claims authorization manager () that is used to evaluate claims based access checks when using the class or the class is configured on the object that is set on the federation configuration object referenced through the property. This is true for all applications whether they are ASP.NET applications or not. diff --git a/xml/System.IdentityModel.Services/FederatedAuthenticationSessionEndingException.xml b/xml/System.IdentityModel.Services/FederatedAuthenticationSessionEndingException.xml index 5988b8472a3..5044360ad8a 100644 --- a/xml/System.IdentityModel.Services/FederatedAuthenticationSessionEndingException.xml +++ b/xml/System.IdentityModel.Services/FederatedAuthenticationSessionEndingException.xml @@ -26,11 +26,11 @@ Indicates that the sign-in session should being terminated, and the current request is unauthenticated. - to indicate that the current sign-in session should be terminated. - + to indicate that the current sign-in session should be terminated. + ]]> diff --git a/xml/System.IdentityModel.Services/FederatedPassiveSecurityTokenServiceOperations.xml b/xml/System.IdentityModel.Services/FederatedPassiveSecurityTokenServiceOperations.xml index 48458da0c94..fa01824b80d 100644 --- a/xml/System.IdentityModel.Services/FederatedPassiveSecurityTokenServiceOperations.xml +++ b/xml/System.IdentityModel.Services/FederatedPassiveSecurityTokenServiceOperations.xml @@ -24,7 +24,7 @@ ## Examples - The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT), and it includes an implementation of a passive STS that is capable of serving an SWT token. For information about this sample and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. + The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT), and it includes an implementation of a passive STS that is capable of serving an SWT token. For information about this sample and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/default.aspx.cs" id="Snippet1"::: @@ -74,7 +74,7 @@ method from the code behind in the `default.aspx.cs` file. + The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT), and it includes an implementation of a passive STS that is capable of serving an SWT token. For information about this sample and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/default.aspx.cs" id="Snippet1"::: @@ -258,7 +258,7 @@ returned from one of the overloaded methods. + This typical usage of this method is to process the returned from one of the overloaded methods. ]]> diff --git a/xml/System.IdentityModel.Services/HttpModuleBase.xml b/xml/System.IdentityModel.Services/HttpModuleBase.xml index 035e6f27d37..524dc989426 100644 --- a/xml/System.IdentityModel.Services/HttpModuleBase.xml +++ b/xml/System.IdentityModel.Services/HttpModuleBase.xml @@ -120,9 +120,9 @@ method by initializing the property to the value of the property, invoking the method, and then invoking the method. + This method implements the method by initializing the property to the value of the property, invoking the method, and then invoking the method. - Derived classes override the and methods. + Derived classes override the and methods. ]]> @@ -153,7 +153,7 @@ method to load any additional configuration state as well as to register event handling methods with specific events raised by the object. When this method is called from the method, the property has already been initialized. You can get the configuration object that is in effect for this module from this property. The property should be used for all token processing in this module. + Use the method to load any additional configuration state as well as to register event handling methods with specific events raised by the object. When this method is called from the method, the property has already been initialized. You can get the configuration object that is in effect for this module from this property. The property should be used for all token processing in this module. ]]> @@ -181,7 +181,7 @@ method, the property has already been initialized. You can get the configuration object that is in effect for this module from this property. + When this method is called from the method, the property has already been initialized. You can get the configuration object that is in effect for this module from this property. ]]> diff --git a/xml/System.IdentityModel.Services/SessionAuthenticationModule.xml b/xml/System.IdentityModel.Services/SessionAuthenticationModule.xml index cead74a820c..8daf28068c6 100644 --- a/xml/System.IdentityModel.Services/SessionAuthenticationModule.xml +++ b/xml/System.IdentityModel.Services/SessionAuthenticationModule.xml @@ -21,13 +21,13 @@ ## Remarks When present in the ASP.NET pipeline, the (SAM) processes session cookies in WS-Federation scenarios. It uses the cookie handler specified by the property to read the raw session cookie from the HTTP request and write it to the HTTP response. It uses the that is configured for an application to deserialize the raw session cookie into objects. The session security token contains the claims () and principal () associated with the entity for which the request is being served. - The SAM adds its event handler to the event in the ASP.NET pipeline. This handler intercepts sign-in requests, and, if there is a session cookie, deserializes it into a session token, and sets the and properties to the claims principal contained in the session token. It invokes several of the other methods exposed by the SAM during this process. + The SAM adds its event handler to the event in the ASP.NET pipeline. This handler intercepts sign-in requests, and, if there is a session cookie, deserializes it into a session token, and sets the and properties to the claims principal contained in the session token. It invokes several of the other methods exposed by the SAM during this process. - The method can be invoked to sign the user out of a session (for example, in a SignOut.aspx.cs code-behind file). + The method can be invoked to sign the user out of a session (for example, in a SignOut.aspx.cs code-behind file). The SAM exposes several events that provide access to its processing pipeline. The and events enable you to modify session tokens that are read from cookies or created during processing. Typically, this is done to add, remove, or transform claims in the token or to adjust its expiration time. The , , and events provide hooks into the processing of sign-out requests. For many scenarios, simply adding handlers for these events, often to the global.asax.cs file, will be sufficient. - For more complicated scenarios, you can derive from to implement a custom SAM. To this end, many of the methods that are invoked during and are exposed so that you can provide custom behavior at specific stages of the session processing lifecycle. + For more complicated scenarios, you can derive from to implement a custom SAM. To this end, many of the methods that are invoked during and are exposed so that you can provide custom behavior at specific stages of the session processing lifecycle. You can add the SAM to the ASP.NET pipeline in a configuration file by adding it to the HTTP modules under either the `` element for IIS version 7 and later or under the `` element for versions prior to IIS 7. The cookie handler used by the SAM can be configured with the [<cookieHandler>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/cookiehandler) element. @@ -106,7 +106,7 @@ method is called from the method. It calls the method to validate the incoming token and update the and the properties. If the `writeCookie` parameter is `true`, the method is invoked to write the session token to a cookie. + The method is called from the method. It calls the method to validate the incoming token and update the and the properties. If the `writeCookie` parameter is `true`, the method is invoked to write the session token to a cookie. ]]> @@ -183,7 +183,7 @@ property is initialized by the method. This method initializes the property based on the cookie handler specified on the object that is set on the property. You can set the cookie handler in a configuration file through the [<cookieHandler>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/cookiehandler) element. + The property is initialized by the method. This method initializes the property based on the cookie handler specified on the object that is set on the property. You can set the cookie handler in a configuration file through the [<cookieHandler>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/cookiehandler) element. ]]> @@ -249,7 +249,7 @@ property. This method is called during sign-out by the method. + Deletes the session cookie by using the cookie handler specified by the property. This method is called during sign-out by the method. ]]> @@ -280,7 +280,7 @@ and the handlers to the and events of the application object specified by the `context` parameter. + Adds the and the handlers to the and events of the application object specified by the `context` parameter. ]]> @@ -375,19 +375,19 @@ ## Remarks This method does the following: -1. Invokes the method to read a from the session cookie, if one is present. +1. Invokes the method to read a from the session cookie, if one is present. 2. If a session security token cannot be read (most likely because a session has not been established), return. -3. Invokes the method to raise the event. This provides an opportunity for the token read from the cookie to be modified or for the request to be canceled. The handler can also specify that the token should be reissued, by setting the property. +3. Invokes the method to raise the event. This provides an opportunity for the token read from the cookie to be modified or for the request to be canceled. The handler can also specify that the token should be reissued, by setting the property. -4. If the token is to be reissued, removes it from the cache and invokes the method to raise the event. This provides opportunity for the token to again be modified. The reissue behavior can also be modified by setting the property in the event handler. +4. If the token is to be reissued, removes it from the cache and invokes the method to raise the event. This provides opportunity for the token to again be modified. The reissue behavior can also be modified by setting the property in the event handler. -5. Invokes the method to authenticate the user. If successful, this has the effect of setting the property to the principal that is contained in the property of the incoming token. +5. Invokes the method to authenticate the user. If successful, this has the effect of setting the property to the principal that is contained in the property of the incoming token. -6. If the session has expired, invokes the method. +6. If the session has expired, invokes the method. - The method is added to the handlers for the event in the method. + The method is added to the handlers for the event in the method. ]]> @@ -423,7 +423,7 @@ ## Remarks The default implementation is empty. - The handler is added to the handlers for the event in the method. + The handler is added to the handlers for the event in the method. ]]> @@ -454,7 +454,7 @@ method. + Called from the method. ]]> @@ -485,7 +485,7 @@ method. + Called from the method. ]]> @@ -516,7 +516,7 @@ method after the sign-out has been performed and the session cookie has been deleted. + This method is invoked from the method after the sign-out has been performed and the session cookie has been deleted. ]]> @@ -547,7 +547,7 @@ method to perform sign-out. It is invoked before the session cookie is deleted. + This method is invoked from the method to perform sign-out. It is invoked before the session cookie is deleted. ]]> @@ -578,7 +578,7 @@ method if an error occurs during sign-out. + This method is invoked from the method if an error occurs during sign-out. ]]> @@ -634,7 +634,7 @@ ## Remarks You can use this event to modify the session security token before it is written to a cookie. - The event is raised from within the method after a session token () has been created. This happens, for example, if an event handler for the event modifies the token. + The event is raised from within the method after a session token () has been created. This happens, for example, if an event handler for the event modifies the token. You can use this event to modify properties of the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user). @@ -673,7 +673,7 @@ event is raised from within the method after a session token () has been successfully read from the session cookie. + The event is raised from within the method after a session token () has been successfully read from the session cookie. You can use this event to modify properties of the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user). One of the most common scenarios involves modifying the session expiration time (accessible through the property) to override the session expiration time set in configuration through the `lifetime` attribute of the [<sessionTokenRequirement>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/sessiontokenrequirement) element. By modifying this property on each request, you can implement a sliding session; that is, a session in which the lifetime is extended each time the user accesses the site. @@ -715,9 +715,9 @@ method and sets the property and the property on using the identities that are returned. + Invokes the method and sets the property and the property on using the identities that are returned. - This method is called from the method. + This method is called from the method. ]]> @@ -745,7 +745,7 @@ method just after the method is invoked. + Raised from the method just after the method is invoked. This event is not guaranteed to be called for every session. For example, the cookies may be deleted at the client-side, in which case, this event would never be raised because there is no server-side event for deleting the session. @@ -782,7 +782,7 @@ method just before the method is invoked. + Raised from the method just before the method is invoked. This event is not guaranteed to be called for every session. For example, the cookies may be deleted at the client-side, in which case, this event would never be raised because there is no server-side event for deleting the session. @@ -819,14 +819,14 @@ , , and methods to perform sign-out. If an exception occurs, the method is invoked to raise the event. You can set the property of the object passed into the event handler for this event to cancel the sign-out and prevent the exception from being propagated to the client. + Invokes the , , and methods to perform sign-out. If an exception occurs, the method is invoked to raise the event. You can set the property of the object passed into the event handler for this event to cancel the sign-out and prevent the exception from being propagated to the client. You can override this method to add application-specific behavior. ## Examples - The following code shows code for invoking the method from a SignOut.aspx page (SignOut.aspx.cs) in an ASP.NET web application. A more complete example is shown in the overview topic. + The following code shows code for invoking the method from a SignOut.aspx page (SignOut.aspx.cs) in an ASP.NET web application. A more complete example is shown in the overview topic. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Services/SessionAuthenticationModule/Overview/global.asax.cs" id="Snippet7"::: @@ -856,7 +856,7 @@ method when an error occurs during sign-out. + Raised from the method when an error occurs during sign-out. In an event handler, you can get the exception that resulted in the event being raised from the property. You can cancel further processing of the exception, which has the result of not propagating the exception to the client, by setting the property of the to `true`. @@ -900,7 +900,7 @@ property and then invokes the method to read the token from the cookie. + Reads the cookie by using the cookie handler that is configured in the property and then invokes the method to read the token from the cookie. ]]> @@ -932,7 +932,7 @@ method. It invokes the method of the configured session token handler to validate the token and extract its identities. + This method is called from the method. It invokes the method of the configured session token handler to validate the token and extract its identities. ]]> diff --git a/xml/System.IdentityModel.Services/SessionSecurityTokenCreatedEventArgs.xml b/xml/System.IdentityModel.Services/SessionSecurityTokenCreatedEventArgs.xml index da7b6978bbe..ac1832c0d95 100644 --- a/xml/System.IdentityModel.Services/SessionSecurityTokenCreatedEventArgs.xml +++ b/xml/System.IdentityModel.Services/SessionSecurityTokenCreatedEventArgs.xml @@ -21,7 +21,7 @@ ## Remarks By default: -- In the session authentication module (SAM) the event is raised from within the method after a session token () has been created. This happens, for example, if an event handler for the event modifies the token. You can use the to modify the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user). +- In the session authentication module (SAM) the event is raised from within the method after a session token () has been created. This happens, for example, if an event handler for the event modifies the token. You can use the to modify the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user). - In the WS-Federation authentication module (WSFAM), the event is raised from the request processing pipeline just after a session token has been created from the WS-Federation sign-in response message received from the STS and just before the SAM is called to set the thread principal and write the session cookie. diff --git a/xml/System.IdentityModel.Services/SessionSecurityTokenReceivedEventArgs.xml b/xml/System.IdentityModel.Services/SessionSecurityTokenReceivedEventArgs.xml index 005b4ebd589..66cf1fcd88d 100644 --- a/xml/System.IdentityModel.Services/SessionSecurityTokenReceivedEventArgs.xml +++ b/xml/System.IdentityModel.Services/SessionSecurityTokenReceivedEventArgs.xml @@ -19,7 +19,7 @@ event is raised from within the method after a session token () has been successfully read from the session cookie. In the event handler, you can modify properties of the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user). + By default, the event is raised from within the method after a session token () has been successfully read from the session cookie. In the event handler, you can modify properties of the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user). You can access the token through the property. After modifying the token, you can ensure that it is written back to the cookie by setting the to `true`. Finally, the event is a cancelable event, and you can set the property (inherited from ) to abort further processing of the request. diff --git a/xml/System.IdentityModel.Services/SignInRequestMessage.xml b/xml/System.IdentityModel.Services/SignInRequestMessage.xml index eaae7ed26ff..5928299c4fc 100644 --- a/xml/System.IdentityModel.Services/SignInRequestMessage.xml +++ b/xml/System.IdentityModel.Services/SignInRequestMessage.xml @@ -14,24 +14,22 @@ - Represents a WS-Federation Sign-In Request message. + Represents a WS-Federation sign-in request message. message is created by the static methods of the class, for example the method, when the wa parameter is set to "wsignin1.0", there is no wresult or wresultptr parameter present, and either a wtrealm parameter or a wreply parameter is present. + A message is created by the static methods of the class, for example the method, when the wa parameter is set to "wsignin1.0", there is no `wresult` or `wresultptr` parameter present, and either a `wtrealm` parameter or a `wreply` parameter is present. > [!IMPORTANT] -> For backward compatibility with Active Directory Federation Services (AD FS) version 1.0, Windows Identity Foundation (WIF) allows either the wtrealm parameter or the wreply parameter to be set (or both) for a sign-in message to be valid; however, the WS-Federation protocol requires that the wtrealm parameter be present in a sign-in request. In most scenarios, you should ensure that the wtrealm parameter is specified. +> For backward compatibility with Active Directory Federation Services (AD FS) version 1.0, Windows Identity Foundation (WIF) allows either the wtrealm parameter or the wreply parameter to be set (or both) for a sign-in message to be valid; however, the WS-Federation protocol requires that the wtrealm parameter be present in a sign-in request. In most scenarios, you should ensure that the wtrealm parameter is specified. The class exposes several properties that can be used to set or access individual message parameters. These parameters can also be set or accessed through the dictionary. For example, you can read the wtrealm parameter in the message either through the property or by specifying "wtrealm" as the key to the dictionary. [!INCLUDE[wif_wsfed_ref](~/includes/wif-wsfed-ref-md.md)] - - ## Examples :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Services/SignInRequestMessage/Overview/default.aspx.cs" id="Snippet2"::: @@ -439,7 +437,7 @@ method is invoked to perform the serialization. + The string contains a URL (including query parameters) that is created by serializing the current instance. The method is invoked to perform the serialization. ]]> @@ -535,7 +533,7 @@ method before writing the message. + This method calls the method before writing the message. ]]> diff --git a/xml/System.IdentityModel.Services/SignInResponseMessage.xml b/xml/System.IdentityModel.Services/SignInResponseMessage.xml index 017ba50462c..66cb754ec37 100644 --- a/xml/System.IdentityModel.Services/SignInResponseMessage.xml +++ b/xml/System.IdentityModel.Services/SignInResponseMessage.xml @@ -247,7 +247,7 @@ method before writing the message. + This method calls the method before writing the message. ]]> diff --git a/xml/System.IdentityModel.Services/SignOutCleanupRequestMessage.xml b/xml/System.IdentityModel.Services/SignOutCleanupRequestMessage.xml index 7e242bae267..dab5b3e7a4c 100644 --- a/xml/System.IdentityModel.Services/SignOutCleanupRequestMessage.xml +++ b/xml/System.IdentityModel.Services/SignOutCleanupRequestMessage.xml @@ -174,7 +174,7 @@ method before writing the message. + This method calls the method before writing the message. ]]> diff --git a/xml/System.IdentityModel.Services/SignOutRequestMessage.xml b/xml/System.IdentityModel.Services/SignOutRequestMessage.xml index 45290d61018..642ed1c572b 100644 --- a/xml/System.IdentityModel.Services/SignOutRequestMessage.xml +++ b/xml/System.IdentityModel.Services/SignOutRequestMessage.xml @@ -21,7 +21,7 @@ ## Remarks A WS-Federation sign-out message is sent by a relying party (RP) to a security token service (STS) to sign out of the current session with that STS. The wa parameter must be set to "wsignout1.0" and an optional wreply parameter may be set to indicate the URL to which the client should be redirected by the STS after sign-out completes. - A message is created by the static methods of the class, for example the method, when the wa parameter is set to "wsignout1.0". + A message is created by the static methods of the class, for example the method, when the wa parameter is set to "wsignout1.0". [!INCLUDE[wif_wsfed_ref](~/includes/wif-wsfed-ref-md.md)] @@ -187,7 +187,7 @@ method before writing the message. + This method calls the method before writing the message. ]]> diff --git a/xml/System.IdentityModel.Services/WSFederationAuthenticationModule.xml b/xml/System.IdentityModel.Services/WSFederationAuthenticationModule.xml index 3cf386cb5c9..352f097163c 100644 --- a/xml/System.IdentityModel.Services/WSFederationAuthenticationModule.xml +++ b/xml/System.IdentityModel.Services/WSFederationAuthenticationModule.xml @@ -74,11 +74,11 @@ - : Raised if an exception occurs during sign-out. You can cancel sign-out and prevent the exception from being returned to the caller. > [!NOTE] -> The sign-out events are not raised when signing out at the STS by calling the method. +> The sign-out events are not raised when signing out at the STS by calling the method. - There are two ways of signing in to an STS using WSFAM. The first is by enabling passive redirects through the property. In this case, when authorization fails on a requested resource, rather than returning a `401:Access Denied` response to the client, WSFAM builds a WS-Federation sign-in request message from its properties and redirects the client to the STS to retrieve a security token. The second way is to explicitly redirect the client to the STS by calling the method from a web page or custom control in your application. The method also uses the properties of the WSFAM to construct the sign-in request. + There are two ways of signing in to an STS using WSFAM. The first is by enabling passive redirects through the property. In this case, when authorization fails on a requested resource, rather than returning a `401:Access Denied` response to the client, WSFAM builds a WS-Federation sign-in request message from its properties and redirects the client to the STS to retrieve a security token. The second way is to explicitly redirect the client to the STS by calling the method from a web page or custom control in your application. The method also uses the properties of the WSFAM to construct the sign-in request. - Any of the overloaded methods can be used to sign out of the session. This deletes the session cookie on the client. It does not send a WS-Federation sign-out message ("wsignout1.0") to the STS. To sign-out at the STS, you must use the method. + Any of the overloaded methods can be used to sign out of the session. This deletes the session cookie on the client. It does not send a WS-Federation sign-out message ("wsignout1.0") to the STS. To sign-out at the STS, you must use the method. The WSFAM handles WS-Federation sign-out clean-up requests ("wsignoutcleanup1.0"), by deleting its session with the client. If the wreply parameter in the sign-out clean-up message is not set, the WSFAM returns an image of a green check mark to the STS that sent the message. This feature can be used by an STS as an acknowledgment that the RP has completed its sign-out. @@ -176,7 +176,7 @@ event is raised when authorization has failed for an HTTP request. It is raised from within the event-handler delegate through a call to the method. + The event is raised when authorization has failed for an HTTP request. It is raised from within the event-handler delegate through a call to the method. You can set the property to control whether the request is redirected to the identity provider. The framework initializes this property to `false` if the user has already been authenticated. In this case, setting the property to `true` may cause a circular loop with the STS. @@ -240,7 +240,7 @@ ## Remarks This method is invoked from the request processing pipeline to determine whether the incoming HTTP request is a FORM post that contains a WS-Federation sign-in response message. - It invokes the overload with the `onPage` parameter set `false` to indicate that the call did not originate while processing a page. + It invokes the overload with the `onPage` parameter set `false` to indicate that the call did not originate while processing a page. ]]> @@ -280,15 +280,15 @@ overload to determine whether the incoming HTTP request is a form POST that contains a WS-Federation sign-in response message. + This method is invoked from the request processing pipeline through the overload to determine whether the incoming HTTP request is a form POST that contains a WS-Federation sign-in response message. The default implementation performs the following: -- If the incoming request is a form POST, it calls the method to determine whether the form POST contains a sign-in response. +- If the incoming request is a form POST, it calls the method to determine whether the form POST contains a sign-in response. -- If the incoming request is not a form POST, and the request contains a WS-Federation sign-out clean-up request (the wa parameter is "wsignoutcleanup1.0"), sign-out clean-up is performed. In this case, the method is invoked (with the parameter set to `true` to indicate a sign-out clean-up) to sign out of the session. This also causes the sign-out events to be raised. +- If the incoming request is not a form POST, and the request contains a WS-Federation sign-out clean-up request (the wa parameter is "wsignoutcleanup1.0"), sign-out clean-up is performed. In this case, the method is invoked (with the parameter set to `true` to indicate a sign-out clean-up) to sign out of the session. This also causes the sign-out events to be raised. - Next, if the sign-out clean-up request contains a wreply parameter, the client is redirected to the URL returned by the method; otherwise, an image of a green check mark is returned to the STS. The receipt of this image can be used by the STS as a confirmation that the sign-out clean-up request was received and successfully processed by the RP. + Next, if the sign-out clean-up request contains a wreply parameter, the client is redirected to the URL returned by the method; otherwise, an image of a green check mark is returned to the STS. The receipt of this image can be used by the STS as a confirmation that the sign-out clean-up request was received and successfully processed by the RP. ]]> @@ -337,13 +337,13 @@ The parameters passed to the method are used to create the wctx message parameter. This is a string with the following format: `ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId`. -- The `ru` value is set to the value of the `returnUrl` parameter passed in to the method and it specifies the URL that the module should direct the browser to following successful authentication. This is the only value stored in the wctx string that is used by the WSFAM. The module calls the method to extract this value from the wctx parameter when processing a WS-Federation sign-in response. It should not be confused with the wreply message parameter, which is specified by the property and which provides the address at the RP to which the security token service (STS) should direct its response. +- The `ru` value is set to the value of the `returnUrl` parameter passed in to the method and it specifies the URL that the module should direct the browser to following successful authentication. This is the only value stored in the wctx string that is used by the WSFAM. The module calls the method to extract this value from the wctx parameter when processing a WS-Federation sign-in response. It should not be confused with the wreply message parameter, which is specified by the property and which provides the address at the RP to which the security token service (STS) should direct its response. -- The `cx` parameter is set to the value of the property. This property is exposed to enable you to set any application-defined context that should be stored in the wctx string; however, WSFAM does not expose a method to extract this value in the response. If the value is needed by your application, you must provide the code to parse the wctx string and read this value when processing the response. You might accomplish this by overriding the method. +- The `cx` parameter is set to the value of the property. This property is exposed to enable you to set any application-defined context that should be stored in the wctx string; however, WSFAM does not expose a method to extract this value in the response. If the value is needed by your application, you must provide the code to parse the wctx string and read this value when processing the response. You might accomplish this by overriding the method. - Neither the `rm` value, which is set to the value of the `rememberMeSet` parameter, nor the `id` parameter, which is set to the value of the `uniqueId` parameter are used by WSFAM. These can be set to any value. - The method is called from the method. + The method is called from the method. ]]> @@ -388,14 +388,14 @@ 1. Creates a WS-Federation sign-out request message by using the specified parameters. -2. Calls the method on the SAM to delete the session cookie. +2. Calls the method on the SAM to delete the session cookie. 3. Redirects to the STS using the sign-out request message from the first step. - None of the sign-out events: , , or are raised by this method. To delete the session without sending a sign-out request message to the STS, call one of the overloaded methods. + None of the sign-out events: , , or are raised by this method. To delete the session without sending a sign-out request message to the STS, call one of the overloaded methods. > [!NOTE] -> To perform passive sign-out by using the session token, the module relies on a value that was stored in the property during sign-in, for more information, see the method. +> To perform passive sign-out by using the session token, the module relies on a value that was stored in the property during sign-in, for more information, see the method. ]]> @@ -505,7 +505,7 @@ method from inside the processing pipeline to resolve the URL specified in the wresultptr parameter in the sign-in response message received from a security token service (STS). + Called by the method from inside the processing pipeline to resolve the URL specified in the wresultptr parameter in the sign-in response message received from a security token service (STS). By default this method throws a . Override this method in a derived class to support the wresultptr parameter. The URL points to the issuance result, which should be one of the following: a `` element, a `` element, a SOAP response, or a SOAP `` element. @@ -540,11 +540,11 @@ method) to get the URL of the page at the relying party (RP) to direct the client to after successful sign-in. This is, typically, the URL of the RP resource to which the client originally requested access. + This method is called from the request processing pipeline (the method) to get the URL of the page at the relying party (RP) to direct the client to after successful sign-in. This is, typically, the URL of the RP resource to which the client originally requested access. By default, WSFAM saves the return URL inside the wctx message parameter when it sends the WS-Federation sign-in request to the security token service (STS). In accordance with the WS-Federation specification, the wctx parameter is preserved across entities through which the message passes and is returned unaltered in the WS-Federation sign-in response message that is sent by the STS. - The default implementation gets the return URL from the wctx parameter in the sign-in response. For more information about the format of the wctx parameter that is used by WSFAM, see the method. + The default implementation gets the return URL from the wctx parameter in the sign-in response. For more information about the format of the wctx parameter that is used by WSFAM, see the method. ]]> @@ -589,7 +589,7 @@ method to get the token and reads it by using the appropriate handler from the configured security token handlers. + The default implementation invokes the method to get the token and reads it by using the appropriate handler from the configured security token handlers. ]]> @@ -625,7 +625,7 @@ ## Remarks Called from the request processing pipeline to get the WS-Federation sign-in request message as a object. - The default implementation invokes the method to get a object and then invokes the overload. + The default implementation invokes the method to get a object and then invokes the overload. Use a derived class to interpret a specific type of request. @@ -658,7 +658,7 @@ method is called from the request processing pipeline when processing a WS-Federation sign-in response message to get the value to store in the property inside the session cookie. + The method is called from the request processing pipeline when processing a WS-Federation sign-in response message to get the value to store in the property inside the session cookie. You can override this method to provide an application-specific value to be stored in the cookie. WSFAM does not expose any methods to retrieve the value from the cookie. You must provide the logic in your application to read the value back from the cookie if it is needed. @@ -694,7 +694,7 @@ method in the request processing pipeline to get a sign-in response message from the form POST contained in the HTTP request. + Called from the method in the request processing pipeline to get a sign-in response message from the form POST contained in the HTTP request. ]]> @@ -729,7 +729,7 @@ method in the request processing pipeline to determine the URL to redirect to after processing a WS-Federation sign-out clean-up request. It is only invoked if the message has a wreply parameter (the `signOutMessage` parameter has a property that is neither `null` nor empty). + This method is called from the method in the request processing pipeline to determine the URL to redirect to after processing a WS-Federation sign-out clean-up request. It is only invoked if the message has a wreply parameter (the `signOutMessage` parameter has a property that is neither `null` nor empty). The default implementation validates the reply URL contained in the message (the property) against the address of the security token service (STS) that is specified by the property. The following conditions must be true for the reply URL to be valid: @@ -788,7 +788,7 @@ method is called to try to get the token using the wresultptr parameter. + If there is no wresult parameter in the sign-in response message, the method is called to try to get the token using the wresultptr parameter. ]]> @@ -886,12 +886,12 @@ |Event|Handler| |-----------|-------------| -||| -||| -||| +||| +||| +||| > [!NOTE] -> The module properties, such as , are initialized from the method. +> The module properties, such as , are initialized from the method. ]]> @@ -957,7 +957,7 @@ method in the request processing pipeline to determine whether the incoming HTTP request is a WS-Federation sign-in response message. + This method is called from the method in the request processing pipeline to determine whether the incoming HTTP request is a WS-Federation sign-in response message. The default implementation returns `true` if the wa parameter is "wsignin1.0" and the wreq and wreqptr parameters are not both set. @@ -1031,13 +1031,13 @@ method implements the WS-Federation request processing pipeline. It is added to the event in the ASP.NET pipeline by the method. + The method implements the WS-Federation request processing pipeline. It is added to the event in the ASP.NET pipeline by the method. The method performs the following: -1. Calls the method to determine whether a WS-Federation sign-in response message ("wsignin1.0") has been received. If the response is a WS-Federation sign-out clean-up request ("wsignoutcleanup1.0"), processes the message, terminates the request and redirects the client according to the WS-Federation parameters in the request. If the message is not a sign-in response or a sign-out clean-up request, the module just returns; otherwise it performs the following steps to process the sign-in response. +1. Calls the method to determine whether a WS-Federation sign-in response message ("wsignin1.0") has been received. If the response is a WS-Federation sign-out clean-up request ("wsignoutcleanup1.0"), processes the message, terminates the request and redirects the client according to the WS-Federation parameters in the request. If the message is not a sign-in response or a sign-out clean-up request, the module just returns; otherwise it performs the following steps to process the sign-in response. -2. Calls the method to deserialize a object from the request. +2. Calls the method to deserialize a object from the request. 3. Raises the event. You can cancel further processing or modify the received security token in a handler for this event. A handler is typically used to modify the or properties. @@ -1047,14 +1047,14 @@ 6. Uses the configured session authentication module (SAM) to create a object. (The configured SAM is the object returned by the property.) The session token is created by using the claims principal returned in step 5. The and properties are set by using the and properties of the returned in step 3 and are validated against the current time and the token lifetime specified by either the or the property of the object in the token handler collection being used by WSFAM. The token lifetime on the session token handler can be specified in configuration through the [<sessionTokenRequirement>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/sessiontokenrequirement) element. Note: The property on the cookie handler configured for the SAM is not used. -7. Calls the method with the session token to write the session cookie. The method first raises the event. You can change properties on the session token or change whether the cookie should be persisted in a handler for this event. After the event is raised, the method then writes the cookie using the SAM. +7. Calls the method with the session token to write the session cookie. The method first raises the event. You can change properties on the session token or change whether the cookie should be persisted in a handler for this event. After the event is raised, the method then writes the cookie using the SAM. > [!NOTE] > The set in configuration is not used to write the cookie. -8. Calls the method to raise the event. +8. Calls the method to raise the event. -9. Calls the method to get the RP page to which to redirect the client. By default, this method reads the return URL from the wctx parameter in the sign-in response. For more information about how WSFAM stores the return URL, see the method. +9. Calls the method to get the RP page to which to redirect the client. By default, this method reads the return URL from the wctx parameter in the sign-in response. For more information about how WSFAM stores the return URL, see the method. ]]> @@ -1085,7 +1085,7 @@ event-handler delegate when authorization has failed. + Called from the event-handler delegate when authorization has failed. Initializes the property before raising the event to prevent circular redirects if the user has already been authenticated. If the user is already authenticated, the property is initialized to `false` to prevent redirects; otherwise, it is initialized to `true`. @@ -1256,7 +1256,7 @@ method just after the session is deleted. + Called from the method just after the session is deleted. ]]> @@ -1312,7 +1312,7 @@ method just before the session is deleted. + Called from the method just before the session is deleted. ]]> @@ -1344,7 +1344,7 @@ method if an exception occurs during processing. + Called from the method if an exception occurs during processing. ]]> @@ -1377,7 +1377,7 @@ The module will not initiate WS-Federation protocol redirects when this mode is not enabled. If this property is `true`, the property must be set to the URL of the Security Token Service (STS) to which the caller should be redirected. > [!WARNING] -> Application code can issue WS-Federation sign-in requests explicitly by using the method, regardless of the value of the property. +> Application code can issue WS-Federation sign-in requests explicitly by using the method, regardless of the value of the property. ]]> @@ -1505,7 +1505,7 @@ ## Remarks You can access and modify the WS-Federation sign-in request through the property. For example, you can modify the property in the sign-in message to change the identity provider to which the request will be redirected. The event is a cancelable event and you can set the property to `true` to cancel the redirect. - The event is raised from inside the method through a call to the method. + The event is raised from inside the method through a call to the method. To handle this event in an ASP.NET application, create a method called `WSFederationAuthentication_RedirectingToIdentityProvider` in the global.asax file. @@ -1557,17 +1557,17 @@ method is called from the method when the request is issued from a web page presented by the relying party (RP) or from the event-handler delegate to perform a passive redirect to the identity provider on authorization failure. + The method is called from the method when the request is issued from a web page presented by the relying party (RP) or from the event-handler delegate to perform a passive redirect to the identity provider on authorization failure. The parameters passed to the method are used to create the wctx message parameter. The only significant parameter is the `returnUrl` parameter. This specifies the URL that the RP should direct the browser to following successful authentication. It should not be confused with the wreply message parameter, which is specified by the property and which provides the address at the RP to which the security token service (STS) should direct its response. The method performs the following: -1. Invokes the method to ensure that a valid sign-in request can be issued by the module. +1. Invokes the method to ensure that a valid sign-in request can be issued by the module. -2. Invokes the method to create the sign-in request from the properties configured on the module. +2. Invokes the method to create the sign-in request from the properties configured on the module. -3. Invokes the method to raise the event. You can cancel the redirect or modify the sign-in request message in the event handler for this event. +3. Invokes the method to raise the event. You can cancel the redirect or modify the sign-in request message in the event handler for this event. ]]> @@ -1757,7 +1757,7 @@ ## Remarks You can add an event handler to modify the token before it is validated. In the event handler you can access the security token through the property. The event is a cancelable event, you can set the property to `true` in an event handler to terminate processing of the WS-Federation sign-in response message. - This event is raised from inside the event-handler delegate when processing a WS-Federation sign-in response message ("wsignin1.0") received from the security token service (STS). It is raised just after a security token has been deserialized from the wresult or the wresultptr parameter in the sign-in response message, but before the security token is validated. + This event is raised from inside the event-handler delegate when processing a WS-Federation sign-in response message ("wsignin1.0") received from the security token service (STS). It is raised just after a security token has been deserialized from the wresult or the wresultptr parameter in the sign-in response message, but before the security token is validated. @@ -1793,7 +1793,7 @@ ## Remarks You can add an event handler to modify the principal created while processing a WS-Federation sign-in response message from a security token service (STS) before it is used to create the session token. In the event handler, you can access the principal through the property. The event is a cancelable event, you can set the property to `true` in an event handler to terminate processing of the WS-Federation sign-in response message. - This event is raised from inside the event-handler delegate when processing a WS-Federation sign-in response message ("wsignin1.0") received from the security token service (STS). It is raised just after the security token that was deserialized from the wresult or the wresultptr parameter in the sign-in response message has been validated, and before the session security token is created. + This event is raised from inside the event-handler delegate when processing a WS-Federation sign-in response message ("wsignin1.0") received from the security token service (STS). It is raised just after the security token that was deserialized from the wresult or the wresultptr parameter in the sign-in response message has been validated, and before the session security token is created. @@ -1828,7 +1828,7 @@ ## Remarks You can add an event handler to modify the session token before it is used to set the thread principal and is written to the session cookie. In the event handler, you can access the session token through the property. You can specify whether a session cookie should be written by setting the property. - This event is raised from inside the event-handler delegate when processing a WS-Federation sign-in response message ("wsignin1.0") received from the security token service (STS). It is raised just after the security token that was deserialized from the wresult or the wresultptr parameter in the sign-in response message has been validated, and before the claims principal is set on the (and on the property of ). + This event is raised from inside the event-handler delegate when processing a WS-Federation sign-in response message ("wsignin1.0") received from the security token service (STS). It is raised just after the security token that was deserialized from the wresult or the wresultptr parameter in the sign-in response message has been validated, and before the claims principal is set on the (and on the property of ). > [!IMPORTANT] > To operate sessions in reference mode, Microsoft recommends providing a handler for the event in the global.asax.cs file and setting the property on the token passed in the property. This will ensure that the session token operates in reference mode for every request and is favored over merely setting the property on the Session Authentication Module. @@ -1870,11 +1870,11 @@ event-handler delegate. This method does the following: + Called from the request processing pipeline implemented in the event-handler delegate. This method does the following: -1. Invokes the method to raise the event. You can use this event to modify the session token before it is used to set the thread principal and written to the session cookie and to specify whether the session cookie should be written. +1. Invokes the method to raise the event. You can use this event to modify the session token before it is used to set the thread principal and written to the session cookie and to specify whether the session cookie should be written. -2. Invokes the method on the configured session authentication module () to set the thread principal and optionally write the session cookie. +2. Invokes the method on the configured session authentication module () to set the thread principal and optionally write the session cookie. ]]> @@ -1938,7 +1938,7 @@ method from inside the method while signing out of the session at the relying party (RP). The event is not raised when doing federated sign-out through the method. + This event is raised through a call to the method from inside the method while signing out of the session at the relying party (RP). The event is not raised when doing federated sign-out through the method. You can add an event handler to perform any additional processing that is needed by your application after the session cookie has been deleted. @@ -1973,7 +1973,7 @@ method to perform the sign-in. + The default implementation invokes the method to perform the sign-in. ]]> @@ -2001,11 +2001,11 @@ method is invoked, the sign-in message that is generated contains a wctx parameter that has the following format: `ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId`. The value of the is stored in the `cx` parameter. can be called directly from your code. It is also called when the WSFAM is performing passive redirects and also when either the method or the method is invoked by application code. + When the method is invoked, the sign-in message that is generated contains a wctx parameter that has the following format: `ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId`. The value of the is stored in the `cx` parameter. can be called directly from your code. It is also called when the WSFAM is performing passive redirects and also when either the method or the method is invoked by application code. Although the WSFAM saves the value in sign-in request messages, if the value is used by your application during response processing, you must provide the logic for extracting it from the wctx parameter in the sign-in response message. - For more information about the format and processing of the wctx parameter, see the method. + For more information about the format and processing of the wctx parameter, see the method. ]]> @@ -2062,7 +2062,7 @@ method from inside the method while signing out of the session at the relying party (RP). The event is not raised when doing federated sign-out through the method. + This event is raised through a call to the method from inside the method while signing out of the session at the relying party (RP). The event is not raised when doing federated sign-out through the method. You can add an event handler to perform any additional processing that is needed by your application before the session cookie is deleted. You can read the property in the event handler to determine whether the sign-out is the result of receiving a WS-Federation sign-out clean-up request message ("wsignoutcleanup1.0") from a security token service (STS) or whether it was initiated at the RP. @@ -2116,7 +2116,7 @@ ## Remarks Deletes the current session. - No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. + No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. ]]> @@ -2146,9 +2146,9 @@ ## Remarks Deletes the current session and redirects the browser back to the URL specified in the current HTTP request. - Invokes the method with the `redirectUrl` parameter set to the URL of the current request. + Invokes the method with the `redirectUrl` parameter set to the URL of the current request. - No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. + No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. ]]> @@ -2182,17 +2182,17 @@ ## Remarks This method performs the actual work of deleting the current session and raising the appropriate sign-out events. The method does the following: -1. Invokes the method to raise the event. An event handler can provide any necessary processing before the session is deleted. The property is set according to the `isIPRequest` parameter. +1. Invokes the method to raise the event. An event handler can provide any necessary processing before the session is deleted. The property is set according to the `isIPRequest` parameter. -2. Calls the method on the current session authentication manager to delete the session cookie. +2. Calls the method on the current session authentication manager to delete the session cookie. - Invokes the method to raise the event. + Invokes the method to raise the event. -3. If an error occurs during sign-out processing, invokes the method to raise the event. An event handler can cancel the processing and prevent an exception from being returned to the caller of +3. If an error occurs during sign-out processing, invokes the method to raise the event. An event handler can cancel the processing and prevent an exception from being returned to the caller of - You can call the method with the `isIPRequest` parameter set `false` to sign out of a session without performing a redirect. The method is ultimately called by all of the other overloaded methods (with the `isIPRequest` parameter set to `false`) to perform the sign out handling. The method is called from the method with the `isIPRequest` parameter set `true` to sign out of the session when it is processing a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"). + You can call the method with the `isIPRequest` parameter set `false` to sign out of a session without performing a redirect. The method is ultimately called by all of the other overloaded methods (with the `isIPRequest` parameter set to `false`) to perform the sign out handling. The method is called from the method with the `isIPRequest` parameter set `true` to sign out of the session when it is processing a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"). - No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. + No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. ]]> @@ -2225,9 +2225,9 @@ ## Remarks Deletes the current session and redirects the browser back to the specified URL. - Invokes the method with the `redirectUrl` parameter and with the `initiateSignoutCleanup` set `false`. + Invokes the method with the `redirectUrl` parameter and with the `initiateSignoutCleanup` set `false`. - No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. + No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. ]]> @@ -2264,9 +2264,9 @@ ## Remarks Deletes the current session and redirects the browser back to the specified URL. - Invokes the method with the `initiateSignoutCleanup` parameter set `false`. + Invokes the method with the `initiateSignoutCleanup` parameter set `false`. - No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. + No sign-out request message ("wsignout1.0") is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the method. ]]> @@ -2297,7 +2297,7 @@ method from inside the method while signing out of the session at the relying party (RP). The event is not raised when doing federated sign-out through the method. + This event is raised through a call to the method from inside the method while signing out of the session at the relying party (RP). The event is not raised when doing federated sign-out through the method. The event is a cancellable event. You can set the property in an event handler to prevent the exception that caused the error from being returned to the initiator of the sign-out. @@ -2329,7 +2329,7 @@ ## Remarks By default, this property is initialized from the `signOutQueryString` attribute of the [<wsFederation>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/wsfederation) element in the configuration file. It is intended to contain any application-specific parameters to be sent in a WS-Federation sign-out request. To remove these parameters, you can set the property to an empty string. - The WSFAM does not use this property directly; however, you can pass it to the method to create a complete WS-Federation sign-out URL that can then be used by your code. + The WSFAM does not use this property directly; however, you can pass it to the method to create a complete WS-Federation sign-out URL that can then be used by your code. ]]> @@ -2362,7 +2362,7 @@ The wreply parameter is optional. If the property is set to `null` or an empty string, the wreply parameter is not included in the sign-out request. - The WSFAM does not use this property directly. However, you can pass it to the method when performing WS-Federation sign-out from your code or you can pass it to the method to create a complete WS-Federation sign-out URL. + The WSFAM does not use this property directly. However, you can pass it to the method when performing WS-Federation sign-out from your code or you can pass it to the method to create a complete WS-Federation sign-out URL. ]]> diff --git a/xml/System.IdentityModel.Services/WSFederationMessage.xml b/xml/System.IdentityModel.Services/WSFederationMessage.xml index c9b4cac54a0..8868aa06153 100644 --- a/xml/System.IdentityModel.Services/WSFederationMessage.xml +++ b/xml/System.IdentityModel.Services/WSFederationMessage.xml @@ -148,7 +148,7 @@ ## Remarks If a message can be created, the method returns an appropriate implementation of based on the wa parameter submitted in the form post; for example, if wa parameter is "wsignout1.0" then a object is returned. - Gets the base URL and the collection of form variables submitted by the client from the request and invokes the method. + Gets the base URL and the collection of form variables submitted by the client from the request and invokes the method. ]]> @@ -238,7 +238,7 @@ Other exceptions may be thrown depending on the combination and values of parameters present in the query string. - Invokes the method. + Invokes the method. ]]> @@ -308,7 +308,7 @@ ## Remarks If a message can be created, the method returns an appropriate implementation of based on the wa parameter in the query string; for example, if wa parameter is "wsignout1.0" then a object is returned. - Invokes the method. + Invokes the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/AggregateTokenResolver.xml b/xml/System.IdentityModel.Tokens/AggregateTokenResolver.xml index b15263c0c29..e7cef39a334 100644 --- a/xml/System.IdentityModel.Tokens/AggregateTokenResolver.xml +++ b/xml/System.IdentityModel.Tokens/AggregateTokenResolver.xml @@ -139,7 +139,7 @@ method is called by the and methods. + The method is called by the and methods. ]]> @@ -184,7 +184,7 @@ method is called by the and methods. + The method is called by the and methods. ]]> @@ -229,7 +229,7 @@ method is called by the and methods. + The method is called by the and methods. ]]> diff --git a/xml/System.IdentityModel.Tokens/BinaryKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/BinaryKeyIdentifierClause.xml index e019fd41cb2..a1f3466a113 100644 --- a/xml/System.IdentityModel.Tokens/BinaryKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/BinaryKeyIdentifierClause.xml @@ -27,11 +27,11 @@ Represents a base class for key identifier clauses that are based upon binary data. - does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of the SOAP message. These references typically affirm the authenticity of the issued security token. - + does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of the SOAP message. These references typically affirm the authenticity of the issued security token. + ]]> @@ -121,13 +121,13 @@ The size of the derived key. Sets the value of the property. Initializes a new instance of the class using the specified key identifier clause type, binary data, a value that indicates whether the binary data must be cloned, a nonce and the key length. - method always returns a clone of the array passed into the `identificationData` parameter. - + method always returns a clone of the array passed into the `identificationData` parameter. + ]]> @@ -165,11 +165,11 @@ Gets the binary data that represents the key identifier. An array of that contains the binary data that represents the key identifier. - method always returns a clone of the array passed into the constructor's `identificationData` parameter. - + method always returns a clone of the array passed into the constructor's `identificationData` parameter. + ]]> @@ -204,13 +204,13 @@ Gets the binary data that represents the key identifier. An array of that contains the binary data that represents the key identifier. - method is a clone of the constructor's `identificationData` parameter when the value passed into the `cloneBuffer` is `true`; otherwise it is same array. - - The method always returns a clone of the array passed into the constructor's `identificationData` parameter. - + method is a clone of the constructor's `identificationData` parameter when the value passed into the `cloneBuffer` is `true`; otherwise it is same array. + + The method always returns a clone of the array passed into the constructor's `identificationData` parameter. + ]]> diff --git a/xml/System.IdentityModel.Tokens/BootstrapContext.xml b/xml/System.IdentityModel.Tokens/BootstrapContext.xml index 7748333cf16..a34dac3e5db 100644 --- a/xml/System.IdentityModel.Tokens/BootstrapContext.xml +++ b/xml/System.IdentityModel.Tokens/BootstrapContext.xml @@ -104,18 +104,18 @@ The handler with which to serialize the token. Initializes a new instance of the class by using the specified security token and token handler. - - is . - - -or- - + is . + + -or- + is . @@ -194,11 +194,11 @@ Gets the security token that was used to initialize the context. The security token or . - constructor was used; otherwise it is `null`. - + constructor was used; otherwise it is `null`. + ]]> @@ -222,11 +222,11 @@ Gets the token handler that was used to initialize the context. The token handler or . - constructor was used; otherwise it is `null`. - + constructor was used; otherwise it is `null`. + ]]> @@ -250,11 +250,11 @@ Gets the string that was used to initialize the context. The string that was used to initialize the context or . - constructor was used; otherwise it is `null`. - + constructor was used; otherwise it is `null`. + ]]> @@ -278,11 +278,11 @@ Gets the array that was used to initialize the context. The array that was used to initialize the context or . - constructor was used; otherwise it is `null`. - + constructor was used; otherwise it is `null`. + ]]> diff --git a/xml/System.IdentityModel.Tokens/ConfigurationBasedIssuerNameRegistry.xml b/xml/System.IdentityModel.Tokens/ConfigurationBasedIssuerNameRegistry.xml index 643aad693e2..47e51b6f00d 100644 --- a/xml/System.IdentityModel.Tokens/ConfigurationBasedIssuerNameRegistry.xml +++ b/xml/System.IdentityModel.Tokens/ConfigurationBasedIssuerNameRegistry.xml @@ -23,7 +23,7 @@ The map of trusted issuers is specified in a configuration file by adding entries under the [<trustedIssuers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/trustedissuers) element. The `` element is a child element of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element and it is valid when the class is specified in the `type` attribute of that element. For more information, see the documentation for each of these elements in the [WIF Configuration Schema](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/). For more information about issuer name registries, see the class. - You can derive from to implement your own configuration based issuer name registry. Which methods you override will depend upon your implementation. For example, you can override the method to load configuration from a custom configuration schema. + You can derive from to implement your own configuration based issuer name registry. Which methods you override will depend upon your implementation. For example, you can override the method to load configuration from a custom configuration schema. @@ -94,7 +94,7 @@ dictionary. In derived classes, you can call this method from the method to add issuers to the dictionary. + You can call this method to add issuers to the dictionary. In derived classes, you can call this method from the method to add issuers to the dictionary. ]]> @@ -129,7 +129,7 @@ method. + The key to the dictionary is the ASN.1 encoded form of the thumbprint of the trusted issuer's certificate and the value is the issuer name. The dictionary contains the issuers that were specified in configuration and any additional issuers that have been added with the method. ]]> @@ -194,7 +194,7 @@ method is called by the configuration infrastructure. When this method is called, the `nodelist` will contain the top-level child elements of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element from the configuration file. Each of these may, in turn, contain attributes or child elements depending on the configuration schema you define for your derived class. + The method is called by the configuration infrastructure. When this method is called, the `nodelist` will contain the top-level child elements of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element from the configuration file. Each of these may, in turn, contain attributes or child elements depending on the configuration schema you define for your derived class. This method is called by the configuration infrastructure. The default implementation loads configuration from a [<trustedIssuers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/trustedissuers) element (configured under the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element). You can override this method to provide support for your own custom configuration elements in derived classes. diff --git a/xml/System.IdentityModel.Tokens/EncryptedKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/EncryptedKeyIdentifierClause.xml index 3769e2a32a8..55a9b105bcb 100644 --- a/xml/System.IdentityModel.Tokens/EncryptedKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/EncryptedKeyIdentifierClause.xml @@ -30,7 +30,7 @@ does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference an encrypted key. The method returns the encrypted key. + Typically, the does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference an encrypted key. The method returns the encrypted key. WCF accepts wrapped keys that are well formed with respect to the wire format. The key wrap algorithm specified on the wire is accepted and used. It is not verified to be compatible with the specified by the endpoint. @@ -387,7 +387,7 @@ method is a clone of the encrypted key. + The array that is returned by the method is a clone of the encrypted key. ]]> @@ -513,7 +513,7 @@ method returns a string that contains the encrypted key and the cryptographic algorithm that is used to encrypt the key. + The method returns a string that contains the encrypted key and the cryptographic algorithm that is used to encrypt the key. ]]> diff --git a/xml/System.IdentityModel.Tokens/GenericXmlSecurityToken.xml b/xml/System.IdentityModel.Tokens/GenericXmlSecurityToken.xml index 1ca6ae25249..a302186559c 100644 --- a/xml/System.IdentityModel.Tokens/GenericXmlSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/GenericXmlSecurityToken.xml @@ -204,7 +204,7 @@ method to determine if a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. ]]> @@ -257,9 +257,9 @@ property or the property is returned by the method depending on the type that is passed into the `T` parameter. + The value of the property or the property is returned by the method depending on the type that is passed into the `T` parameter. - Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. ]]> @@ -427,7 +427,7 @@ and property values using the method on the key identifier clause that is returned by the property values. + The `keyIdentifierClause` parameter is matched against the and property values using the method on the key identifier clause that is returned by the property values. ]]> @@ -603,7 +603,7 @@ method returns the , , , and properties. + The method returns the , , , and properties. ]]> diff --git a/xml/System.IdentityModel.Tokens/IssuerNameRegistry.xml b/xml/System.IdentityModel.Tokens/IssuerNameRegistry.xml index 8e3631be33d..e0dc75b94e8 100644 --- a/xml/System.IdentityModel.Tokens/IssuerNameRegistry.xml +++ b/xml/System.IdentityModel.Tokens/IssuerNameRegistry.xml @@ -29,7 +29,7 @@ Windows Identity Foundation (WIF) provides an implementation of the class out of the box: the class. When you use this implementation you can specify the list of trusted issuers in the configuration file of the RP application under the [<trustedIssuers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/trustedissuers) element, which is a child element of the `` element when the .class is referenced in that element's `type` attribute. Under the `` element, each issuer name is mapped to the X.509 certificate that should be used to verify its signature. - To create a custom issuer name registry, you must override the method. This method returns the issuer name for the specified security token. You can optionally override the method to provide a hinting mechanism when retrieving issuer names and the method if you want to provide an issuer name for Windows tokens that is different from . Override the method to enable your issuer name registry to be initialized from a configuration file. + To create a custom issuer name registry, you must override the method. This method returns the issuer name for the specified security token. You can optionally override the method to provide a hinting mechanism when retrieving issuer names and the method if you want to provide an issuer name for Windows tokens that is different from . Override the method to enable your issuer name registry to be initialized from a configuration file. @@ -125,7 +125,7 @@ ## Examples - The following code shows the method for an issuer name registry. The full sample is in the class overview topic. + The following code shows the method for an issuer name registry. The full sample is in the class overview topic. > [!WARNING] > The following code is for illustrative purposes only. Validating certificates based on subject name is not a good practice. This code should not be used as is in production. @@ -165,7 +165,7 @@ method. + The default implementation ignores the `requestedIssuerName` parameter and simply calls the method. Called from the processing pipeline by the security token handler that is processing the token. The method should return a unique name for the issuer within the context of the RP application. @@ -234,7 +234,7 @@ method is called by the configuration infrastructure. When this method is called, the `nodelist` will contain the top-level child elements of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element from the configuration file. Each of these may, in turn, contain attributes or child elements depending on the configuration schema you define for your derived class. + The method is called by the configuration infrastructure. When this method is called, the `nodelist` will contain the top-level child elements of the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element from the configuration file. Each of these may, in turn, contain attributes or child elements depending on the configuration schema you define for your derived class. The default implementation throws a . Override this method in your derived class to enable initialization of your issuer name registry from a configuration file. diff --git a/xml/System.IdentityModel.Tokens/KerberosReceiverSecurityToken.xml b/xml/System.IdentityModel.Tokens/KerberosReceiverSecurityToken.xml index 1eda8b83283..167da9a43bd 100644 --- a/xml/System.IdentityModel.Tokens/KerberosReceiverSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/KerberosReceiverSecurityToken.xml @@ -60,7 +60,7 @@ method. + For the `request` parameter, pass the Kerberos ticket that is the returned from the method. This constructor generates a unique identifier of the security token and sets that value to the property. @@ -150,7 +150,7 @@ method. + To create the key identifier clause, call the method. ]]> @@ -188,7 +188,7 @@ class can create the specified key identifier clause, call the method. + To determine whether the class can create the specified key identifier clause, call the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/KerberosRequestorSecurityToken.xml b/xml/System.IdentityModel.Tokens/KerberosRequestorSecurityToken.xml index 203db040bd2..5616182cbe7 100644 --- a/xml/System.IdentityModel.Tokens/KerberosRequestorSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/KerberosRequestorSecurityToken.xml @@ -160,7 +160,7 @@ method. + To create the key identifier clause, call the method. ]]> @@ -198,7 +198,7 @@ class can create the specified key identifier clause, call the method. + To determine whether the class can create the specified key identifier clause, call the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/KerberosTicketHashKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/KerberosTicketHashKeyIdentifierClause.xml index 8ee87ad441d..ac780330a09 100644 --- a/xml/System.IdentityModel.Tokens/KerberosTicketHashKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/KerberosTicketHashKeyIdentifierClause.xml @@ -17,11 +17,11 @@ Represents a key identifier clause that identifies a or security token. - class to reference a or security token using a SHA-1 hash of the Kerberos ticket. The SHA-1 hash of the Kerberos ticket can be obtained by calling the method. - + class to reference a or security token using a SHA-1 hash of the Kerberos ticket. The SHA-1 hash of the Kerberos ticket can be obtained by calling the method. + ]]> @@ -86,11 +86,11 @@ The size of the derived key. Initializes a new instance of the class using the specified Kerberos ticket, nonce, and key length. - @@ -143,11 +143,11 @@ Returns the current object. A that represents the current object. - method returns the SHA-1 hash of a Kerberos service ticket. - + method returns the SHA-1 hash of a Kerberos service ticket. + ]]> diff --git a/xml/System.IdentityModel.Tokens/LocalIdKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/LocalIdKeyIdentifierClause.xml index 19e45066379..ce397b71653 100644 --- a/xml/System.IdentityModel.Tokens/LocalIdKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/LocalIdKeyIdentifierClause.xml @@ -363,7 +363,7 @@ method returns a string that contains the values of the and properties. + The method returns a string that contains the values of the and properties. ]]> diff --git a/xml/System.IdentityModel.Tokens/RsaKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/RsaKeyIdentifierClause.xml index ca3b035f5b0..49ff7e4489b 100644 --- a/xml/System.IdentityModel.Tokens/RsaKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/RsaKeyIdentifierClause.xml @@ -74,7 +74,7 @@ method. + To create the key, call the method. ]]> @@ -258,7 +258,7 @@ method returns a string that contains the `Modulus` and `Exponent` values of the RSA algorithm. The `Modulus` and `Exponent` values are the values returned by the and methods that are Base64 encoded. + The method returns a string that contains the `Modulus` and `Exponent` values of the RSA algorithm. The `Modulus` and `Exponent` values are the values returned by the and methods that are Base64 encoded. ]]> diff --git a/xml/System.IdentityModel.Tokens/RsaSecurityToken.xml b/xml/System.IdentityModel.Tokens/RsaSecurityToken.xml index e6a7b1753d5..be9f0f3642d 100644 --- a/xml/System.IdentityModel.Tokens/RsaSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/RsaSecurityToken.xml @@ -129,7 +129,7 @@ method. + To create the key identifier clause, call the method. ]]> @@ -167,7 +167,7 @@ class can create the specified key identifier clause, call the method. + To determine whether the class can create the specified key identifier clause, call the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/Saml2Assertion.xml b/xml/System.IdentityModel.Tokens/Saml2Assertion.xml index 15b7ba148f4..9523164e966 100644 --- a/xml/System.IdentityModel.Tokens/Saml2Assertion.xml +++ b/xml/System.IdentityModel.Tokens/Saml2Assertion.xml @@ -106,7 +106,7 @@ method and can re-emit the original data as long as the property has not changed from the time that assertion was read. + The default implementation preserves the source data when read using the method and can re-emit the original data as long as the property has not changed from the time that assertion was read. > [!IMPORTANT] > It is very important that SAML assertions with different data have different IDs. If implementing a scheme whereby an assertion "template" is loaded and certain bits of data are filled in, the Id must be changed. diff --git a/xml/System.IdentityModel.Tokens/Saml2AuthenticationContext.xml b/xml/System.IdentityModel.Tokens/Saml2AuthenticationContext.xml index 8e0bdfb56f2..614a8986404 100644 --- a/xml/System.IdentityModel.Tokens/Saml2AuthenticationContext.xml +++ b/xml/System.IdentityModel.Tokens/Saml2AuthenticationContext.xml @@ -19,7 +19,7 @@ class, overriding the and methods to read and write the by-value declaration. + This base class does not directly support any by-value authentication context declarations (represented in XML by the AuthnContextDecl element). To support by-value declarations, extend this class to support the data model and extend the class, overriding the and methods to read and write the by-value declaration. For more information about the element that this class represents, see the SAML V2.0 Core specification. diff --git a/xml/System.IdentityModel.Tokens/Saml2SecurityToken.xml b/xml/System.IdentityModel.Tokens/Saml2SecurityToken.xml index 73f46a146d1..fdbe99dade1 100644 --- a/xml/System.IdentityModel.Tokens/Saml2SecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/Saml2SecurityToken.xml @@ -120,7 +120,7 @@ ## Remarks For security tokens, the claims are specified using a SAML assertion. - Use a constructor or the method to set the property. + Use a constructor or the method to set the property. ]]> @@ -158,7 +158,7 @@ method to determine if a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. ]]> @@ -195,7 +195,7 @@ method to determine if a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAction.xml b/xml/System.IdentityModel.Tokens/SamlAction.xml index 8e4ead8ccba..3c7e58f9262 100644 --- a/xml/System.IdentityModel.Tokens/SamlAction.xml +++ b/xml/System.IdentityModel.Tokens/SamlAction.xml @@ -204,8 +204,7 @@ class read-only, call the method. +To make this instance of the class read-only, call the method. ]]> @@ -234,7 +233,7 @@ method is called, the property is set to `true`. + When the method is called, the property is set to `true`. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAdvice.xml b/xml/System.IdentityModel.Tokens/SamlAdvice.xml index 7a150055d87..a0441682eb6 100644 --- a/xml/System.IdentityModel.Tokens/SamlAdvice.xml +++ b/xml/System.IdentityModel.Tokens/SamlAdvice.xml @@ -57,7 +57,7 @@ method, an empty `` element is generated by the method. + When this constructor is called and the instance is not modified prior to serializing it into XML by calling the method, an empty `` element is generated by the method. ]]> @@ -250,7 +250,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -279,7 +279,7 @@ method is called, the property is set to `true`. + When the method is called, the property is set to `true`. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAssertion.xml b/xml/System.IdentityModel.Tokens/SamlAssertion.xml index 108def4b8ec..485aa592fe7 100644 --- a/xml/System.IdentityModel.Tokens/SamlAssertion.xml +++ b/xml/System.IdentityModel.Tokens/SamlAssertion.xml @@ -208,7 +208,7 @@ method and can re-emit the original data as long as the property has not changed from the time that assertion was read. + The default implementation preserves the source data when read using the method and can re-emit the original data as long as the property has not changed from the time that assertion was read. > [!IMPORTANT] > It is very important that SAML assertions with different data have different IDs. If implementing a scheme whereby an assertion "template" is loaded and certain bits of data are filled in, the Id must be changed. @@ -272,7 +272,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -391,7 +391,7 @@ method is called, the property is set to `true`. + When the method is called, the property is set to `true`. ]]> @@ -458,7 +458,7 @@ method is called, the property is set. + When the method is called, the property is set. ]]> @@ -571,7 +571,7 @@ method is called and a SAML assertion is digitally signed, the digital signature is set to the property. When the SAML assertion is not digitally signed, the value of the property is `null`. + When the method is called and a SAML assertion is digitally signed, the digital signature is set to the property. When the SAML assertion is not digitally signed, the value of the property is `null`. ]]> @@ -600,7 +600,7 @@ to set the SAML statements associated with a SAML assertion or add it directly to the collection that is returned by this property when the property is `false`. + Use the to set the SAML statements associated with a SAML assertion or add it directly to the collection that is returned by this property when the property is `false`. The following table maps the three types of SAML statements defined in the Assertions and Protocol for the OASIS SAML specification to their respective types. @@ -641,7 +641,7 @@ method and can re-emit the original data as long as the property has not changed from the time that assertion was read. + The default implementation preserves the source data when read using the method and can re-emit the original data as long as the property has not changed from the time that assertion was read. > [!IMPORTANT] > It is very important that SAML assertions with different data have different IDs. If implementing a scheme whereby an assertion "template" is loaded and certain bits of data are filled in, the Id must be changed. diff --git a/xml/System.IdentityModel.Tokens/SamlAssertionKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/SamlAssertionKeyIdentifierClause.xml index 9829934a668..2072d7d3839 100644 --- a/xml/System.IdentityModel.Tokens/SamlAssertionKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/SamlAssertionKeyIdentifierClause.xml @@ -178,7 +178,7 @@ overload returns a value of `true` when either of the following is `true`: + This overload returns a value of `true` when either of the following is `true`: - The property of the `keyIdentifierClause` parameter has the same value as the current instance's property. diff --git a/xml/System.IdentityModel.Tokens/SamlAttribute.xml b/xml/System.IdentityModel.Tokens/SamlAttribute.xml index 4d66b606ac9..d331f0e0816 100644 --- a/xml/System.IdentityModel.Tokens/SamlAttribute.xml +++ b/xml/System.IdentityModel.Tokens/SamlAttribute.xml @@ -22,7 +22,7 @@ ## Remarks The class corresponds to the `` XML element that is defined in the OASIS SAML 1.1 specification. - A instance contains claims for the subject of a . For example, a might contain an `Over21` claim, whose type would be specified in the property and whose resource would be specified as a member of the collection in the property. When the method is called, this `Over21` claim is added to the authorization policy that is returned by returned from by the . When the property contains multiple elements then one claim is returned for each element. + A instance contains claims for the subject of a . For example, a might contain an `Over21` claim, whose type would be specified in the property and whose resource would be specified as a member of the collection in the property. When the method is called, this `Over21` claim is added to the authorization policy that is returned by returned from by the . When the property contains multiple elements then one claim is returned for each element. position in the SAML object hierarchy is: @@ -265,7 +265,7 @@ security tokens specify their claims using SAML assertions that can specify an attribute about the subject represented by the security token. Use the method to convert the SAML attribute into a set of claims. + security tokens specify their claims using SAML assertions that can specify an attribute about the subject represented by the security token. Use the method to convert the SAML attribute into a set of claims. ]]> @@ -295,7 +295,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -324,7 +324,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -448,7 +448,7 @@ method sets the , , and properties. + The method sets the , , and properties. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAttributeStatement.xml b/xml/System.IdentityModel.Tokens/SamlAttributeStatement.xml index f646be419e8..5f565da67c9 100644 --- a/xml/System.IdentityModel.Tokens/SamlAttributeStatement.xml +++ b/xml/System.IdentityModel.Tokens/SamlAttributeStatement.xml @@ -125,7 +125,7 @@ method to convert a set of claims into attributes of a SAML assertion. + Use the method to convert a set of claims into attributes of a SAML assertion. ]]> @@ -186,7 +186,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -215,7 +215,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -253,7 +253,7 @@ method sets the and properties. + The method sets the and properties. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAudienceRestrictionCondition.xml b/xml/System.IdentityModel.Tokens/SamlAudienceRestrictionCondition.xml index 731985759cd..df8d7e2346c 100644 --- a/xml/System.IdentityModel.Tokens/SamlAudienceRestrictionCondition.xml +++ b/xml/System.IdentityModel.Tokens/SamlAudienceRestrictionCondition.xml @@ -24,7 +24,7 @@ Use the class to specify a is intended for a specific audience and that the issuing SAML authority does not warrant the SAML assertion for other audiences that receive the security token. The claims for security tokens are expressed as part of a , which can optionally have a set of conditions affect the validity of the assertion. One of those conditions is a , which specifies that the assertion is addressed to one or more specific audiences. The issuing SAML authority cannot prevent an unintended recipient from taking action on the basis of the information provided in the SAML assertion. However, the class allows the SAML authority to state explicitly that no warranty is provided to such a party in a machine- and human-readable form. - To specify the set of intended audiences, use the constructor that accepts a set of audiences. To get the set of intended audiences, access the property. + To specify the set of intended audiences, use the constructor that accepts a set of audiences. To get the set of intended audiences, access the property. ]]> @@ -116,7 +116,7 @@ property, use the constructor that accepts a set of audiences. + To set the property, use the constructor that accepts a set of audiences. ]]> @@ -146,7 +146,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -175,7 +175,7 @@ method is called, the property is set to `true`. + When the method is called, the property is set to `true`. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAuthenticationStatement.xml b/xml/System.IdentityModel.Tokens/SamlAuthenticationStatement.xml index b3cdacd7077..5c0713ca56b 100644 --- a/xml/System.IdentityModel.Tokens/SamlAuthenticationStatement.xml +++ b/xml/System.IdentityModel.Tokens/SamlAuthenticationStatement.xml @@ -135,7 +135,7 @@ method adds a claim to the `claims` parameter based on the , , , , , , and properties. + The method adds a claim to the `claims` parameter based on the , , , , , , and properties. ]]> @@ -363,7 +363,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -392,7 +392,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -430,7 +430,7 @@ method sets the , , , , , and properties. + The method sets the , , , , , and properties. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAuthorityBinding.xml b/xml/System.IdentityModel.Tokens/SamlAuthorityBinding.xml index f4b2e6891d1..de6c68125d8 100644 --- a/xml/System.IdentityModel.Tokens/SamlAuthorityBinding.xml +++ b/xml/System.IdentityModel.Tokens/SamlAuthorityBinding.xml @@ -188,7 +188,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -254,7 +254,7 @@ method is called, the property is set to `true`. + When the method is called, the property is set to `true`. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlAuthorizationDecisionStatement.xml b/xml/System.IdentityModel.Tokens/SamlAuthorizationDecisionStatement.xml index e1b41db47a8..0462d80182e 100644 --- a/xml/System.IdentityModel.Tokens/SamlAuthorizationDecisionStatement.xml +++ b/xml/System.IdentityModel.Tokens/SamlAuthorizationDecisionStatement.xml @@ -221,7 +221,7 @@ method adds a claim to the `claims` parameter for each action specified in the property. Each claim that is added to the collection is based on the action, and the , , and properties. The claim resource type is . + The method adds a claim to the `claims` parameter for each action specified in the property. Each claim that is added to the collection is based on the action, and the , , and properties. The claim resource type is . ]]> @@ -307,7 +307,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -336,7 +336,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -374,7 +374,7 @@ method sets the following properties: + The method sets the following properties: - @@ -489,7 +489,7 @@ method to write the current instance into a `` element. + Use the method to write the current instance into a `` element. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlCondition.xml b/xml/System.IdentityModel.Tokens/SamlCondition.xml index 743c4846008..d74e81b1108 100644 --- a/xml/System.IdentityModel.Tokens/SamlCondition.xml +++ b/xml/System.IdentityModel.Tokens/SamlCondition.xml @@ -73,7 +73,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -102,7 +102,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlConditions.xml b/xml/System.IdentityModel.Tokens/SamlConditions.xml index bf147d6e491..5d59731494a 100644 --- a/xml/System.IdentityModel.Tokens/SamlConditions.xml +++ b/xml/System.IdentityModel.Tokens/SamlConditions.xml @@ -185,7 +185,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -214,7 +214,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -310,7 +310,7 @@ method sets the following properties: + The method sets the following properties: - @@ -358,7 +358,7 @@ method to write the current instance into a `` element. + Use the method to write the current instance into a `` element. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlDoNotCacheCondition.xml b/xml/System.IdentityModel.Tokens/SamlDoNotCacheCondition.xml index f8839433406..ee99f28efe5 100644 --- a/xml/System.IdentityModel.Tokens/SamlDoNotCacheCondition.xml +++ b/xml/System.IdentityModel.Tokens/SamlDoNotCacheCondition.xml @@ -82,7 +82,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -111,7 +111,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -148,8 +148,7 @@ method does note set any properties. +The method does not set any properties. ]]> @@ -193,7 +192,7 @@ method to write the current instance into a `` element. + Use the method to write the current instance into a `` element. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlEvidence.xml b/xml/System.IdentityModel.Tokens/SamlEvidence.xml index e2840486070..e24b7f4c66b 100644 --- a/xml/System.IdentityModel.Tokens/SamlEvidence.xml +++ b/xml/System.IdentityModel.Tokens/SamlEvidence.xml @@ -254,7 +254,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -283,7 +283,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -321,7 +321,7 @@ method sets the following properties: + The method sets the following properties: - @@ -369,7 +369,7 @@ method to write the current instance into a `` element. + Use the method to write the current instance into a `` element. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlSecurityToken.xml b/xml/System.IdentityModel.Tokens/SamlSecurityToken.xml index a5e446e5799..a970116c3a3 100644 --- a/xml/System.IdentityModel.Tokens/SamlSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/SamlSecurityToken.xml @@ -78,7 +78,7 @@ method, which can be overridden in derived classes. + This constructor calls the method, which can be overridden in derived classes. For security tokens, the claims are specified using a SAML assertion. @@ -111,7 +111,7 @@ ## Remarks For security tokens, the claims are specified using a SAML assertion. - Use a constructor or the method to set the property. + Use a constructor or the method to set the property. ]]> @@ -150,7 +150,7 @@ method to determine if a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. ]]> @@ -188,7 +188,7 @@ method to determine if a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine if a security token can create a specific key identifier. To create the key identifier call the method. ]]> @@ -251,7 +251,7 @@ constructor calls the method, which can be overridden in derived classes. + The constructor calls the method, which can be overridden in derived classes. For security tokens, the claims are specified using a SAML assertion. diff --git a/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml b/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml index b46fa690e20..c000ec1f473 100644 --- a/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml +++ b/xml/System.IdentityModel.Tokens/SamlSecurityTokenHandler.xml @@ -732,7 +732,7 @@ method returns the SAML11 authentication method identifier that matches the specified normalized URI. For example, if is specified for `normalizedAuthenticationType`, the following URI is returned: `urn:oasis:names:tc:SAML:1.0:am:X509-PKI`. If a mapping does not exist for `normalizedAuthenticationType`, it is returned unaltered. + The method returns the SAML11 authentication method identifier that matches the specified normalized URI. For example, if is specified for `normalizedAuthenticationType`, the following URI is returned: `urn:oasis:names:tc:SAML:1.0:am:X509-PKI`. If a mapping does not exist for `normalizedAuthenticationType`, it is returned unaltered. ]]> @@ -1038,7 +1038,7 @@ method returns the value that matches the specified SAML11 authentication method identifier. For example, if `urn:oasis:names:tc:SAML:1.0:am:X509-PKI` is specified for `saml11AuthenticationMethod`, is returned. If a mapping does not exist for `saml11AuthenticationMethod`, it is returned unaltered. + The method returns the value that matches the specified SAML11 authentication method identifier. For example, if `urn:oasis:names:tc:SAML:1.0:am:X509-PKI` is specified for `saml11AuthenticationMethod`, is returned. If a mapping does not exist for `saml11AuthenticationMethod`, it is returned unaltered. ]]> @@ -2379,7 +2379,7 @@ or method to serialize the condition based on the type of specified. + By default, the method invokes either the or method to serialize the condition based on the type of specified. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlSerializer.xml b/xml/System.IdentityModel.Tokens/SamlSerializer.xml index f95d01b7287..3813e0f4957 100644 --- a/xml/System.IdentityModel.Tokens/SamlSerializer.xml +++ b/xml/System.IdentityModel.Tokens/SamlSerializer.xml @@ -27,13 +27,13 @@ Serializes and deserializes objects into and from XML documents. - class serializes and deserializes SAML security tokens, which have an extensible format. Unlike many other security tokens, security tokens include XML elements and attributes that can be customized for an application's needs. Some of the extensibility points for a SAML assertion include the ``, ``, and `` elements. For more details about overriding how each of these elements are read, see the , , and methods. - + class serializes and deserializes SAML security tokens, which have an extensible format. Unlike many other security tokens, security tokens include XML elements and attributes that can be customized for an application's needs. Some of the extensibility points for a SAML assertion include the ``, ``, and `` elements. For more details about overriding how each of these elements are read, see the , , and methods. + ]]> @@ -93,11 +93,11 @@ Reads the additional information provided by the SAML authority within a element of a SAML assertion using the specified XML reader. A that contains additional information provided by the SAML authority within a element of a SAML assertion. - ` element within a SAML assertion is an extension point for SAML tokens. To create a serializer that can read the custom attributes, derive a class from and override the method. - + ` element within a SAML assertion is an extension point for SAML tokens. To create a serializer that can read the custom attributes, derive a class from and override the method. + ]]> @@ -133,13 +133,13 @@ Reads a SAML assertion from the specified XML reader. A that represents the SAML assertion. - ` element. - - The method calls the method to read the SAML assertion. - + ` element. + + The method calls the method to read the SAML assertion. + ]]> @@ -175,11 +175,11 @@ Reads an attribute of the subject of a SAML security token using the specified XML reader. A that represents a claim that is an attribute of the subject of a SAML security token. - ` element and can contain any well-formed XML, not just an attribute. To create a serializer that can read the custom attributes, derive a class from and override the method. - + ` element and can contain any well-formed XML, not just an attribute. To create a serializer that can read the custom attributes, derive a class from and override the method. + ]]> @@ -213,11 +213,11 @@ Reads a condition that must be taken into account when assessing the validity of a SAML assertion using the specified XML reader. A that specifies a condition that must be taken into account when assessing the validity of a SAML assertion. - ` element is an extensibility point, a serializer that understands how to read those conditions is needed. To create a serializer that can read the custom attributes, derive a class from and override the method. - + ` element is an extensibility point, a serializer that understands how to read those conditions is needed. To create a serializer that can read the custom attributes, derive a class from and override the method. + ]]> @@ -253,11 +253,11 @@ Reads a set of conditions that must be taken into account when assessing the validity of a SAML assertion using the specified XML reader. A that specifies a set of conditions that must be taken into account when assessing the validity of a SAML assertion. - method reads the contents of a `` element. - + method reads the contents of a `` element. + ]]> @@ -293,34 +293,34 @@ Reads a SAML statement using the specified XML reader. A that represents the SAML statement. - security tokens specify their claims using SAML assertions where the details of the claims are specified in SAML statements. The SAML specification defines the following statement types: - -- - -- - -- - -- - - The method reads the SAML statements listed previously. When custom statements are defined and used by an application, create a serializer to read the contents of them. To create the custom serializer, derive a class from and override the method. Custom SAML statements are contained within a `` element. - - - -## Examples - - - - - - - - - - + security tokens specify their claims using SAML assertions where the details of the claims are specified in SAML statements. The SAML specification defines the following statement types: + +- + +- + +- + +- + + The method reads the SAML statements listed previously. When custom statements are defined and used by an application, create a serializer to read the contents of them. To create the custom serializer, derive a class from and override the method. Custom SAML statements are contained within a `` element. + + + +## Examples + + + + + + + + + + ]]> @@ -350,11 +350,11 @@ An that contains the set of XML elements and attributes. Replaces the default set of XML elements and attributes that are recognized by this serializer with the specified dictionary of elements and attributes. - method when a custom set of XML elements is defined for one of the extensibility points of a SAML assertion. Extensibility points for a SAML assertion include the ``, ``, and `` elements. For more details about overriding how each of these elements are read, see the , , and methods. - + method when a custom set of XML elements is defined for one of the extensibility points of a SAML assertion. Extensibility points for a SAML assertion include the ``, ``, and `` elements. For more details about overriding how each of these elements are read, see the , , and methods. + ]]> @@ -387,11 +387,11 @@ Reads a SAML security token from the specified XML reader. A security token. - method calls the method to read the SAML assertion. - + method calls the method to read the SAML assertion. + ]]> @@ -427,18 +427,18 @@ A that is capable of writing clauses. Writes the specified SAML security token into the specified XML serializer. - method to serialize a security token. To deserialize a use the method. - + method to serialize a security token. To deserialize a use the method. + ]]> - is - - -or- - + is + + -or- + is diff --git a/xml/System.IdentityModel.Tokens/SamlStatement.xml b/xml/System.IdentityModel.Tokens/SamlStatement.xml index e6d11ac9860..21d06a09003 100644 --- a/xml/System.IdentityModel.Tokens/SamlStatement.xml +++ b/xml/System.IdentityModel.Tokens/SamlStatement.xml @@ -83,7 +83,7 @@ method to get an authorization policy for a security token. + Use the method to get an authorization policy for a security token. ]]> @@ -113,7 +113,7 @@ class, should set the property to `true` when the method is called. + Classes that derive from the class, should set the property to `true` when the method is called. ]]> @@ -142,7 +142,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -180,7 +180,7 @@ method to read in a SAML statement, validate the XML, and set the appropriate properties that correspond to the attributes and elements. + Use the method to read in a SAML statement, validate the XML, and set the appropriate properties that correspond to the attributes and elements. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlSubject.xml b/xml/System.IdentityModel.Tokens/SamlSubject.xml index 909ce257b27..83825686957 100644 --- a/xml/System.IdentityModel.Tokens/SamlSubject.xml +++ b/xml/System.IdentityModel.Tokens/SamlSubject.xml @@ -259,7 +259,7 @@ method to get a set of claims associated with the identity of a security token. + Use the method to get a set of claims associated with the identity of a security token. ]]> @@ -292,7 +292,7 @@ method to get a set of claims associated with the identity of a security token. + Use the method to get a set of claims associated with the identity of a security token. ]]> @@ -324,7 +324,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -386,7 +386,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -556,7 +556,7 @@ method sets the , , , , , , and properties. + The method sets the , , , , , , and properties. ]]> @@ -647,7 +647,7 @@ method to write the properties of the current instance into a `` element. + Use the method to write the properties of the current instance into a `` element. ]]> diff --git a/xml/System.IdentityModel.Tokens/SamlSubjectStatement.xml b/xml/System.IdentityModel.Tokens/SamlSubjectStatement.xml index 116a7602984..e6f2d57d4eb 100644 --- a/xml/System.IdentityModel.Tokens/SamlSubjectStatement.xml +++ b/xml/System.IdentityModel.Tokens/SamlSubjectStatement.xml @@ -115,7 +115,7 @@ method adds a claim to the `claims` parameter based on the property. + The method adds a claim to the `claims` parameter based on the property. ]]> @@ -152,7 +152,7 @@ method to get an authorization policy for a security token. + Use the method to get an authorization policy for a security token. ]]> @@ -182,7 +182,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -211,7 +211,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. ]]> @@ -273,7 +273,7 @@ property, the method can be called to set the subject of a security token when the property is `true`. + Unlike the property, the method can be called to set the subject of a security token when the property is `true`. ]]> diff --git a/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml b/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml index 3aab5aab355..0286ac6716f 100644 --- a/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml +++ b/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml @@ -373,7 +373,7 @@ class read-only, call the method. + To make this instance of the class read-only, call the method. ]]> @@ -450,7 +450,7 @@ method is called, the property is set to `true` and properties of this instance can no longer be set. For example, a key identifier clause cannot be added to this object. + When the method is called, the property is set to `true` and properties of this instance can no longer be set. For example, a key identifier clause cannot be added to this object. ]]> @@ -530,7 +530,7 @@ This member is an explicit interface member implementation. It can be used only method returns the details of all of the key identifier clauses in the key identifier. + The method returns the details of all of the key identifier clauses in the key identifier. ]]> diff --git a/xml/System.IdentityModel.Tokens/SecurityKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/SecurityKeyIdentifierClause.xml index f457cee1cf0..2c1b3e0330b 100644 --- a/xml/System.IdentityModel.Tokens/SecurityKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/SecurityKeyIdentifierClause.xml @@ -167,7 +167,7 @@ method to return `true` and implement the method. + When a key can be created using the parameters passed into a constructor, override the method to return `true` and implement the method. ]]> @@ -235,7 +235,7 @@ method to return `true` and implement the method. + When a key can be created using the parameters passed into a constructor, override the method to return `true` and implement the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/SecurityToken.xml b/xml/System.IdentityModel.Tokens/SecurityToken.xml index c61a705a4fd..82f8733f288 100644 --- a/xml/System.IdentityModel.Tokens/SecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/SecurityToken.xml @@ -46,7 +46,7 @@ A security token can be used to provide authentication credentials, cryptographic key material, or, in the case of a security token issued by a security token service (STS), a collection of claims about a subject. All security tokens derive from the class. - Beginning with .NET 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework and the classes exposed by WIF are the preferred method of handling security tokens in your code. In WIF, security tokens are serialized and deserialized to and from their XML representation and are validated by using classes derived from the base class. Validating a token involves not just ensuring that the token is valid, but also returning a instance from the token that can be used in making authentication and authorization decisions. The is constructed by the token handler's implementation of the method from the claims contained in the token as well as from claims that are intrinsic to the token type itself. + Beginning with .NET 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework and the classes exposed by WIF are the preferred method of handling security tokens in your code. In WIF, security tokens are serialized and deserialized to and from their XML representation and are validated by using classes derived from the base class. Validating a token involves not just ensuring that the token is valid, but also returning a instance from the token that can be used in making authentication and authorization decisions. The is constructed by the token handler's implementation of the method from the claims contained in the token as well as from claims that are intrinsic to the token type itself. WIF ships with support for the following types of security tokens: @@ -168,7 +168,7 @@ method to determine whether a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine whether a security token can create a specific key identifier. To create the key identifier call the method. The default implementation supports key identifier clauses of type . @@ -218,7 +218,7 @@ method to determine whether a security token can create a specific key identifier. To create the key identifier call the method. + Use the method to determine whether a security token can create a specific key identifier. To create the key identifier call the method. The default implementation supports key identifier clauses of type . If a key identifier clause of type cannot be created, a is thrown. @@ -355,9 +355,9 @@ method calls the to first determine whether the specified key identifier clause is the same as this instance. + The method calls the to first determine whether the specified key identifier clause is the same as this instance. - The default implementation returns the first element of the collection if the collection is not empty and if returns `true`; otherwise, it returns `null`. + The default implementation returns the first element of the collection if the collection is not empty and if returns `true`; otherwise, it returns `null`. ]]> diff --git a/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml b/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml index 8942b59c43b..47bad8f0b4c 100644 --- a/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml +++ b/xml/System.IdentityModel.Tokens/SecurityTokenElement.xml @@ -56,7 +56,7 @@ method is not supported by the new instance unless the method is overridden. + When this constructor is used, the method is not supported by the new instance unless the method is overridden. If the `securityToken` parameter is an instance of then the property is set to the value of the property. @@ -132,7 +132,7 @@ object by using the constructor, then the method is called to return the security token. + If the current instance was not constructed explicitly from a object by using the constructor, then the method is called to return the security token. ]]> @@ -187,7 +187,7 @@ constructor. + This property is `null` unless the current instance was initialized by using the constructor. ]]> diff --git a/xml/System.IdentityModel.Tokens/SecurityTokenHandler.xml b/xml/System.IdentityModel.Tokens/SecurityTokenHandler.xml index 73fec4746c1..ab21165ed24 100644 --- a/xml/System.IdentityModel.Tokens/SecurityTokenHandler.xml +++ b/xml/System.IdentityModel.Tokens/SecurityTokenHandler.xml @@ -61,27 +61,27 @@ Most of these classes expose additional members that implement functionality that is specific to the processing of the tokens for which the class is designed. In many cases it may be better to derive from one of these classes rather than directly from the class. - A security token handler can be added or removed from a token handler collection by specifying the [<add>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/add), [<remove>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/remove), or [<clear>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/clear) elements under the [<securityTokenHandlers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/securitytokenhandlers) element in a configuration file. The object that contains the configuration settings for the handler collection can be accessed through the property and the handler collection that the token handler is a member of can be accessed from the property. You can override the method to process any custom configuration elements that your handler takes. + A security token handler can be added or removed from a token handler collection by specifying the [<add>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/add), [<remove>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/remove), or [<clear>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/clear) elements under the [<securityTokenHandlers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/securitytokenhandlers) element in a configuration file. The object that contains the configuration settings for the handler collection can be accessed through the property and the handler collection that the token handler is a member of can be accessed from the property. You can override the method to process any custom configuration elements that your handler takes. The class exposes several other properties and methods. Depending on the functionality that you choose to implement, you may override some or all of these members. - You must override the property and the method to provide the WIF infrastructure with information about the type of security token that your class is designed to process. + You must override the property and the method to provide the WIF infrastructure with information about the type of security token that your class is designed to process. Validation, serialization, and deserialization functionality is exposed through properties or methods that indicate whether the handler can perform a specific function combined with the method or methods that implement the functionality. The following list pairs the properties or methods that indicate functionality with the methods that implement that functionality: -- The property and the method: Validates a token and packages the claims contained in the token into a . +- The property and the method: Validates a token and packages the claims contained in the token into a . -- The property and the methods: Token serialization. +- The property and the methods: Token serialization. -- The methods and the methods: Token deserialization. +- The methods and the methods: Token deserialization. -- The method and the method: Deserializing key identifier clauses. +- The method and the method: Deserializing key identifier clauses. -- The method and the method: Serializing key identifier clauses. +- The method and the method: Serializing key identifier clauses. - The and the methods are called from the pipeline in implementations of the class. + The and the methods are called from the pipeline in implementations of the class. - The method is called by the WIF infrastructure to determine whether the specified token has already been received. By default this method returns `false`, which indicates that the token has not already been received. You can override the method and provide logic to detect replayed tokens. + The method is called by the WIF infrastructure to determine whether the specified token has already been received. By default this method returns `false`, which indicates that the token has not already been received. You can override the method and provide logic to detect replayed tokens. @@ -158,7 +158,7 @@ ## Remarks The default implementation returns `false` to indicate that the key identifier clause cannot be read. - A derived class checks the element that the reader is referring to in order to determine whether the instance can deserialize a key identifier clause. This is typically accomplished through a call to the method with the appropriate element and namespace strings specified. If you override , you must also override the method to provide the logic to deserialize the key identifier clause. + A derived class checks the element that the reader is referring to in order to determine whether the instance can deserialize a key identifier clause. This is typically accomplished through a call to the method with the appropriate element and namespace strings specified. If you override , you must also override the method to provide the logic to deserialize the key identifier clause. ]]> @@ -202,7 +202,7 @@ ## Remarks The default implementation always returns `false`. - If you override this method, you must also override the method to provide the logic to deserialize the token. + If you override this method, you must also override the method to provide the logic to deserialize the token. ]]> @@ -237,12 +237,12 @@ ## Remarks The default implementation always returns `false`. - A derived class checks the element that the reader is referring to in order to determine whether the instance can deserialize a security token. This is typically accomplished through a call to the method with the appropriate element and namespace strings specified. If you override , you must also override the method or the method to provide the logic to deserialize the key identifier clause. + A derived class checks the element that the reader is referring to in order to determine whether the instance can deserialize a security token. This is typically accomplished through a call to the method with the appropriate element and namespace strings specified. If you override , you must also override the method or the method to provide the logic to deserialize the key identifier clause. ## Examples - The following code shows how to override the method to determine whether a token can be read by a handler. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows how to override the method to determine whether a token can be read by a handler. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet1"::: @@ -273,7 +273,7 @@ method to implement the validation logic. + To implement validation in a derived class, override this property to return `true` and override the method to implement the validation logic. @@ -315,7 +315,7 @@ ## Remarks The default implementation always returns `false`. - If you override , you must also override the method to provide the logic to serialize the key identifier clause. + If you override , you must also override the method to provide the logic to serialize the key identifier clause. ]]> @@ -344,7 +344,7 @@ methods to implement the serialization logic. + To implement serialization in a derived class, override this property to return `true` and override the methods to implement the serialization logic. @@ -381,7 +381,7 @@ ## Remarks The property is typically set by the configuration infrastructure from the [<securityTokenHandlerConfiguration>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/securitytokenhandlerconfiguration) element in the configuration file during application start up. - In derived classes, you use the property to access configuration settings; for example, the issuer name registry to use in the method can be accessed from the property of the configuration object. + In derived classes, you use the property to access configuration settings; for example, the issuer name registry to use in the method can be accessed from the property of the configuration object. ]]> @@ -455,7 +455,7 @@ ## Examples - The following code shows how to override the method to create a key identifier clause from the specified token. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows how to override the method to create a key identifier clause from the specified token. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet5"::: @@ -496,7 +496,7 @@ ## Examples - The following code shows how to override the method to create and return a token from a token descriptor. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows how to override the method to create and return a token from a token descriptor. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet4"::: @@ -533,7 +533,7 @@ Derived classes should throw a if the token has already been used. - Windows Identity Foundation (WIF) provides the class from which replay caches may be derived and the [<tokenReplayCache>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/tokenreplaycache) configuration element, which can be used to configure the replay cache used by token handlers in an application; however, the exact implementation of the method is up to the designer of the derived class. + Windows Identity Foundation (WIF) provides the class from which replay caches may be derived and the [<tokenReplayCache>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/tokenreplaycache) configuration element, which can be used to configure the replay cache used by token handlers in an application; however, the exact implementation of the method is up to the designer of the derived class. ]]> @@ -562,12 +562,12 @@ of the token processed by the current instance is accessed through the property. The method returns the set of acceptable identifiers that can be used in messages to refer to the token type. For example, the URI value used in the `` element under the `` element to request a specific kind of token (represented by the property in the object model). + The of the token processed by the current instance is accessed through the property. The method returns the set of acceptable identifiers that can be used in messages to refer to the token type. For example, the URI value used in the `` element under the `` element to request a specific kind of token (represented by the property in the object model). ## Examples - The following code shows how to override the method to return the token type identifiers for a custom token. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows how to override the method to return the token type identifiers for a custom token. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet17"::: :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet6"::: @@ -604,7 +604,7 @@ method is called by the configuration infrastructure. When this method is called, the `nodelist` will contain the top-level child elements of the token handler's [<add>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/add) element from the configuration file. Each of these may, in turn, contain attributes or child elements depending on the configuration schema you define for your derived class. + The method is called by the configuration infrastructure. When this method is called, the `nodelist` will contain the top-level child elements of the token handler's [<add>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/add) element from the configuration file. Each of these may, in turn, contain attributes or child elements depending on the configuration schema you define for your derived class. The default implementation throws a . Override this method in your derived class to enable initialization of your security token handler from a configuration file. @@ -640,7 +640,7 @@ ## Remarks By default this method throws a exception. - Override this method to provide the logic to deserialize a key identifier clause from XML. If you override this method, you should also override the method. + Override this method to provide the logic to deserialize a key identifier clause from XML. If you override this method, you should also override the method. ]]> @@ -686,7 +686,7 @@ By default this method throws a exception. - Override this method to provide functionality that can deserialize a security token from a string. If you override, this method, you should also override the method. + Override this method to provide functionality that can deserialize a security token from a string. If you override, this method, you should also override the method. ]]> @@ -723,12 +723,12 @@ By default this method throws a exception. - Override this method to provide the logic to deserialize a security token from XML. If you override this method, you should also override the method. Typically, in derived classes, if the method cannot deserialize the token from the referenced XML, it throws an . + Override this method to provide the logic to deserialize a security token from XML. If you override this method, you should also override the method. Typically, in derived classes, if the method cannot deserialize the token from the referenced XML, it throws an . ## Examples - The following code shows how to override the method to read a custom token from the specified XML reader. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows how to override the method to read a custom token from the specified XML reader. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet8"::: @@ -769,9 +769,9 @@ [!INCLUDE [untrusted-data-method-note](~/includes/untrusted-data-method-note.md)] - The default implementation ignores the `tokenResolver` parameter and delegates the call to the method. + The default implementation ignores the `tokenResolver` parameter and delegates the call to the method. - Override this method to provide the logic to deserialize a security token from XML. If you override this method, you should also override the method. Typically, in derived classes, if the method cannot deserialize the token from the referenced XML, it throws an . + Override this method to provide the logic to deserialize a security token from XML. If you override this method, you should also override the method. Typically, in derived classes, if the method cannot deserialize the token from the referenced XML, it throws an . ]]> @@ -839,7 +839,7 @@ method when validation of the token fails. + This method should be called from the method when validation of the token fails. ]]> @@ -870,7 +870,7 @@ method after the token has been successfully validated. + This method should be called from the method after the token has been successfully validated. ]]> @@ -904,29 +904,29 @@ ## Remarks By default this method throws a exception. - The method is called by the infrastructure to validate and extract the claims from the deserialized security token. These claims are returned in the collection of objects returned by the method. In the typical case, this collection will contain a single identity. + The method is called by the infrastructure to validate and extract the claims from the deserialized security token. These claims are returned in the collection of objects returned by the method. In the typical case, this collection will contain a single identity. In derived classes, validation typically includes validating the intended audience specified in the token against the audience URIs specified in the property of the token handler configuration object specified on the property. These URIs are typically set in the configuration file under the [<audienceUris>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/audienceuris) element. If the audience cannot be validated, an exception should be thrown. - When processing the token, the issuer is typically validated by passing the issuer token to one of the methods on the object that is configured for the handler through the property. The issuer name registry is typically configured through the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element in the configuration file. The returns the name of the issuer. This name should be used to set the property in claims contained in the token. If the issuer name registry does not contain an entry for the issuer token, returns `null`. In this case a is typically thrown in derived classes, but this behavior is up to the designer of the class. + When processing the token, the issuer is typically validated by passing the issuer token to one of the methods on the object that is configured for the handler through the property. The issuer name registry is typically configured through the [<issuerNameRegistry>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/issuernameregistry) element in the configuration file. The returns the name of the issuer. This name should be used to set the property in claims contained in the token. If the issuer name registry does not contain an entry for the issuer token, returns `null`. In this case a is typically thrown in derived classes, but this behavior is up to the designer of the class. ## Examples - The following code shows an override of the method for a security token handler that processes simple web tokens (SWT). The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows an override of the method for a security token handler that processes simple web tokens (SWT). The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet9"::: - The following code shows `CreateClaims` method that is invoked from the override of the method in the previous example. This method returns a object that is created from the claims in the token. The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows `CreateClaims` method that is invoked from the override of the method in the previous example. This method returns a object that is created from the claims in the token. The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet15"::: - The following code shows `ValidateSignature` method that is invoked from the override of the method in the simple web token handler. This method validates the signature on the token by using the configured . The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows `ValidateSignature` method that is invoked from the override of the method in the simple web token handler. This method validates the signature on the token by using the configured . The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet12"::: :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet11"::: - The following code shows `ValidateAudience` method that is invoked from the override of the method in the simple web token handler. This method validates the audience contained in the token against the audience URIs that were specified in configuration. The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows `ValidateAudience` method that is invoked from the override of the method in the simple web token handler. This method validates the audience contained in the token against the audience URIs that were specified in configuration. The code is taken from the `CustomToken` sample. For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet13"::: @@ -963,7 +963,7 @@ ## Remarks By default this method throws a exception. - Override this method to provide the logic to serialize a key identifier clause to XML. If you override this method, you should also override the method. + Override this method to provide the logic to serialize a key identifier clause to XML. If you override this method, you should also override the method. ]]> @@ -1046,7 +1046,7 @@ ## Examples - The following code shows how to override the method to serialize a custom token. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). + The following code shows how to override the method to serialize a custom token. The code is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet10"::: :::code language="csharp" source="~/snippets/csharp/System.IdentityModel.Tokens/SecurityTokenHandler/CanReadToken/simplewebtokenhandler.cs" id="Snippet11"::: diff --git a/xml/System.IdentityModel.Tokens/SecurityTokenHandlerCollection.xml b/xml/System.IdentityModel.Tokens/SecurityTokenHandlerCollection.xml index fefdc0d9931..9357d3d86b9 100644 --- a/xml/System.IdentityModel.Tokens/SecurityTokenHandlerCollection.xml +++ b/xml/System.IdentityModel.Tokens/SecurityTokenHandlerCollection.xml @@ -45,11 +45,11 @@ Initializes a new instance of the class. - @@ -73,11 +73,11 @@ The token handlers with which to initialize the new instance. Initializes a new instance of the class with the specified token handlers. - class, use the **Clone** method instead. - + class, use the **Clone** method instead. + ]]> @@ -101,11 +101,11 @@ The base configuration to associate with the collection. Initializes a new instance of the class with the specified configuration. - @@ -131,11 +131,11 @@ The base configuration to associate with the collection. Initializes a new instance of the class with the specified token handlers and configuration. - class, use the **Clone** method instead. - + class, use the **Clone** method instead. + ]]> @@ -249,11 +249,11 @@ if the collection contains a token handler that can read the specified token; otherwise . - method on the token handlers () in the collection to determine whether the token can be read. - + method on the token handlers () in the collection to determine whether the token can be read. + ]]> @@ -885,10 +885,10 @@ Serializes the specified security token to XML. To be added. - is . - - -or- - + is . + + -or- + is . The collection does not contain a handler capable of serializing the specified token. diff --git a/xml/System.IdentityModel.Tokens/SecurityTokenValidationException.xml b/xml/System.IdentityModel.Tokens/SecurityTokenValidationException.xml index 6f206ca8234..0d796edbd20 100644 --- a/xml/System.IdentityModel.Tokens/SecurityTokenValidationException.xml +++ b/xml/System.IdentityModel.Tokens/SecurityTokenValidationException.xml @@ -40,11 +40,11 @@ The exception that is thrown when a received security token is invalid. - is typically thrown by the method. - + is typically thrown by the method. + ]]> diff --git a/xml/System.IdentityModel.Tokens/SessionSecurityToken.xml b/xml/System.IdentityModel.Tokens/SessionSecurityToken.xml index 591f8a74a44..a34b463eb75 100644 --- a/xml/System.IdentityModel.Tokens/SessionSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/SessionSecurityToken.xml @@ -649,7 +649,7 @@ The class uses both the context ID and the key generation to generate a key for the token in the . - The class serializes this property as the `` child element of the `` element. For more information, see the documentation for the method. + The class serializes this property as the `` child element of the `` element. For more information, see the documentation for the method. ]]> @@ -737,7 +737,7 @@ class serializes this property as the `Id` attribute of the `` element. For more information, see the documentation for the method. + The class serializes this property as the `Id` attribute of the `` element. For more information, see the documentation for the method. ]]> @@ -875,7 +875,7 @@ The class uses both the context ID and the key generation to generate a key for the token in the . - The class serializes this property as the `` child element of the `` element. For more information, see the documentation for the method. + The class serializes this property as the `` child element of the `` element. For more information, see the documentation for the method. ]]> diff --git a/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml b/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml index 1d969d14312..2dec1c63490 100644 --- a/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml +++ b/xml/System.IdentityModel.Tokens/SessionSecurityTokenCacheKey.xml @@ -193,7 +193,7 @@ property is treated by the following methods and operators: , , , , and . + This property affects the manner in which the property is treated by the following methods and operators: , , , , and . ]]> diff --git a/xml/System.IdentityModel.Tokens/SessionSecurityTokenHandler.xml b/xml/System.IdentityModel.Tokens/SessionSecurityTokenHandler.xml index 20cc557e23a..405ebf1f430 100644 --- a/xml/System.IdentityModel.Tokens/SessionSecurityTokenHandler.xml +++ b/xml/System.IdentityModel.Tokens/SessionSecurityTokenHandler.xml @@ -26,9 +26,9 @@ > [!NOTE] > The \ configuration element can be used to specify a that has the responsibility for securing the application's sessions. Developers should use caution when changing this configuration setting, as a misconfigured system could result in application compromise. For example, specifying a derived and passing an empty Transforms (CookieTransform) collection to the base, would result in the users identity being serialized into a cookie that was not protected. This could allow an attacker to modify the identity and therefore change access privileges. - If the session token is in reference mode, that is, its property is `true`, the session token handler only serializes properties of the session token that are needed to regenerate its key in the . In the default case, the class is used to represent cache keys, and the token handler writes the and properties of the token. If the session token is not in reference mode, that is, the property is `false`, then, in addition to the properties mentioned previously, the handler invokes the method on a byte array serialized from the token and stores the resulting value in the cookie as well. For more details about how the token is serialized, see the method. + If the session token is in reference mode, that is, its property is `true`, the session token handler only serializes properties of the session token that are needed to regenerate its key in the . In the default case, the class is used to represent cache keys, and the token handler writes the and properties of the token. If the session token is not in reference mode, that is, the property is `false`, then, in addition to the properties mentioned previously, the handler invokes the method on a byte array serialized from the token and stores the resulting value in the cookie as well. For more details about how the token is serialized, see the method. - The property gets the list of transforms that are applied to the session token in the method. All transforms derive from the class. In the default case the and the are applied. The uses the Data Protection API (DPAPI) to protect the cookie material. DPAPI uses a key that is specific to the computer on which it is running in its protection algorithms. For this reason, the default session token handler is not usable in Web farm scenarios because, in such scenarios, tokens written on one computer may need to be read on another computer. You can use many strategies to circumvent this issue. For example, you can: + The property gets the list of transforms that are applied to the session token in the method. All transforms derive from the class. In the default case the and the are applied. The uses the Data Protection API (DPAPI) to protect the cookie material. DPAPI uses a key that is specific to the computer on which it is running in its protection algorithms. For this reason, the default session token handler is not usable in Web farm scenarios because, in such scenarios, tokens written on one computer may need to be read on another computer. You can use many strategies to circumvent this issue. For example, you can: - Replace the default with the . The enables you to specify signing and encryption keys under the ASP.NET `` element in the configuration file. @@ -40,7 +40,7 @@ For more information about using sessions in Web farm scenarios, see [WIF and Web Farms](/dotnet/framework/security/wif-and-web-farms). - The is included in the default token handler collection; however, you can replace it with a custom session token handler by first specifying a [<remove>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/remove) element under the [<securityTokenHandlers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/securitytokenhandlers) element to remove the default handler from the collection and then adding your custom token handler using the [<add>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/add) element. By default, you can specify the default token lifetime by including the [<sessionTokenRequirement>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/sessiontokenrequirement) element under the `` element. You can design a custom token handler to take custom configuration elements under the `` element by overriding the method to provide the logic to process them. + The is included in the default token handler collection; however, you can replace it with a custom session token handler by first specifying a [<remove>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/remove) element under the [<securityTokenHandlers>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/securitytokenhandlers) element to remove the default handler from the collection and then adding your custom token handler using the [<add>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/add) element. By default, you can specify the default token lifetime by including the [<sessionTokenRequirement>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/sessiontokenrequirement) element under the `` element. You can design a custom token handler to take custom configuration elements under the `` element by overriding the method to provide the logic to process them. @@ -186,7 +186,7 @@ ## Remarks When encoding a cookie transforms are applied in the order in which they appear in the property. When decoding a cookie, they are applied in the reverse order. - Called from the and methods to encode and decode the cookie material. + Called from the and methods to encode and decode the cookie material. ]]> @@ -287,7 +287,7 @@ and methods to determine the element under which the encoded token material should be written or read. + This property is used in the and methods to determine the element under which the encoded token material should be written or read. ]]> @@ -318,7 +318,7 @@ and methods to determine the namespace of the element under which the encoded token material should be written or read. + This property is used in the and methods to determine the namespace of the element under which the encoded token material should be written or read. ]]> @@ -389,7 +389,7 @@ , and . If the property is set `true` on the token handler configuration specified by the property, the bootstrap context is created from the property and is saved in the session token. + Creates and returns a session security token by using the following properties in the token descriptor: , and . If the property is set `true` on the token handler configuration specified by the property, the bootstrap context is created from the property and is saved in the session token. ]]> @@ -578,7 +578,7 @@ The reader must be positioned at either a WS-Secure Conversation Feb2005 or a WS-Secure Conversation 1.3 `` element. - The default implementation invokes the method using a default token resolver. + The default implementation invokes the method using a default token resolver. ]]> @@ -618,7 +618,7 @@ [!INCLUDE [untrusted-data-method-note](~/includes/untrusted-data-method-note.md)] - The default implementation creates an over the token and invokes the method. + The default implementation creates an over the token and invokes the method. ]]> @@ -657,9 +657,9 @@ The reader must be positioned at either a WS-Secure Conversation Feb2005 or a WS-Secure Conversation 1.3 `` element. - If the token material is cached, it is read from the token cache, which is an instance of the class. Otherwise, the token material is read from the child element of the `` element that is specified by the and properties and the method is invoked to decode the cookie. + If the token material is cached, it is read from the token cache, which is an instance of the class. Otherwise, the token material is read from the child element of the `` element that is specified by the and properties and the method is invoked to decode the cookie. - For more information about how session tokens are serialized into a ` method. + For more information about how session tokens are serialized into a ` method. ]]> @@ -700,7 +700,7 @@ Sets the list of transforms returned by the property. Transforms will be applied in the order in which they appear in the list when encoding a cookie and in the reverse order when decoding a cookie. > [!WARNING] -> If the `transforms` parameter is `null`, an exception will be thrown from the method when it is called to encode or decode the cookie. +> If the `transforms` parameter is `null`, an exception will be thrown from the method when it is called to encode or decode the cookie. ]]> @@ -728,7 +728,7 @@ property is initialized to the value of the `lifetime` attribute by the method. + By default, if the [<sessionTokenRequirement>](/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/sessiontokenrequirement) element is specified in the configuration file, the property is initialized to the value of the `lifetime` attribute by the method. ]]> @@ -779,7 +779,7 @@ method. + The transforms are applied in the method. ]]> @@ -812,7 +812,7 @@ ## Remarks The token is not valid if its property is set to a value that occurs later than , or if its property is set to a value that occurs earlier than . - Called from the methods to validate the session. + Called from the methods to validate the session. ]]> @@ -859,7 +859,7 @@ method to validate the token. + Invokes the method to validate the token. ]]> @@ -899,7 +899,7 @@ method; otherwise, throws a . + Performs a check to make sure that the specified token is scoped for the specified endpoint ID and, if so, invokes the method; otherwise, throws a . > [!IMPORTANT] > Session tokens that have an property that is `null` or empty are considered to be globally scoped. This presents a potential security risk. For this reason you should make sure that the property is set in your session tokens. @@ -962,7 +962,7 @@ and invoking the method. See that overload for more details. + Serializes the specified token by creating and XML writer over a and invoking the method. See that overload for more details. ]]> @@ -998,7 +998,7 @@ ` element, depending on the value of the property. The property is serialized as the `Id` attribute. The property is serialized as the `` child element. If not `null` the property is serialized as an `` element. Finally, if the property is `false`, the entire token is serialized into binary array which is passed to the method to be encoded. The encoded token is then written as a base64 encoded value to the element and namespace specified by the and properties. If the property is `true`, the token is not serialized. + The default implementation serializes the specified token as either a WS-Secure Conversation Feb2005 or WS-Secure Conversation 1.3 `` element, depending on the value of the property. The property is serialized as the `Id` attribute. The property is serialized as the `` child element. If not `null` the property is serialized as an `` element. Finally, if the property is `false`, the entire token is serialized into binary array which is passed to the method to be encoded. The encoded token is then written as a base64 encoded value to the element and namespace specified by the and properties. If the property is `true`, the token is not serialized. ]]> diff --git a/xml/System.IdentityModel.Tokens/TokenReplayCache.xml b/xml/System.IdentityModel.Tokens/TokenReplayCache.xml index 5f2d31f1295..9397288ef00 100644 --- a/xml/System.IdentityModel.Tokens/TokenReplayCache.xml +++ b/xml/System.IdentityModel.Tokens/TokenReplayCache.xml @@ -20,11 +20,11 @@ The abstract base class that defines methods for a cache used to detect replayed tokens. - method associates a security token with a key and an expiration time. The can be used to search the cache for the token or to remove the token from the cache. The expiration time indicates the time at which the token should be purged from the cache. - + method associates a security token with a key and an expiration time. The can be used to search the cache for the token or to remove the token from the cache. The expiration time indicates the time at which the token should be purged from the cache. + ]]> @@ -150,11 +150,11 @@ The custom configuration XML elements. When overridden in a derived class, loads custom configuration from the specified XML. - - + + ]]> diff --git a/xml/System.IdentityModel.Tokens/WindowsSecurityToken.xml b/xml/System.IdentityModel.Tokens/WindowsSecurityToken.xml index 51503667fb8..130c0d72d30 100644 --- a/xml/System.IdentityModel.Tokens/WindowsSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/WindowsSecurityToken.xml @@ -136,7 +136,7 @@ method to initialize the properties of this class. + This constructor calls the method to initialize the properties of this class. ]]> @@ -232,10 +232,10 @@ method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the was occupying. + Call the method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the was occupying. > [!NOTE] -> Always call the method before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call the method before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -315,7 +315,7 @@ method is called by the constructors for the class. + The method is called by the constructors for the class. ]]> diff --git a/xml/System.IdentityModel.Tokens/X509AsymmetricSecurityKey.xml b/xml/System.IdentityModel.Tokens/X509AsymmetricSecurityKey.xml index f8e62e74f5b..cd357ee18e1 100644 --- a/xml/System.IdentityModel.Tokens/X509AsymmetricSecurityKey.xml +++ b/xml/System.IdentityModel.Tokens/X509AsymmetricSecurityKey.xml @@ -484,7 +484,7 @@ method returns `true` when one of the following is true: + The method returns `true` when one of the following is true: - The `algorithm` parameter is and the public key for the X.509 certificate specified in the constructor is of type . diff --git a/xml/System.IdentityModel.Tokens/X509DataSecurityKeyIdentifierClauseSerializer.xml b/xml/System.IdentityModel.Tokens/X509DataSecurityKeyIdentifierClauseSerializer.xml index 3cd21414c7b..0d9d3fc3aca 100644 --- a/xml/System.IdentityModel.Tokens/X509DataSecurityKeyIdentifierClauseSerializer.xml +++ b/xml/System.IdentityModel.Tokens/X509DataSecurityKeyIdentifierClauseSerializer.xml @@ -87,17 +87,17 @@ if the key identifier clause is supported by this handler; otherwise, . - - -2. - -3. - + + +2. + +3. + ]]> @@ -127,11 +127,11 @@ Deserializes a key identifier clause from XML by using the specified XML reader. The key identifier clause that was deserialized from the XML or if a key identifier clause could not be read. - method reads ``, ``, and `` elements and returns the first one found as a , a , or a . If one of these elements is not found under the `` element, the method returns `null`. - + method reads ``, ``, and `` elements and returns the first one found as a , a , or a . If one of these elements is not found under the `` element, the method returns `null`. + ]]> @@ -164,24 +164,24 @@ The key identifier clause to serialize. Serializes the specified key identifier clause. - - -2. - -3. - + + +2. + +3. + ]]> - is . - - -or- - + is . + + -or- + is . is not a supported clause type. diff --git a/xml/System.IdentityModel.Tokens/X509IssuerSerialKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/X509IssuerSerialKeyIdentifierClause.xml index 61d194c122b..445438fdb89 100644 --- a/xml/System.IdentityModel.Tokens/X509IssuerSerialKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/X509IssuerSerialKeyIdentifierClause.xml @@ -86,7 +86,7 @@ and to the value of the property and the issuer serial number returned from the method, respectively. + This constructor sets the and to the value of the property and the issuer serial number returned from the method, respectively. ]]> @@ -302,7 +302,7 @@ property and calling the method, respectively. + The issuer name and issuer serial number are obtained from the `certificate` parameter, by getting the value of the property and calling the method, respectively. ]]> @@ -377,7 +377,7 @@ method returns the values of the and properties. + The method returns the values of the and properties. ]]> diff --git a/xml/System.IdentityModel.Tokens/X509RawDataKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/X509RawDataKeyIdentifierClause.xml index 204f7ade9c2..ca24dfaf6a4 100644 --- a/xml/System.IdentityModel.Tokens/X509RawDataKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/X509RawDataKeyIdentifierClause.xml @@ -27,21 +27,21 @@ Represents a key identifier clause that identifies a security token using the X.509 certificate's raw data. - does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference a security token using the X.509 certificate's raw data. The method returns the raw data. - - Windows Communication Foundation (WCF) supports the following types of security token references for security tokens. - -- - -- - -- - - - + does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference a security token using the X.509 certificate's raw data. The method returns the raw data. + + Windows Communication Foundation (WCF) supports the following types of security token references for security tokens. + +- + +- + +- + + + ]]> @@ -117,11 +117,11 @@ An that contains the X.509 certificate. Initializes a new instance of the class using the specified X.509 certificate. - method. - + method. + ]]> @@ -157,11 +157,11 @@ in all cases. - method. - + method. + ]]> @@ -261,11 +261,11 @@ if has the raw data that matches the current instance; otherwise, . - method calls the method for the `certificate` and then compares that to the current instance. - + method calls the method for the `certificate` and then compares that to the current instance. + ]]> @@ -301,11 +301,11 @@ Returns the current object. A that represents the current object. - method returns the raw data that is Base-64 encoded. - + method returns the raw data that is Base-64 encoded. + ]]> diff --git a/xml/System.IdentityModel.Tokens/X509SecurityToken.xml b/xml/System.IdentityModel.Tokens/X509SecurityToken.xml index a4a835bcb4c..b439e473b55 100644 --- a/xml/System.IdentityModel.Tokens/X509SecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/X509SecurityToken.xml @@ -249,7 +249,7 @@ method is one of the key identifier clause types that an X.509 certificate key identifier can be expressed in. The possible return types are represented by the , , , and classes. + The return value for the method is one of the key identifier clause types that an X.509 certificate key identifier can be expressed in. The possible return types are represented by the , , , and classes. ]]> @@ -289,10 +289,10 @@ method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the was occupying. + Call the method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the was occupying. > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -360,14 +360,14 @@ method matches criteria in the X.509 certificate in the property based on the type of the `keyIdentifierClause` parameter. The following table details what is matched. + The method matches criteria in the X.509 certificate in the property based on the type of the `keyIdentifierClause` parameter. The following table details what is matched. |Key identifier clause type|What is matched| |--------------------------------|---------------------| -||The value of the property and the issuer serial number returned from the method.| -||The data returned from the method.| +||The value of the property and the issuer serial number returned from the method.| +||The data returned from the method.| ||The subject key identifier extension in the property is matched.| -||The thumbprint that is returned by the method.| +||The thumbprint that is returned by the method.| ]]> diff --git a/xml/System.IdentityModel.Tokens/X509SubjectKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/X509SubjectKeyIdentifierClause.xml index cdeeab60ce5..2cc07a0b3af 100644 --- a/xml/System.IdentityModel.Tokens/X509SubjectKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/X509SubjectKeyIdentifierClause.xml @@ -27,21 +27,21 @@ Represents a key identifier clause that identifies a security token using the X.509 certificate's subject key identifier extension. - does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference a security token using the X.509 certificate's subject key identifier extension. The method returns the subject key identifier extension. - - Windows Communication Foundation supports the following types of security token references for security tokens. - -- - -- - -- - - - + does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference a security token using the X.509 certificate's subject key identifier extension. The method returns the subject key identifier extension. + + Windows Communication Foundation supports the following types of security token references for security tokens. + +- + +- + +- + + + ]]> @@ -111,11 +111,11 @@ if a key identifier clause can be created for ; otherwise, . - extension. - + extension. + ]]> @@ -186,11 +186,11 @@ if has the same subject key identifier as the current instance; otherwise, . - method compares the extension for the two X.509 certificates. - + method compares the extension for the two X.509 certificates. + ]]> @@ -226,11 +226,11 @@ Returns a string that represents the current object. A that represents the current object. - method returns the subject key identifier. - + method returns the subject key identifier. + ]]> @@ -270,11 +270,11 @@ when a key identifier clause can be created for the specified X.509 certificate; otherwise, . - key identifier clause can be created for the X.509 certificate when it contains a subject key identifier. - + key identifier clause can be created for the X.509 certificate when it contains a subject key identifier. + ]]> diff --git a/xml/System.IdentityModel.Tokens/X509ThumbprintKeyIdentifierClause.xml b/xml/System.IdentityModel.Tokens/X509ThumbprintKeyIdentifierClause.xml index 972c5679ef5..9157375cee6 100644 --- a/xml/System.IdentityModel.Tokens/X509ThumbprintKeyIdentifierClause.xml +++ b/xml/System.IdentityModel.Tokens/X509ThumbprintKeyIdentifierClause.xml @@ -27,21 +27,21 @@ Represents a key identifier clause that identifies a security tokens using the X.509 certificate's thumbprint. - does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message token and unattached references reference security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference a security token using the X.509 certificate's thumbprint. The method returns the thumbprint. - - Windows Communication Foundation supports the following types of security token references for security tokens. - -- - -- - -- - -- - + does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message token and unattached references reference security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the class to reference a security token using the X.509 certificate's thumbprint. The method returns the thumbprint. + + Windows Communication Foundation supports the following types of security token references for security tokens. + +- + +- + +- + +- + ]]> @@ -84,10 +84,10 @@ Initializes a new instance of the class using the specified thumbprint for an X.509 certificate. To be added. - is . - - -or- - + is . + + -or- + is zero length. @@ -119,11 +119,11 @@ An that contains the X.509 certificate. Initializes a new instance of the class using the specified X.509 certificate. - method. - + method. + ]]> @@ -225,11 +225,11 @@ Returns a string that represents the current object. A that represents the current object. - method returns the thumbprint. - + method returns the thumbprint. + ]]> diff --git a/xml/System.IdentityModel.Tokens/X509WindowsSecurityToken.xml b/xml/System.IdentityModel.Tokens/X509WindowsSecurityToken.xml index fad6ab34af0..be1aa7440c0 100644 --- a/xml/System.IdentityModel.Tokens/X509WindowsSecurityToken.xml +++ b/xml/System.IdentityModel.Tokens/X509WindowsSecurityToken.xml @@ -163,10 +163,10 @@ method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the was occupying. + Call the method when you are finished using the . The method leaves the in an unusable state. After calling the method, you must release all references to the so the garbage collector can reclaim the memory that the was occupying. > [!NOTE] -> Always call the method before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call the method before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> diff --git a/xml/System.IdentityModel/AsyncResult.xml b/xml/System.IdentityModel/AsyncResult.xml index 5e47b3a7eb4..fa7087b23ac 100644 --- a/xml/System.IdentityModel/AsyncResult.xml +++ b/xml/System.IdentityModel/AsyncResult.xml @@ -28,7 +28,7 @@ ## Remarks For more information see the interface. - The class derives from . + The class derives from . ]]> diff --git a/xml/System.IdentityModel/DelegatingXmlDictionaryReader.xml b/xml/System.IdentityModel/DelegatingXmlDictionaryReader.xml index f55062fb648..7d96b41bc11 100644 --- a/xml/System.IdentityModel/DelegatingXmlDictionaryReader.xml +++ b/xml/System.IdentityModel/DelegatingXmlDictionaryReader.xml @@ -19,7 +19,7 @@ property. Call the method to set the wrapped reader and initialize the property. + The reader that is wrapped can be accessed through the property. Call the method to set the wrapped reader and initialize the property. ]]> diff --git a/xml/System.IdentityModel/DelegatingXmlDictionaryWriter.xml b/xml/System.IdentityModel/DelegatingXmlDictionaryWriter.xml index 5cc8bff8e69..360ddbd516f 100644 --- a/xml/System.IdentityModel/DelegatingXmlDictionaryWriter.xml +++ b/xml/System.IdentityModel/DelegatingXmlDictionaryWriter.xml @@ -19,7 +19,7 @@ property. Call the method to set the wrapped writer and initialize the property. You can call the method to set an to which non-canonical XML will be echoed. + The writer that is wrapped can be accessed through the property. Call the method to set the wrapped writer and initialize the property. You can call the method to set an to which non-canonical XML will be echoed. ]]> diff --git a/xml/System.IdentityModel/EnvelopedSignatureReader.xml b/xml/System.IdentityModel/EnvelopedSignatureReader.xml index e534aa37734..e31c2e9ce62 100644 --- a/xml/System.IdentityModel/EnvelopedSignatureReader.xml +++ b/xml/System.IdentityModel/EnvelopedSignatureReader.xml @@ -48,25 +48,25 @@ The token serializer to be used to deserialize the of the signature. Initializes a new instance of the class by using the specified reader and security token serializer. - constructor is invoked with the following additional parameters: - -|Parameter Name|Value| -|--------------------|-----------| -|`signingTokenResolver`|`null`| -|`requireSignature`|`true`| -|`automaticallyReadSignature`|`true`| -|`resolveIntrinsicSigningKeys`|`true`| - + constructor is invoked with the following additional parameters: + +|Parameter Name|Value| +|--------------------|-----------| +|`signingTokenResolver`|`null`| +|`requireSignature`|`true`| +|`automaticallyReadSignature`|`true`| +|`resolveIntrinsicSigningKeys`|`true`| + ]]> - is . - - -or- - + is . + + -or- + is . @@ -93,24 +93,24 @@ The token resolver to be used to resolve the signing token. specifies that a default security token resolver should be used. Initializes a new instance of the class by using the specified reader, security token serializer, and token resolver. - constructor is invoked with the following additional parameters: - -|Parameter Name|Value| -|--------------------|-----------| -|`requireSignature`|`true`| -|`automaticallyReadSignature`|`true`| -|`resolveIntrinsicSigningKeys`|`true`| - + constructor is invoked with the following additional parameters: + +|Parameter Name|Value| +|--------------------|-----------| +|`requireSignature`|`true`| +|`automaticallyReadSignature`|`true`| +|`resolveIntrinsicSigningKeys`|`true`| + ]]> - is . - - -or- - + is . + + -or- + is . @@ -147,10 +147,10 @@ Initializes a new instance of the class by using the specified reader, security token serializer, token resolver, and behavior. To be added. - is . - - -or- - + is . + + -or- + is . @@ -199,11 +199,11 @@ if the next node was read successfully; if there are no more nodes. - ` element, the whole signature is read in if the `automaticallyReadSignature` parameter was specified `true` in the constructor. - + ` element, the whole signature is read in if the `automaticallyReadSignature` parameter was specified `true` in the constructor. + ]]> @@ -250,11 +250,11 @@ if the signature was successfully read; otherwise, . - ` element, invokes the method to read the signature. - + ` element, invokes the method to read the signature. + ]]> diff --git a/xml/System.IdentityModel/EnvelopedSignatureWriter.xml b/xml/System.IdentityModel/EnvelopedSignatureWriter.xml index d945c837719..e72f25951ac 100644 --- a/xml/System.IdentityModel/EnvelopedSignatureWriter.xml +++ b/xml/System.IdentityModel/EnvelopedSignatureWriter.xml @@ -16,11 +16,11 @@ Wraps a writer and generates a signature automatically when the envelope has been completely written. This class cannot be inherited. - method to indicate the location inside the envelope where the signature should be inserted. - + method to indicate the location inside the envelope where the signature should be inserted. + ]]> @@ -53,14 +53,14 @@ is or empty. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . @@ -107,11 +107,11 @@ Closes one element and pops the corresponding namespace scope. - method was explicitly called, the signature is inserted at the appropriate position inside the envelope; otherwise, it is inserted at the end of the envelope. - + method was explicitly called, the signature is inserted at the appropriate position inside the envelope; otherwise, it is inserted at the end of the envelope. + ]]> @@ -135,11 +135,11 @@ Closes one element and pops the corresponding namespace scope. - method was explicitly called, the signature is inserted at the appropriate position inside the envelope; otherwise, it is inserted at the end of the envelope. - + method was explicitly called, the signature is inserted at the appropriate position inside the envelope; otherwise, it is inserted at the end of the envelope. + ]]> diff --git a/xml/System.IdentityModel/RsaSignatureCookieTransform.xml b/xml/System.IdentityModel/RsaSignatureCookieTransform.xml index 452ba8e2543..e08d2050b3c 100644 --- a/xml/System.IdentityModel/RsaSignatureCookieTransform.xml +++ b/xml/System.IdentityModel/RsaSignatureCookieTransform.xml @@ -174,7 +174,7 @@ ## Remarks The key specified by the property must include the private key in order to sign the data. - The signed data may be verified by calling the method. + The signed data may be verified by calling the method. ]]> diff --git a/xml/System.IdentityModel/Scope.xml b/xml/System.IdentityModel/Scope.xml index 3ae635c0910..f88634e20bf 100644 --- a/xml/System.IdentityModel/Scope.xml +++ b/xml/System.IdentityModel/Scope.xml @@ -23,7 +23,7 @@ objects contain information about the address of the RP, the encrypting and signing credentials to be used with the issued security token, and whether the token itself or symmetric keys issued with the token should be encrypted. By default, both the token and symmetric keys are encrypted. You can extend the class to carry additional information about the request, such as token types accepted by the RP, default token lifetime, maximum token lifetime, algorithm suites used by the RP, and so on; however, the information encapsulated in this class should not vary for individual requests. - The token issuance pipeline is implemented in the method and this method invokes the method to get the configuration for the RST. You must implement a method in your custom STS and return a object appropriate for the RP and your STS implementation. + The token issuance pipeline is implemented in the method and this method invokes the method to get the configuration for the RST. You must implement a method in your custom STS and return a object appropriate for the RP and your STS implementation. ]]> diff --git a/xml/System.IdentityModel/SecurityTokenService.xml b/xml/System.IdentityModel/SecurityTokenService.xml index f1224693ce4..86df4595137 100644 --- a/xml/System.IdentityModel/SecurityTokenService.xml +++ b/xml/System.IdentityModel/SecurityTokenService.xml @@ -19,18 +19,18 @@ class. In your custom class you must, at a minimum, override the and methods. With these overrides, the STS created using the default implementation of all the other methods defined in the class is capable of issuing security tokens in response to security token requests (RST). That is, the Issue binding defined in the WS-Trust specification is implemented. This binding is implemented in the method. None of the other WS-Trust bindings (Renew, Cancel, and Validate) are implemented in the default case and an appropriate fault is returned to the caller if an RST that corresponds to one of these bindings is encountered. You can, of course, override the appropriate methods (, , and ) to implement these bindings in your STS. + To create an STS you must derive from the class. In your custom class you must, at a minimum, override the and methods. With these overrides, the STS created using the default implementation of all the other methods defined in the class is capable of issuing security tokens in response to security token requests (RST). That is, the Issue binding defined in the WS-Trust specification is implemented. This binding is implemented in the method. None of the other WS-Trust bindings (Renew, Cancel, and Validate) are implemented in the default case and an appropriate fault is returned to the caller if an RST that corresponds to one of these bindings is encountered. You can, of course, override the appropriate methods (, , and ) to implement these bindings in your STS. > [!IMPORTANT] > Implementing a production-ready STS entails careful planning and considerable resources to mitigate the potential security risks inherent in exposing such a service. Most developers using Windows Identity Foundation (WIF) will be developing applications that outsource identity management to an STS, rather than developing an STS itself. WIF provides a Visual Studio extension, the Identity and Access Tool for Visual Studio 2012, to help developers test solutions in the development environment. This tool includes an STS, `LocalSTS`, that you can configure to serve specific claims to the application that you are developing. For more information about the Identity and Access tool, see [Identity and Access Tool for Visual Studio 2012](/dotnet/framework/security/identity-and-access-tool-for-vs). In some scenarios, `LocalSTS` may not provide the functionality necessary to adequately test your application; for example, in a scenario that involves developing a custom token handler for use by an application. In these cases, you can derive from to create one or more simple STSs that can be deployed in your development environment and that can be used to test such features in your application. The rest of this section focuses on the methods exposed by the class that enable you to implement a simple STS and extend the token issuance pipeline. The following list provides a brief overview of the methods of primary importance to the developer for use in a test or development environment. -- The method. This method returns a object that contains information about the RP. This object is used in the rest of the token issuance pipeline and includes information about the signing and encrypting credentials to use in the response, as well as the `AppliesTo` and `ReplyTo` (if required) addresses. You must override this method. +- The method. This method returns a object that contains information about the RP. This object is used in the rest of the token issuance pipeline and includes information about the signing and encrypting credentials to use in the response, as well as the `AppliesTo` and `ReplyTo` (if required) addresses. You must override this method. -- The method. This method returns an object that contains the claims to return to the RP. You must override this method. +- The method. This method returns an object that contains the claims to return to the RP. You must override this method. -- The method. This method implements the token request pipeline, which processes an incoming security token request (RST) and returns a response (RSTR) to the caller that contains a token that can be used to authenticate with an RP. Many of the other methods defined in the class are called from this method, including the and methods. You do not have to override this method, but an understanding of the token request pipeline it implements may be helpful. +- The method. This method implements the token request pipeline, which processes an incoming security token request (RST) and returns a response (RSTR) to the caller that contains a token that can be used to authenticate with an RP. Many of the other methods defined in the class are called from this method, including the and methods. You do not have to override this method, but an understanding of the token request pipeline it implements may be helpful. An STS is configured through the class. @@ -41,7 +41,7 @@ :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet3"::: - The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. + The following code shows how to invoke a custom passive STS to process a WS-Federation request by calling the method from the code behind in the `default.aspx.cs` file. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/default.aspx.cs" id="Snippet1"::: @@ -377,7 +377,7 @@ . + Invoked during token issuance after . ]]> @@ -604,7 +604,7 @@ method. + This method is called from the default token issuance pipeline implemented in the method. The default implementation returns the property from configuration accessed through the property. @@ -643,7 +643,7 @@ method is called from the token issuance pipeline, which is implemented by the method. It returns an that contains the claims to include in the issued security token based on the requestor of the token (the `principal` parameter), the incoming RST (the `request` parameter), and the relying party for which the token is intended (the `scope` parameter). The logic in this method is primarily concerned with answering the following questions: + The method is called from the token issuance pipeline, which is implemented by the method. It returns an that contains the claims to include in the issued security token based on the requestor of the token (the `principal` parameter), the incoming RST (the `request` parameter), and the relying party for which the token is intended (the `scope` parameter). The logic in this method is primarily concerned with answering the following questions: - **Which claim types should be included in the response based on the RP for which it is intended?** Typically this is decided on a per-RP basis from lists of claim types required for each RP or on a per-request basis by examining the property of the request. However, the logic and details for determining the claims to include in the response is completely up to your implementation. @@ -652,7 +652,7 @@ ## Examples - The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT) and it includes an implementation of a passive STS that is capable of serving an SWT token. For an example of how to implement an active STS, you can see the `Federation Metadata` sample. For information about these samples and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). The following code shows how to override the method to return claims for your STS. In this example, the Request Security Token (RST) message is ignored and a collection of claims based on the user as authenticated at the STS is returned. + The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT) and it includes an implementation of a passive STS that is capable of serving an SWT token. For an example of how to implement an active STS, you can see the `Federation Metadata` sample. For information about these samples and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). The following code shows how to override the method to return claims for your STS. In this example, the Request Security Token (RST) message is ignored and a collection of claims based on the user as authenticated at the STS is returned. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet6"::: @@ -693,7 +693,7 @@ method. + This method is called from the default token issuance pipeline implemented in the method. The default implementation returns a proof descriptor or throws an appropriate exception. @@ -734,7 +734,7 @@ method. + This method is called from the method. The default implementation does the following. Returns `null` if there is no encryption token specified in the request (the property is `null`). Otherwise, if it can get the token as an , it returns credentials based on that token. If it cannot resolve the token as an , a is thrown. @@ -772,14 +772,14 @@ method is called as the last step from the token issuance pipeline, which is implemented by the method. It creates and returns the response (RSTR) by using the original incoming request (RST) and the token descriptor that was built up during previous steps in the token issuance pipeline. + The method is called as the last step from the token issuance pipeline, which is implemented by the method. It creates and returns the response (RSTR) by using the original incoming request (RST) and the token descriptor that was built up during previous steps in the token issuance pipeline. - The default implementation creates the RSTR by passing the RST specified in the request parameter to the constructor, invoking the method on the token descriptor passed into to apply its properties to the newly created RSTR, setting the property on the RSTR by using the property on the token descriptor, and finally setting the property on the RSTR according to the following table: + The default implementation creates the RSTR by passing the RST specified in the request parameter to the constructor, invoking the method on the token descriptor passed into to apply its properties to the newly created RSTR, setting the property on the RSTR by using the property on the token descriptor, and finally setting the property on the RSTR according to the following table: |`RST.ReplyTo` property| property.|`RSTR.ReplyTo` property| |----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| |Set|Not Set|Not Set| -|Set|Set|| +|Set|Set|| |Not Set|Set|Not Set| |Not Set|Not Set|Not Set| @@ -816,7 +816,7 @@ method is called from the token issuance pipeline after the method and should return a object configured for the incoming request. (The token issuance pipeline is implemented in the method.) The object encapsulates information about the RP associated with the security token request (RST). This includes information about the encrypting and signing credentials to be used with the RP and whether or not to encrypt any issued tokens and/or symmetric keys in the response. Some typical tasks performed in the method are: + The method is called from the token issuance pipeline after the method and should return a object configured for the incoming request. (The token issuance pipeline is implemented in the method.) The object encapsulates information about the RP associated with the security token request (RST). This includes information about the encrypting and signing credentials to be used with the RP and whether or not to encrypt any issued tokens and/or symmetric keys in the response. Some typical tasks performed in the method are: - Determine whether the RP for which the token is intended is a recognized RP. How this is accomplished depends on your implementation. If the intended RP is not a valid RP for this STS, then the method should throw an . @@ -834,7 +834,7 @@ ## Examples The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT) and it includes an implementation of a passive STS that is capable of serving an SWT token. For an example of how to implement an active STS, you can see the `Federation Metadata` sample. For information about these samples and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index). - The following code example shows an implementation of the method. This implementation verifies that the RP is recognized by the STS, validates the address in the request and sets the property accordingly, and sets the signing and encrypting credentials to use with the RP based on certificates that are hard-coded in the file. + The following code example shows an implementation of the method. This implementation verifies that the RP is recognized by the STS, validates the address in the request and sets the property accordingly, and sets the signing and encrypting credentials to use with the RP based on certificates that are hard-coded in the file. :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet5"::: @@ -877,7 +877,7 @@ ## Remarks In the default implementation if `requestedTokenType` is `null` or an empty string, the default token type from configuration is used. This is specified by the property of the STS configuration object accessed through the property. - This method is called from the default token issuance pipeline implemented in the method. + This method is called from the default token issuance pipeline implemented in the method. ]]> @@ -914,12 +914,12 @@ |Created (in)|Expires (in)|Created (in)|Expires (out)| |--------------------|--------------------|--------------------|---------------------| -|`null`|`null`|| + | -|C|`null`|C|C + | +|`null`|`null`|| + | +|C|`null`|C|C + | |`null`|E||E| |C|E|C|E| - This method is called from the default token issuance pipeline implemented in the method. + This method is called from the default token issuance pipeline implemented in the method. ]]> @@ -954,27 +954,27 @@ method processes the incoming request (RST) through a token issuance (claims issuance) pipeline and returns either a response (RSTR) that contains a security token with the appropriate claims to authenticate the requestor with the RP or an appropriate exception. The token issuance pipeline in the default implementation consists of calls to the following methods (of the class). + This method implements the Issue binding defined in the WS-Trust specification. The default implementation of the method processes the incoming request (RST) through a token issuance (claims issuance) pipeline and returns either a response (RSTR) that contains a security token with the appropriate claims to authenticate the requestor with the RP or an appropriate exception. The token issuance pipeline in the default implementation consists of calls to the following methods (of the class). -1. The method to validate the request (RST). +1. The method to validate the request (RST). -2. The method to get a object that contains information about the relying party (RP) associated with the request. You must override this method. If returns `null`, a is thrown. +2. The method to get a object that contains information about the relying party (RP) associated with the request. You must override this method. If returns `null`, a is thrown. -3. The method to return a security token descriptor based on the RST and the object returned in the previous step. The security token descriptor () contains information about the request in a form that can be used by a token handler. The property is set to the descriptor returned by the call. If `null` is returned or if the property of the descriptor is `null`, an is thrown. The exception is also thrown if the property is `true` but the property on the returned descriptor is `null`. +3. The method to return a security token descriptor based on the RST and the object returned in the previous step. The security token descriptor () contains information about the request in a form that can be used by a token handler. The property is set to the descriptor returned by the call. If `null` is returned or if the property of the descriptor is `null`, an is thrown. The exception is also thrown if the property is `true` but the property on the returned descriptor is `null`. -4. The method to get the appropriate token handler based on the kind of token requested. If `null` is returned, a is thrown. +4. The method to get the appropriate token handler based on the kind of token requested. If `null` is returned, a is thrown. -5. The method to get the issuer name for the token. Throws an if the name is `null` or empty; otherwise sets the property on the descriptor. +5. The method to get the issuer name for the token. Throws an if the name is `null` or empty; otherwise sets the property on the descriptor. -6. The method to get the lifetime for the token and sets the property on the descriptor. +6. The method to get the lifetime for the token and sets the property on the descriptor. -7. The method to get the proof token to include in the issued token and sets the property on the descriptor. +7. The method to get the proof token to include in the issued token and sets the property on the descriptor. -8. The method to get the claims to include in the issued token and sets the property on the descriptor. You must override this method. +8. The method to get the claims to include in the issued token and sets the property on the descriptor. You must override this method. -9. The method to create a response (RSTR) that contains the issued token. +9. The method to create a response (RSTR) that contains the issued token. - You can override the method to implement a custom token issuance pipeline; however this is typically not necessary in the development and test environments for which most custom implementations of the class are intended. In many of these cases you override the and methods and optionally override the method to provide a serviceable STS for your environment. If further customization is necessary you can often provide it by overriding the methods that implement each stage of the default token issuance pipeline listed above. + You can override the method to implement a custom token issuance pipeline; however this is typically not necessary in the development and test environments for which most custom implementations of the class are intended. In many of these cases you override the and methods and optionally override the method to provide a serviceable STS for your environment. If further customization is necessary you can often provide it by overriding the methods that implement each stage of the default token issuance pipeline listed above. ]]> @@ -1179,7 +1179,7 @@ method is called from the token issuance pipeline (the method) to validate the incoming RST. The RST is validated against the requirements (policy) of the STS and an appropriate exception is thrown if it is not valid. + The method is called from the token issuance pipeline (the method) to validate the incoming RST. The RST is validated against the requirements (policy) of the STS and an appropriate exception is thrown if it is not valid. The default implementation of the class supports only the RST-RSTR pattern and only the Issue binding of the WS-Trust specification (the property of the request must be set to ). The default implementation of this method enforces these requirements (and others noted in the exceptions section). You can override this method if you must enforce different validation requirements for your custom STS. diff --git a/xml/System.IdentityModel/TypedAsyncResult`1.xml b/xml/System.IdentityModel/TypedAsyncResult`1.xml index 5cacae5b060..238c679fb9b 100644 --- a/xml/System.IdentityModel/TypedAsyncResult`1.xml +++ b/xml/System.IdentityModel/TypedAsyncResult`1.xml @@ -50,11 +50,11 @@ A user-defined object that qualifies or contains information about an asynchronous operation. Initializes a new instance of the class that has a state object. - instance does not need a callback delegate. - + instance does not need a callback delegate. + ]]> diff --git a/xml/System.IdentityModel/UnsupportedTokenTypeBadRequestException.xml b/xml/System.IdentityModel/UnsupportedTokenTypeBadRequestException.xml index 5658e5c3680..f94d471dffd 100644 --- a/xml/System.IdentityModel/UnsupportedTokenTypeBadRequestException.xml +++ b/xml/System.IdentityModel/UnsupportedTokenTypeBadRequestException.xml @@ -205,7 +205,7 @@ sets a with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the transmitted over the stream. + sets a with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the transmitted over the stream. ]]> diff --git a/xml/Windows.Foundation/Point.xml b/xml/Windows.Foundation/Point.xml index 084482e698a..eb1a4934add 100644 --- a/xml/Windows.Foundation/Point.xml +++ b/xml/Windows.Foundation/Point.xml @@ -83,7 +83,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Point` struct. For more information, see [Point](https://learn.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -215,7 +215,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Point` struct. For more information, see [Point](https://learn.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -252,7 +252,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Point` struct. For more information, see [Point](https://learn.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> diff --git a/xml/Windows.Foundation/Rect.xml b/xml/Windows.Foundation/Rect.xml index a6b9c9b4e03..683fc8b2599 100644 --- a/xml/Windows.Foundation/Rect.xml +++ b/xml/Windows.Foundation/Rect.xml @@ -190,7 +190,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -240,7 +240,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -335,7 +335,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -398,7 +398,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -496,7 +496,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -533,7 +533,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -656,7 +656,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> @@ -729,7 +729,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Rect` struct. For more information, see [Rect](https://learn.microsoft.com/uwp/api/windows.foundation.rect) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) + For more information and examples of this member, see in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.) ]]> diff --git a/xml/Windows.Foundation/Size.xml b/xml/Windows.Foundation/Size.xml index 4a3ad8dad62..9a09ec89b6e 100644 --- a/xml/Windows.Foundation/Size.xml +++ b/xml/Windows.Foundation/Size.xml @@ -111,7 +111,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://learn.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference. - For more information about this member, see in the .NET Framework API reference. + For more information about this member, see in the .NET Framework API reference. ]]> @@ -371,7 +371,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://learn.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference. - For more information about this member, see in the .NET Framework API reference. + For more information about this member, see in the .NET Framework API reference. ]]> diff --git a/xml/Windows.UI.Xaml.Media/Matrix.xml b/xml/Windows.UI.Xaml.Media/Matrix.xml index 22720fad623..ac496ea03de 100644 --- a/xml/Windows.UI.Xaml.Media/Matrix.xml +++ b/xml/Windows.UI.Xaml.Media/Matrix.xml @@ -446,7 +446,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Matrix` struct. For more information, see [Matrix](https://learn.microsoft.com/uwp/api/windows.ui.xaml.media.matrix) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. + For more information and examples of this member, see in the .NET Framework API reference. ]]> @@ -483,7 +483,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Matrix` struct. For more information, see [Matrix](https://learn.microsoft.com/uwp/api/windows.ui.xaml.media.matrix) in the UWP API reference. - For more information and examples of this member, see in the .NET Framework API reference. + For more information and examples of this member, see in the .NET Framework API reference. ]]> diff --git a/xml/Windows.UI/Color.xml b/xml/Windows.UI/Color.xml index fbfbcb5f661..160a59a7359 100644 --- a/xml/Windows.UI/Color.xml +++ b/xml/Windows.UI/Color.xml @@ -113,7 +113,7 @@ ## Remarks This struct represents the .NET projection of the Windows Runtime (WinRT) `Color` struct. For more information, see [Color](https://learn.microsoft.com/uwp/api/windows.ui.color) in the UWP API reference. - For more information about this member, see in the .NET Framework API reference. + For more information about this member, see in the .NET Framework API reference. ]]>