diff --git a/xml/Microsoft.SqlServer.Server/SqlMetaData.xml b/xml/Microsoft.SqlServer.Server/SqlMetaData.xml index c24a3e3f83a..8bc9c6e8a92 100644 --- a/xml/Microsoft.SqlServer.Server/SqlMetaData.xml +++ b/xml/Microsoft.SqlServer.Server/SqlMetaData.xml @@ -176,19 +176,17 @@ 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| -|---------------|---------------|-----------|------------|---------------------| -|Binary|0|0|0|IgnoreCase, IgnoreKanaType, IgnoreWidth| -|Char|0|0|\|IgnoreCase, IgnoreKanaType, IgnoreWidth| -|Image|0|0|0|None| -|NChar|0|0|\|IgnoreCase, IgnoreKanaType, IgnoreWidth| -|NText|0|0|\|IgnoreCase, IgnoreKanaType, IgnoreWidth| -|NVarChar|0|0|\|IgnoreCase, IgnoreKanaType, IgnoreWidth| -|Text|0|0|\|IgnoreCase, IgnoreKanaType, IgnoreWidth| -|VarBinary|0|0||IgnoreCase, IgnoreKanaType, IgnoreWidth| -|VarChar|0|0|\|IgnoreCase, IgnoreKanaType, IgnoreWidth| - - +| SqlDbType | Precision | Scale | Locale | Compare options | +|-----------|-----------|-------|-----------|-----------------------------------------| +| Binary | 0 | 0 | 0 | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| Char | 0 | 0 | \ | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| Image | 0 | 0 | 0 | None | +| NChar | 0 | 0 | \ | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| NText | 0 | 0 | \ | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| NVarChar | 0 | 0 | \ | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| Text | 0 | 0 | \ | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| VarBinary | 0 | 0 | | IgnoreCase, IgnoreKanaType, IgnoreWidth | +| VarChar | 0 | 0 | \ | IgnoreCase, IgnoreKanaType, IgnoreWidth | ## Examples The following example creates a new object by specifying the column name, a column data type of `.NVarChar`, and a maximum length of 12 characters. diff --git a/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml b/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml index a340881c604..488277fe613 100644 --- a/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml +++ b/xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml @@ -25,28 +25,28 @@ Provides properties, methods, and events related to the current application. - provides members that are available in all projects. - -- provides members that are available in Windows Forms applications. - -- provides members that are available in console applications. - - - -## 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 . - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet10"::: - - This example requires that your Windows Forms application have a form named `Form1` that contains a list box named `ListBox1`. - + provides members that are available in all projects. + +- provides members that are available in Windows Forms applications. + +- provides members that are available in console applications. + + + +## 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 . + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet10"::: + + This example requires that your Windows Forms application have a form named `Form1` that contains a list box named `ListBox1`. + ]]> @@ -130,13 +130,13 @@ One of the enumeration values that specifies the application's authentication mode. Initializes a new instance of the class with the specified authentication mode. - enumeration value, then this constructor attempts to set the current thread's property to the for the current user. - - If the `authenticationMode` parameter is the enumeration value, then this constructor leaves the current thread's property unchanged. - + enumeration value, then this constructor attempts to set the current thread's property to the for the current user. + + If the `authenticationMode` parameter is the enumeration value, then this constructor leaves the current thread's property unchanged. + ]]> Objects (Visual Basic) @@ -180,23 +180,23 @@ Gets the object for the current thread of a Windows Forms application. Contextual information about the current thread. - @@ -285,50 +285,50 @@ Processes all Windows messages currently in the message queue. - 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. - - If you call `My.Application.DoEvents` in your code, your application can handle the other events. For example, if your code adds data to a in a loop, and after each step of the loop it calls `My.Application.DoEvents`, your form repaints when another window is dragged over it. If you remove `My.Application.DoEvents` from your code, your form will not repaint until the click event handler of the button is finished executing. - - Typically, you use this method in a loop to process messages. - + 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. + + If you call `My.Application.DoEvents` in your code, your application can handle the other events. For example, if your code adds data to a in a loop, and after each step of the loop it calls `My.Application.DoEvents`, your form repaints when another window is dragged over it. If you remove `My.Application.DoEvents` from your code, your form will not repaint until the click event handler of the button is finished executing. + + Typically, you use this method in a loop to process messages. + > [!NOTE] -> The `My.Application.DoEvents` method does not process events in exactly the same way as the form does. Use multithreading to make the form directly handle the events. For more information, see [Using threads and threading](/dotnet/standard/threading/using-threads-and-threading). - +> The `My.Application.DoEvents` method does not process events in exactly the same way as the form does. Use multithreading to make the form directly handle the events. For more information, see [Using threads and threading](/dotnet/standard/threading/using-threads-and-threading). + > [!CAUTION] -> If a method that handles a user interface (UI) event calls the `My.Application.DoEvents` method, the method might be re-entered before it finishes. This can happen because the `My.Application.DoEvents` method processes Windows messages, and Windows messages can raise events. - - The following table lists an example of a task involving the `My.Application.DoEvents` method. - -|To|See| -|-|-| -|Allow a form to respond to UI input while busy|[Walkthrough: Handling Events](/dotnet/visual-basic/programming-guide/language-features/events/walkthrough-handling-events)| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example uses the `My.Application.DoEvents` method to allow the UI for `TextBox1` to update. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet6"::: - - This code should be in a form that has a `TextBox1` component with a `Text` property. - +> If a method that handles a user interface (UI) event calls the `My.Application.DoEvents` method, the method might be re-entered before it finishes. This can happen because the `My.Application.DoEvents` method processes Windows messages, and Windows messages can raise events. + + The following table lists an example of a task involving the `My.Application.DoEvents` method. + +|To|See| +|-|-| +|Allow a form to respond to UI input while busy|[Walkthrough: Handling Events](/dotnet/visual-basic/programming-guide/language-features/events/walkthrough-handling-events)| + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example uses the `My.Application.DoEvents` method to allow the UI for `TextBox1` to update. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet6"::: + + This code should be in a form that has a `TextBox1` component with a `Text` property. + ]]> @@ -373,11 +373,11 @@ Determines whether this application will use the Windows XP styles for windows, controls, and so on. A value that indicates whether this application will use the XP Windows styles for windows, controls, and so on. - method uses this property to determine whether to call . - + method uses this property to determine whether to call . + ]]> @@ -423,13 +423,13 @@ Hides the application's splash screen. - class creates the splash screen on a separate thread. This method marshals the call to the correct thread. - - This method is called when the main form is done loading. - + class creates the splash screen on a separate thread. This method marshals the call to the correct thread. + + This method is called when the main form is done loading. + ]]> @@ -511,11 +511,11 @@ to indicate this application is a single-instance application; otherwise, . - method uses this property to determine whether this application is a single-instance application. - + method uses this property to determine whether this application is a single-instance application. + ]]> @@ -550,15 +550,15 @@ Gets or sets the main form for this application. The main form for this application. - object that the Visual Basic Application Startup/Shutdown model uses as the application's main form. - - This property supports the Visual Basic Application Startup/Shutdown 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). - - The changes to this property are not persisted when the application closes. To change the main form permanently, you must change the setting in the **Project Designer**. - + object that the Visual Basic Application Startup/Shutdown model uses as the application's main form. + + This property supports the Visual Basic Application Startup/Shutdown 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). + + The changes to this property are not persisted when the application closes. To change the main form permanently, you must change the setting in the **Project Designer**. + ]]> @@ -607,45 +607,46 @@ Gets or sets the minimum length of time, in milliseconds, for which the splash screen is displayed. The minimum length of time, in milliseconds, for which the splash screen is displayed. - 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| -|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example demonstrates how to set the `My.Application.MinimumSplashScreenDisplayTime` property by overriding the property. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet51"::: - - This example requires that the project have a splash screen. - - You must enter this code in the Code Editor window for application events. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - + 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: + +1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu. +2. Click the **Application** tab. +3. Click the **View Application Events** button to open the Code Editor. + +For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + +## Examples + This example demonstrates how to set the `My.Application.MinimumSplashScreenDisplayTime` property by overriding the property. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet51"::: + + This example requires that the project have a splash screen. + + You must enter this code in the Code Editor window for application events. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + ]]> @@ -683,48 +684,51 @@ Occurs when the network availability changes. - 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. - - The event provides the same functionality as this event but is available for all application types. - - The code for the `NetworkAvailabilityChanged` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. - -| | -|-| -|To access the Code Editor window for application events| -|1. Have a project selected in **Solution Explorer.** Click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| - + 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. + + The event provides the same functionality as this event but is available for all application types. + + The code for the `NetworkAvailabilityChanged` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. + +To access the Code Editor window for application events: + +1. Have a project selected in **Solution Explorer.** Click **Properties** on the **Project** menu. +2. Click the **Application** tab. +3. Click the **View Application Events** button to open the Code Editor. + +For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + > [!NOTE] -> Many network hubs will provide a network connection even if the hub is disconnected from a larger network. Consequently, for wired connections, this event indicates change in the connection between the computer and a hub. - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example calls the `SetConnectionStatus` method of the default `Form1` class when the network availability changes. - - You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. - - The project should have a form named `Form1`. It should have a method named `SetConnectionStatus` that takes a `Boolean` parameter. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet9"::: - +> Many network hubs will provide a network connection even if the hub is disconnected from a larger network. Consequently, for wired connections, this event indicates change in the connection between the computer and a hub. + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example calls the `SetConnectionStatus` method of the default `Form1` class when the network availability changes. + + You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. + + The project should have a form named `Form1`. It should have a method named `SetConnectionStatus` that takes a `Boolean` parameter. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet9"::: + ]]> @@ -769,13 +773,13 @@ When overridden in a derived class, allows a designer to emit code that configures the splash screen and main form. - property to a new instance of the main form. - - This method is called by the method. - + property to a new instance of the main form. + + This method is called by the method. + ]]> Extending the Visual Basic Application Model @@ -815,13 +819,13 @@ When overridden in a derived class, allows a designer to emit code that initializes the splash screen. - method with a method that sets the property to a new instance of the splash-screen form. - - This method is called by the method. - + method with a method that sets the property to a new instance of the splash-screen form. + + This method is called by the method. + ]]> Extending the Visual Basic Application Model @@ -869,17 +873,17 @@ Sets the visual styles, text display styles, and current principal for the main application thread (if the application uses Windows authentication), and initializes the splash screen, if defined. A indicating if application startup should continue. - . - -- . - + . + +- . + ]]> @@ -926,19 +930,19 @@ Provides the starting point for when the main application is ready to start running, after the initialization is done. - . 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. - -- . 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. - + . 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. + +- . 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. + ]]> Extending the Visual Basic Application Model @@ -978,13 +982,13 @@ When overridden in a derived class, allows for code to run when the application shuts down. - event. - + event. + ]]> Extending the Visual Basic Application Model @@ -1029,11 +1033,11 @@ When overridden in a derived class, allows for code to run when the application starts. A that indicates if the application should continue starting up. - 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`. - + 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`. + ]]> @@ -1082,11 +1086,11 @@ The command-line arguments of the subsequent application instance and indicates whether the first application instance should be brought to the foreground upon exiting the exception handler. When overridden in a derived class, allows for code to run when a subsequent instance of a single-instance application starts. - 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. - + 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. + ]]> @@ -1133,11 +1137,11 @@ When overridden in a derived class, allows for code to run when an unhandled exception occurs in the application. A that indicates whether the event was raised. - 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. - + 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. + ]]> @@ -1173,37 +1177,37 @@ Gets a collection of all the application's open forms. A collection that contains all of the application's open forms. - property. - + property. + > [!NOTE] -> The `My.Application.OpenForms` property returns all open forms, regardless of which thread opened them. You should check the property of each form before accessing it; otherwise, it might throw an exception. - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example loops over the application's open forms, selects the ones directly accessible by the current thread, and displays their titles in a control. This example requires that your Windows Forms application have a form named `Form1` that contains a list box named `ListBox1`. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet10"::: - - This example loops over the application's open forms and displays their titles in a control. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet11"::: - +> The `My.Application.OpenForms` property returns all open forms, regardless of which thread opened them. You should check the property of each form before accessing it; otherwise, it might throw an exception. + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example loops over the application's open forms, selects the ones directly accessible by the current thread, and displays their titles in a control. This example requires that your Windows Forms application have a form named `Form1` that contains a list box named `ListBox1`. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet10"::: + + This example loops over the application's open forms and displays their titles in a control. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet11"::: + ]]> @@ -1248,23 +1252,23 @@ The command line from . Sets up and starts the Visual Basic Application model. - Objects (Visual Basic) @@ -1310,43 +1314,44 @@ to indicate that the application saves the user settings on exit. Otherwise, to indicate the settings are not implicitly saved. - 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**: - -| | -|-| -|To change the setting in the Project Designer| -|1. Have a project selected in **Solution Explorer**. Click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Select **Save My.Settings on Shutdown**.| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example has two parts. - -- The `InitializeSaveMySettingsOnExit` subroutine, which initializes the checked state of a control to the current value of the `SaveMySettingsOnExit` property. - -- The `SaveMySettingsOnExit_CheckedChanged` subroutine, which handles changes to a control to update the `My.Application.SaveMySettingsOnExit` property. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet12"::: - - For this example to work, your application must have a control named `SaveMySettingsOnExit`. - + 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**: + +To change the setting in the Project Designer: + +1. Have a project selected in **Solution Explorer**. Click **Properties** on the **Project** menu. +2. Click the **Application** tab. +3. Select **Save My.Settings on Shutdown**.| + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example has two parts. + +- The `InitializeSaveMySettingsOnExit` subroutine, which initializes the checked state of a control to the current value of the `SaveMySettingsOnExit` property. + +- The `SaveMySettingsOnExit_CheckedChanged` subroutine, which handles changes to a control to update the `My.Application.SaveMySettingsOnExit` property. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/Form1.vb" id="Snippet12"::: + + For this example to work, your application must have a control named `SaveMySettingsOnExit`. + ]]> @@ -1387,15 +1392,15 @@ Determines if the application has a splash screen defined, and if it does, displays it. - 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. - + 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. + ]]> @@ -1430,39 +1435,42 @@ Occurs when the application shuts down. - 2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example logs messages when the application shuts down. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet13"::: - - You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. For more information, see [How to: Log Messages When the Application Starts or Shuts Down](/dotnet/visual-basic/developing-apps/programming/log-info/how-to-log-messages-when-the-application-starts-or-shuts-down). - + @@ -1506,11 +1514,11 @@ Determines what happens when the application's main form closes. One of the enumeration values that indicates what the application should do when the main form closes. - 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. - + 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. + ]]> @@ -1550,38 +1558,38 @@ Gets or sets the splash screen for this application. The splash screen for the application. - object that the application uses as the splash screen, the first graphic form that is displayed while an application is being started. - - 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). - - The changes to this property are not persisted when the application closes. To change the splash screen permanently, you must change the setting in the **Project Designer**. - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example uses the `My.Application.SplashScreen` property and the `My.Application.Startup` event to update the splash screen with status information as the application starts. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet14"::: - - This example requires that the project have a splash screen named `SplashScreen1`. The splash screen needs to have a property named `Status` that updates its user interface. - - You must enter this code in the Code Editor window for application events. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - + object that the application uses as the splash screen, the first graphic form that is displayed while an application is being started. + + 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). + + The changes to this property are not persisted when the application closes. To change the splash screen permanently, you must change the setting in the **Project Designer**. + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example uses the `My.Application.SplashScreen` property and the `My.Application.Startup` event to update the splash screen with status information as the application starts. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet14"::: + + This example requires that the project have a splash screen named `SplashScreen1`. The splash screen needs to have a property named `Status` that updates its user interface. + + You must enter this code in the Code Editor window for application events. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + ]]> The same value is assigned to this property and the property. @@ -1618,47 +1626,50 @@ Occurs when the application starts. - . - - 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). - - You can use the property of the `e` parameter to control the loading of an application's startup form. When the property is set to `True`, the startup form does not start. In that case, your code should call an alternate startup code path. - - You can use the property of the `e` parameter or the property to access the application's command-line arguments. - - The code for the `Startup` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. - -| | -|-| -|To access the Code Editor window for application events| -|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example uses the `My.Application.SplashScreen` property and the `My.Application.Startup` event to update the splash screen with status information as the application starts. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet14"::: - - This example requires that the project have a splash screen named `SplashScreen1`. The splash screen needs to have property named `Status` that updates its user interface. - - You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - + . + + 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). + + You can use the property of the `e` parameter to control the loading of an application's startup form. When the property is set to `True`, the startup form does not start. In that case, your code should call an alternate startup code path. + + You can use the property of the `e` parameter or the property to access the application's command-line arguments. + + The code for the `Startup` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. + +To access the Code Editor window for application events: + +1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu. +2. Click the **Application** tab. +3. Click the **View Application Events** button to open the Code Editor. + +For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example uses the `My.Application.SplashScreen` property and the `My.Application.Startup` event to update the splash screen with status information as the application starts. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet14"::: + + This example requires that the project have a splash screen named `SplashScreen1`. The splash screen needs to have property named `Status` that updates its user interface. + + You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + ]]> @@ -1696,59 +1707,58 @@ Occurs when attempting to start a single-instance application and the application is already active. - event when you attempt to restart the application when it is already active. When a single-instance application starts for the first time, it raises the event. For more information, see . - - 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. - + event when you attempt to restart the application when it is already active. When a single-instance application starts for the first time, it raises the event. For more information, see . + + 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. + > [!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. - -| | -|-| -|To make an application single instance| -|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Select the **Make single instance application** check box.| - - You must use the property of the `e` parameter to access the arguments for subsequent attempts to start a single-instance application. The property provides the arguments used to start the first instance of a single-instance application. - - The code for the event handler is stored in the ApplicationEvents.vb file, which is hidden by default. - -| | -|-| -|To access the Code Editor window for application events| -|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| - - The following table lists examples of tasks involving the `My.Application.StartupNextInstance` event. - -|To|See| -|-|-| -|Check the command-line arguments of the first application instance|| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|Yes| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example uses the `e` parameter of the event handler to examine the application's command-line arguments. If an argument is found that starts with `/input=`, the rest of that argument is displayed. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet15"::: - - You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - +> 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. + +To make an application single instance: + +1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu. +2. Click the **Application** tab. +3. Select the **Make single instance application** check box.| + + You must use the property of the `e` parameter to access the arguments for subsequent attempts to start a single-instance application. The property provides the arguments used to start the first instance of a single-instance application. + + The code for the event handler is stored in the ApplicationEvents.vb file, which is hidden by default. + +To access the Code Editor window for application events: +|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| + + The following table lists examples of tasks involving the `My.Application.StartupNextInstance` event. + +|To|See| +|-|-| +|Check the command-line arguments of the first application instance|| + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|Yes| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example uses the `e` parameter of the event handler to examine the application's command-line arguments. If an argument is found that starts with `/input=`, the rest of that argument is displayed. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet15"::: + + You must enter the code in the Code Editor window for application events. To access this window, follow the instructions from this topic's Remarks section. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + ]]> @@ -1787,57 +1797,55 @@ Occurs when the application encounters an unhandled exception. - 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. - - The code for the `UnhandledException` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. - -| | -|-| -|To access the Code Editor window for application events| -|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.| - - For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - + 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. + + The code for the `UnhandledException` event handler is stored in the ApplicationEvents.vb file, which is hidden by default. + +To access the Code Editor window for application events: +|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.| + + For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + > [!NOTE] -> The Visual Basic compiler prevents applications that are built for debugging from raising this event, to enable a debugger to handle the unhandled exceptions. This means that if you are testing your application by running it under the Visual Studio Integrated Development Environment debugger, your `UnhandledException` event handler will not be called. For more information about building applications for debugging, see [/debug (Visual Basic)](/dotnet/visual-basic/reference/command-line-compiler/debug). - -## Tasks - The following table lists examples of tasks that involve the `My.Application.UnhandledException` event. - -|To|See| -|-|-| -|Log unhandled exceptions|[How to: Log Exceptions](/dotnet/visual-basic/developing-apps/programming/log-info/how-to-log-exceptions)| - -## Availability by Project Type - -|Project type|Available| -|-|-| -|Windows Forms Application|**Yes**| -|Class Library|No| -|Console Application|No| -|Windows Forms Control Library|No| -|Web Control Library|No| -|Windows Service|No| -|Web Site|No| - - - -## Examples - This example uses the `My.Application.UnhandledException` event to log any unhandled exceptions. - - You must enter the code in the Code Editor window for application events. To access this window, follow the procedure found in this topic's Remarks section. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - - Because the `UnhandledException` event is not raised when a debugger is attached to the application, you have to run this example outside the Visual Studio Integrated Development Environment. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet17"::: - +> The Visual Basic compiler prevents applications that are built for debugging from raising this event, to enable a debugger to handle the unhandled exceptions. This means that if you are testing your application by running it under the Visual Studio Integrated Development Environment debugger, your `UnhandledException` event handler will not be called. For more information about building applications for debugging, see [/debug (Visual Basic)](/dotnet/visual-basic/reference/command-line-compiler/debug). + +## Tasks + The following table lists examples of tasks that involve the `My.Application.UnhandledException` event. + +|To|See| +|-|-| +|Log unhandled exceptions|[How to: Log Exceptions](/dotnet/visual-basic/developing-apps/programming/log-info/how-to-log-exceptions)| + +## Availability by Project Type + +|Project type|Available| +|-|-| +|Windows Forms Application|**Yes**| +|Class Library|No| +|Console Application|No| +|Windows Forms Control Library|No| +|Web Control Library|No| +|Windows Service|No| +|Web Site|No| + + + +## Examples + This example uses the `My.Application.UnhandledException` event to log any unhandled exceptions. + + You must enter the code in the Code Editor window for application events. To access this window, follow the procedure found in this topic's Remarks section. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + + Because the `UnhandledException` event is not raised when a debugger is attached to the application, you have to run this example outside the Visual Studio Integrated Development Environment. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyApplication/VB/FakeMyEvents.vb" id="Snippet17"::: + ]]> @@ -1883,36 +1891,37 @@ . A value of indicates that the application should use the default text rendering engine for Visual Basic 2005. A value of indicates that the application should use the text rendering engine for Visual Basic .NET 2002 and Visual Basic .NET 2003. - constructor. - - 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| -|1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu.
2. Click the **Application** tab.
3. Click the **View Application Events** button to open the Code Editor.

For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic).| - - - -## Examples - This example demonstrates how to set the GDI+ text rendering engine as the application's default rendering engine by overriding the property. - -```vb -Protected Overloads Shared ReadOnly Property UseCompatibleTextRendering() As Boolean - Get - ' Use the GDI+ text rendering engine. - Return True - End Get -End Property -``` - - You must enter this code in the Code Editor window for application events. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). - + constructor. + + 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: + +1. With a project selected in **Solution Explorer**, click **Properties** on the **Project** menu. +2. Click the **Application** tab. +3. Click the **View Application Events** button to open the Code Editor. + +For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + +## Examples + This example demonstrates how to set the GDI+ text rendering engine as the application's default rendering engine by overriding the property. + +```vb +Protected Overloads Shared ReadOnly Property UseCompatibleTextRendering() As Boolean + Get + ' Use the GDI+ text rendering engine. + Return True + End Get +End Property +``` + + You must enter this code in the Code Editor window for application events. For more information, see [Application Page, Project Designer (Visual Basic)](https://learn.microsoft.com/visualstudio/ide/reference/application-page-project-designer-visual-basic). + ]]> Extending the Visual Basic Application Model diff --git a/xml/System.Buffers.Text/Utf8Formatter.xml b/xml/System.Buffers.Text/Utf8Formatter.xml index a36ef1ccb04..ad710d2488d 100644 --- a/xml/System.Buffers.Text/Utf8Formatter.xml +++ b/xml/System.Buffers.Text/Utf8Formatter.xml @@ -139,12 +139,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|122| -|N/n|122| -|X/x|7a| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 122 | +| N/n | 122 | +| X/x | 7a | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -197,12 +197,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string|Comments| -|--|--|--| -|G (default)|05/25/2017 10:30:15| | -|R|Tue, 03 Jan 2017 08:08:05 GMT|(RFC 1123)| -|l|tue, 03 jan 2017 08:08:05 gmt|(Lowercase RFC 1123)| -|O|2017-06-12T05:30:45.7680000-07:00|(Round-trippable)| +| Format string | Example result string | Comments | +|---------------|-----------------------------------|----------------------| +| G (default) | 05/25/2017 10:30:15 | | +| R | Tue, 03 Jan 2017 08:08:05 GMT | (RFC 1123) | +| l | tue, 03 jan 2017 08:08:05 gmt | (Lowercase RFC 1123) | +| O | 2017-06-12T05:30:45.7680000-07:00 | (Round-trippable) | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -298,11 +298,11 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string|Comments| -|--|--|--| -|G/g (default)| | -|F/f|12.45|Fixed point| -|E/e|1.245000e1|Exponential| +| Format string | Example result string | Comments | +|----------------|-----------------------|-------------| +| G/g (default) | | +| F/f | 12.45 | Fixed point | +| E/e | 1.245000e1 | Exponential | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -355,11 +355,11 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string|Comments| -|--|--|--| -|G/g (default)| | -|F/f|12.45|Fixed point| -|E/e|1.245000e1|Exponential| +| Format string | Example result string | Comments | +|----------------|-----------------------|-------------| +| G/g (default) | | +| F/f | 12.45 | Fixed point | +| E/e | 1.245000e1 | Exponential | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -470,12 +470,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -528,12 +528,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -586,12 +586,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -650,12 +650,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|122| -|N/n|122| -|X/x|7a| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 122 | +| N/n | 122 | +| X/x | 7a | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -708,11 +708,11 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string|Comments| -|--|--|--| -|G/g (default)| | -|F/f|12.45|Fixed point| -|E/e|1.245000e1|Exponential| +| Format string | Example result string | Comments | +|----------------|-----------------------|-------------| +| G/g (default) | | +| F/f | 12.45 | Fixed point | +| E/e | 1.245000e1 | Exponential | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -828,12 +828,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -892,12 +892,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. @@ -956,12 +956,12 @@ If the method fails, iteratively increase the size of the buffer and retry until Formats supported: -|Format string|Example result string| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example result string | +|---------------|-----------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | If the method fails, iteratively increase the size of the buffer and retry until it succeeds. diff --git a/xml/System.Buffers.Text/Utf8Parser.xml b/xml/System.Buffers.Text/Utf8Parser.xml index b7bfcbfba44..d177a021906 100644 --- a/xml/System.Buffers.Text/Utf8Parser.xml +++ b/xml/System.Buffers.Text/Utf8Parser.xml @@ -132,12 +132,12 @@ The parsing is case insensitive. The format parameter is validated to ensure it Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|122| -|N/n|122| -|X/x|7a| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 122 | +| N/n | 122 | +| X/x | 7a | ]]> @@ -188,12 +188,12 @@ Formats supported: Formats supported: -|Format string|Example expected format|Comments| -|--|--|--| -|G (default)|05/25/2017 10:30:15| | -|R|Tue, 03 Jan 2017 08:08:05 GMT|(RFC 1123)| -|l|tue, 03 jan 2017 08:08:05 gmt|(Lowercase RFC 1123)| -|O|2017-06-12T05:30:45.7680000-07:00|(Round-trippable)| +| Format string | Example expected format | Comments | +|---------------|-----------------------------------|----------------------| +| G (default) | 05/25/2017 10:30:15 | | +| R | Tue, 03 Jan 2017 08:08:05 GMT | (RFC 1123) | +| l | tue, 03 jan 2017 08:08:05 gmt | (Lowercase RFC 1123) | +| O | 2017-06-12T05:30:45.7680000-07:00 | (Round-trippable) | ]]> @@ -244,12 +244,12 @@ Formats supported: Formats supported: -|Format string|Example expected format|Comments| -|--|--|--| -|G (default)|05/25/2017 10:30:15| | -|R|Tue, 03 Jan 2017 08:08:05 GMT|(RFC 1123)| -|l|tue, 03 jan 2017 08:08:05 gmt|(Lowercase RFC 1123)| -|O|2017-06-12T05:30:45.7680000-07:00|(Round-trippable)| +| Format string | Example expected format | Comments | +|---------------|-----------------------------------|----------------------| +| G (default) | 05/25/2017 10:30:15 | | +| R | Tue, 03 Jan 2017 08:08:05 GMT | (RFC 1123) | +| l | tue, 03 jan 2017 08:08:05 gmt | (Lowercase RFC 1123) | +| O | 2017-06-12T05:30:45.7680000-07:00 | (Round-trippable) | ]]> @@ -300,11 +300,11 @@ Formats supported: Formats supported: -|Format string|Example expected format|Comments| -|--|--|--| -|G/g (default)| | -|F/f|12.45|Fixed point| -|E/e|1.245000e1|Exponential| +| Format string | Example expected format | Comments | +|----------------|-------------------------|-------------| +| G/g (default) | | | +| F/f | 12.45 | Fixed point | +| E/e | 1.245000e1 | Exponential | ]]> @@ -355,11 +355,11 @@ Formats supported: Formats supported: -|Format string|Example expected format|Comments| -|--|--|--| -|G/g (default)| | -|F/f|12.45|Fixed point| -|E/e|1.245000e1|Exponential| +| Format string | Example expected format | Comments | +|----------------|-------------------------|-------------| +| G/g (default) | | | +| F/f | 12.45 | Fixed point | +| E/e | 1.245000e1 | Exponential | ]]> @@ -466,12 +466,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | ]]> @@ -522,12 +522,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | ]]> @@ -578,12 +578,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | ]]> @@ -640,12 +640,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|122| -|N/n|122| -|X/x|7a| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 122 | +| N/n | 122 | +| X/x | 7a | ]]> @@ -696,11 +696,11 @@ Formats supported: Formats supported: -Format string|Example expected fornmat|Comments| -|--|--|--| -|G/g (default)| | -|F/f|12.45|Fixed point| -|E/e|1.245000e1|Exponential| +| Format string | Example expected format | Comments | +|----------------|-------------------------|-------------| +| G/g (default) | | | +| F/f | 12.45 | Fixed point | +| E/e | 1.245000e1 | Exponential | ]]> @@ -812,12 +812,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | ]]> @@ -874,12 +874,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | ]]> @@ -936,12 +936,12 @@ Formats supported: Formats supported: -|Format string|Example expected format| -|--|--| -|G/g (default)| | -|D/d|32767| -|N/n|32,767| -|X/x|7fff| +| Format string | Example expected format | +|---------------|-------------------------| +| G/g (default) | | +| D/d | 32767 | +| N/n | 32,767 | +| X/x | 7fff | ]]> diff --git a/xml/System.Security.AccessControl/RegistryAccessRule.xml b/xml/System.Security.AccessControl/RegistryAccessRule.xml index 510f75ee7b1..3ce0915d259 100644 --- a/xml/System.Security.AccessControl/RegistryAccessRule.xml +++ b/xml/System.Security.AccessControl/RegistryAccessRule.xml @@ -54,40 +54,40 @@ Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - class is one of a set of classes that the .NET Framework provides for managing Windows access control security on registry keys. For an overview of these classes, and their relationship to the underlying Windows access control structures, see . - + class is one of a set of classes that the .NET Framework provides for managing Windows access control security on registry keys. For an overview of these classes, and their relationship to the underlying Windows access control structures, see . + > [!NOTE] -> Windows access control security can only be applied to registry keys. It cannot be applied to individual key/value pairs stored in a key. - - To get a list of the rules currently applied to a registry key, use the method to get a object, and then use its method to obtain a collection of objects. - - objects do not map one-to-one with access control entries in the underlying discretionary control access list (DACL). When you get the set of all access rules for a registry key, the set contains the minimum number of rules currently required to express all the access control entries. - +> Windows access control security can only be applied to registry keys. It cannot be applied to individual key/value pairs stored in a key. + + To get a list of the rules currently applied to a registry key, use the method to get a object, and then use its method to obtain a collection of objects. + + objects do not map one-to-one with access control entries in the underlying discretionary control access list (DACL). When you get the set of all access rules for a registry key, the set contains the minimum number of rules currently required to express all the access control entries. + > [!NOTE] -> The underlying access control entries change as you apply and remove rules. The information in rules is merged if possible, to maintain the smallest number of access control entries. Thus, when you read the current list of rules, it might not look exactly like the list of all the rules you have added. - - Use objects to specify access rights to allow or deny to a user or group. A object always represents either allowed access or denied access, never both. - - To apply a rule to a registry key, use the method to get the object. Modify the object by using its methods to add the rule, and then use the method to reattach the security object. - +> The underlying access control entries change as you apply and remove rules. The information in rules is merged if possible, to maintain the smallest number of access control entries. Thus, when you read the current list of rules, it might not look exactly like the list of all the rules you have added. + + Use objects to specify access rights to allow or deny to a user or group. A object always represents either allowed access or denied access, never both. + + To apply a rule to a registry key, use the method to get the object. Modify the object by using its methods to add the rule, and then use the method to reattach the security object. + > [!IMPORTANT] -> Changes you make to a object do not affect the access levels of the registry key until you call the method to assign the altered security object to the registry key. - - objects are immutable. Security for a registry key is modified using the methods of the class to add or remove rules; as you do this, the underlying access control entries are modified. - - - -## Examples - The following code example demonstrates access rules with inheritance and propagation. The example creates a object, then creates and adds two rules that have the flag. The first rule has no propagation flags, while the second has and . - - The program displays the rules in the object, and then uses the object to create a subkey. The program creates a child subkey and a grandchild subkey, and then displays the security for each subkey. Finally, the program deletes the test keys. - +> Changes you make to a object do not affect the access levels of the registry key until you call the method to assign the altered security object to the registry key. + + objects are immutable. Security for a registry key is modified using the methods of the class to add or remove rules; as you do this, the underlying access control entries are modified. + + + +## Examples + The following code example demonstrates access rules with inheritance and propagation. The example creates a object, then creates and adds two rules that have the flag. The first rule has no propagation flags, while the second has and . + + The program displays the rules in the object, and then uses the object to create a subkey. The program creates a child subkey and a grandchild subkey, and then displays the security for each subkey. Finally, the program deletes the test keys. + :::code language="csharp" source="~/snippets/csharp/System.Security.AccessControl/RegistryAccessRule/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.AccessControl.RegistryAccessRule.ctor2/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.AccessControl.RegistryAccessRule.ctor2/VB/source.vb" id="Snippet1"::: + ]]> @@ -140,24 +140,24 @@ One of the values indicating whether the rights are allowed or denied. Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - and . - + and . + ]]> - specifies an invalid value. - - -or- - + specifies an invalid value. + + -or- + specifies an invalid value. - is . - - -or- - + is . + + -or- + is zero. is neither of type nor of a type such as that can be converted to type . @@ -202,40 +202,40 @@ One of the values indicating whether the rights are allowed or denied. Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - and . - - This constructor is equivalent to creating an object, by passing `identity` to the constructor, and passing the newly created object to the constructor. - - - -## Examples - The following code example creates registry access rules and adds them to a object, showing how rules that allow and deny rights remain separate, while compatible rules of the same kind are merged. - + and . + + This constructor is equivalent to creating an object, by passing `identity` to the constructor, and passing the newly created object to the constructor. + + + +## Examples + The following code example creates registry access rules and adds them to a object, showing how rules that allow and deny rights remain separate, while compatible rules of the same kind are merged. + :::code language="csharp" source="~/snippets/csharp/System.Security.AccessControl/RegistryAccessRule/.ctor/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.AccessControl.RegistrySecurity.AddAccessRule/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.AccessControl.RegistrySecurity.AddAccessRule/VB/source.vb" id="Snippet1"::: + ]]> - specifies an invalid value. - - -or- - + specifies an invalid value. + + -or- + specifies an invalid value. is zero. - is . - - -or- - - is a zero-length string. - - -or- - + is . + + -or- + + is a zero-length string. + + -or- + is longer than 512 characters. @@ -282,46 +282,46 @@ One of the values specifying whether the rights are allowed or denied. Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, the inheritance flags, the propagation flags, and whether the specified access rights are allowed or denied. - flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. - -|Propagation flags|S|CS|GS| -|-----------------------|-------|--------|--------| -||X|X|X| -||X|X|| -|||X|X| -|, ||X|| - - The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. - - For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. - + flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. + +| Propagation flags | S | CS | GS | +|--------------------------------------------------------------------------|---|----|----| +| | X | X | X | +| | X | X | | +| | | X | X | +| , | | X | | + + The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. + + For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. + > [!NOTE] -> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the combination of otherwise compatible rules. - +> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the combination of otherwise compatible rules. + ]]> - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + specifies an invalid value. - is . - - -or- - + is . + + -or- + is zero. is neither of type , nor of a type such as that can be converted to type . @@ -370,64 +370,64 @@ One of the values specifying whether the rights are allowed or denied. Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, the inheritance flags, the propagation flags, and whether the specified access rights are allowed or denied. - flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. - -|Propagation flags|S|CS|GS| -|-----------------------|-------|--------|--------| -||X|X|X| -||X|X|| -|||X|X| -|, ||X|| - - The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. - - For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. - + flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. + +| Propagation flags | S | CS | GS | +|--------------------------------------------------------------------------|---|----|----| +| | X | X | X | +| | X | X | | +| | | X | X | +| , | | X | | + + The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. + + For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. + > [!NOTE] -> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the combination of otherwise compatible rules. - - This constructor is equivalent to creating an object, by passing `identity` to the constructor, and passing the newly created object to the constructor. - - - -## Examples - The following code example demonstrates access rules with inheritance and propagation. The example creates a object, and then creates and adds two rules that have the flag. The first rule has no propagation flags, while the second has and . - - The program displays the rules in the object, and then uses the object to create a subkey. The program creates a child subkey and a grandchild subkey, and then displays the rules for each subkey. Finally, the program deletes the test keys. - +> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the combination of otherwise compatible rules. + + This constructor is equivalent to creating an object, by passing `identity` to the constructor, and passing the newly created object to the constructor. + + + +## Examples + The following code example demonstrates access rules with inheritance and propagation. The example creates a object, and then creates and adds two rules that have the flag. The first rule has no propagation flags, while the second has and . + + The program displays the rules in the object, and then uses the object to create a subkey. The program creates a child subkey and a grandchild subkey, and then displays the rules for each subkey. Finally, the program deletes the test keys. + :::code language="csharp" source="~/snippets/csharp/System.Security.AccessControl/RegistryAccessRule/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.AccessControl.RegistryAccessRule.ctor2/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.AccessControl.RegistryAccessRule.ctor2/VB/source.vb" id="Snippet1"::: + ]]> - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + specifies an invalid value. is zero. - is . - - -or- - - is a zero-length string. - - -or- - + is . + + -or- + + is a zero-length string. + + -or- + is longer than 512 characters. @@ -466,11 +466,11 @@ Gets the rights allowed or denied by the access rule. A bitwise combination of values indicating the rights allowed or denied by the access rule. - objects are immutable. You can create a new access rule representing a different user, different rights, or a different , but you cannot modify an existing access rule. - + objects are immutable. You can create a new access rule representing a different user, different rights, or a different , but you cannot modify an existing access rule. + ]]> diff --git a/xml/System.Security.AccessControl/RegistryAuditRule.xml b/xml/System.Security.AccessControl/RegistryAuditRule.xml index a2aa8a952f5..97f384c18eb 100644 --- a/xml/System.Security.AccessControl/RegistryAuditRule.xml +++ b/xml/System.Security.AccessControl/RegistryAuditRule.xml @@ -54,28 +54,28 @@ Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - class is one of a set of classes that the .NET Framework provides for managing Windows access control security on registry keys. For an overview of these classes and their relationship to the underlying Windows access control structures, see . - + class is one of a set of classes that the .NET Framework provides for managing Windows access control security on registry keys. For an overview of these classes and their relationship to the underlying Windows access control structures, see . + > [!NOTE] -> Windows access control security can only be applied to registry keys. It cannot be applied to individual key/value pairs stored in a key. - - To get a list of the audit rules currently applied to a registry key, use the method to get a object, and then use its method to obtain a collection of objects. - - objects do not map one-to-one with access control entries in the underlying discretionary access control list (DACL). When you get the set of all audit rules for a registry key, the set contains the minimum number of rules currently required to express all the access control entries. - +> Windows access control security can only be applied to registry keys. It cannot be applied to individual key/value pairs stored in a key. + + To get a list of the audit rules currently applied to a registry key, use the method to get a object, and then use its method to obtain a collection of objects. + + objects do not map one-to-one with access control entries in the underlying discretionary access control list (DACL). When you get the set of all audit rules for a registry key, the set contains the minimum number of rules currently required to express all the access control entries. + > [!NOTE] -> The underlying access control entries change as you apply and remove rules. The information in rules is merged if possible, to maintain the smallest number of access control entries. Thus, when you read the current list of rules, it might not look exactly like the list of all the rules you have added. - - Use objects to specify access rights to be audited for a user or group. To apply a rule to a registry key, use the method to get the object. Modify the object by using its methods to add the rule, and then use the method to reattach the security object. - +> The underlying access control entries change as you apply and remove rules. The information in rules is merged if possible, to maintain the smallest number of access control entries. Thus, when you read the current list of rules, it might not look exactly like the list of all the rules you have added. + + Use objects to specify access rights to be audited for a user or group. To apply a rule to a registry key, use the method to get the object. Modify the object by using its methods to add the rule, and then use the method to reattach the security object. + > [!IMPORTANT] -> Changes you make to a object do not affect the access levels of the registry key until you call the method to assign the altered security object to the registry key. - - objects are immutable. Security for a registry key is modified by using the methods of the class to add or remove rules; as you do this, the underlying access control entries are modified. - +> Changes you make to a object do not affect the access levels of the registry key until you call the method to assign the altered security object to the registry key. + + objects are immutable. Security for a registry key is modified by using the methods of the class to add or remove rules; as you do this, the underlying access control entries are modified. + ]]> @@ -132,46 +132,46 @@ A bitwise combination of values specifying whether to audit success, failure, or both. Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, whether to take inheritance into account, and whether to audit success, failure, or both. - flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. - -|Propagation flags|S|CS|GS| -|-----------------------|-------|--------|--------| -||X|X|X| -||X|X|| -|||X|X| -|, ||X|| - - The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. - - For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. - + flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. + +| Propagation flags | S | CS | GS | +|--------------------------------------------------------------------------|---|----|----| +| | X | X | X | +| | X | X | | +| | | X | X | +| , | | X | | + + The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. + + For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. + > [!NOTE] -> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the normal combination of compatible rules. - +> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the normal combination of compatible rules. + ]]> - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + specifies an invalid value. - is . - - -or- - + is . + + -or- + is zero. is neither of type nor of a type such as that can be converted to type . @@ -220,54 +220,54 @@ A bitwise combination of values specifying whether to audit success, failure, or both. Initializes a new instance of the class, specifying the name of the user or group to audit, the rights to audit, whether to take inheritance into account, and whether to audit success, failure, or both. - flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. - -|Propagation flags|S|CS|GS| -|-----------------------|-------|--------|--------| -||X|X|X| -||X|X|| -|||X|X| -|, ||X|| - - The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. - - For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. - + flag. If this flag is not specified, the propagation flags are ignored, and only the immediate key is affected. If the flag is present, the rule is propagated as shown in the following table. The table assumes there is a subkey S with child subkey CS and grandchild subkey GS. That is, the path for the grandchild subkey is S\CS\GS. + +| Propagation flags | S | CS | GS | +|--------------------------------------------------------------------------|---|----|----| +| | X | X | X | +| | X | X | | +| | | X | X | +| , | | X | | + + The pattern for the grandchild subkey governs all subkeys contained by the grandchild subkey. + + For example, if the flag is specified for `inheritanceFlags` and the propagation flag is specified for `propagationFlags`, this rule does not apply to the immediate subkey, but does apply to all its immediate child subkeys and to all subkeys they contain. + > [!NOTE] -> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the normal combination of compatible rules. - - This constructor is equivalent to creating an object, by passing `identity` to the constructor, and passing the newly created object to the constructor. - +> Although you can specify the flag for `inheritanceFlags`, there is no point in doing so. For the purposes of access control, the name/value pairs in a subkey are not separate objects. The access rights to name/value pairs are controlled by the rights of the subkey. Furthermore, since all subkeys are containers (that is, they can contain other subkeys), they are not affected by the flag. Finally, specifying the flag needlessly complicates the maintenance of rules, because it interferes with the normal combination of compatible rules. + + This constructor is equivalent to creating an object, by passing `identity` to the constructor, and passing the newly created object to the constructor. + ]]> - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - - specifies an invalid value. - - -or- - + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + + specifies an invalid value. + + -or- + specifies an invalid value. is zero. - is . - - -or- - - is a zero-length string. - - -or- - + is . + + -or- + + is a zero-length string. + + -or- + is longer than 512 characters. @@ -306,11 +306,11 @@ Gets the access rights affected by the audit rule. A bitwise combination of values that indicates the rights affected by the audit rule. - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of flags, but you cannot modify an existing audit rule. - + objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of flags, but you cannot modify an existing audit rule. + ]]> diff --git a/xml/System.Web.UI.Design/DataSourceDesigner.xml b/xml/System.Web.UI.Design/DataSourceDesigner.xml index c30d6ed92dc..20873add89a 100644 --- a/xml/System.Web.UI.Design/DataSourceDesigner.xml +++ b/xml/System.Web.UI.Design/DataSourceDesigner.xml @@ -21,42 +21,42 @@ Provides design-time support in a design host for the class. - class is the base class for data source designers, such as the , , and classes. If you create a new data source control, you might also want to create a custom control designer for your control and derive it from the class. - - The class has two event methods: the and methods. Both of these events can be temporarily disabled with the method, which sets the property. The event methods can be enabled again with the method. - - There are two static methods that you can use to evaluate the equivalency of schemas or views without creating an instance of the class: - -- The method compares two schemas. - -- The method compares the schemas of two views. - - - -## Examples - The following code example shows how to use a custom data source control with several other small custom classes, as listed in the following table. - -|Custom class|Derived from| -|------------------|------------------| -|`CustomDataSource`|| -|`CustomDataSourceDesigner`|| -|`CustomDataSourceView`|| -|`CustomDesignDataSourceView`|| -|`BookListViewSchema`|| -|`CustomIDFieldSchema`|| -|`CustomTitleFieldSchema`|| -|`BookItem` (A two-field data structure.)|| - - After compiling the code example, open the .aspx page in Design view and then set the `DataSourceID` property to the ID of the custom data source control. - + class is the base class for data source designers, such as the , , and classes. If you create a new data source control, you might also want to create a custom control designer for your control and derive it from the class. + + The class has two event methods: the and methods. Both of these events can be temporarily disabled with the method, which sets the property. The event methods can be enabled again with the method. + + There are two static methods that you can use to evaluate the equivalency of schemas or views without creating an instance of the class: + +- The method compares two schemas. + +- The method compares the schemas of two views. + + + +## Examples + The following code example shows how to use a custom data source control with several other small custom classes, as listed in the following table. + +| Custom class | Derived from | +|------------------------------------------|-------------------------------------------------------| +| `CustomDataSource` | | +| `CustomDataSourceDesigner` | | +| `CustomDataSourceView` | | +| `CustomDesignDataSourceView` | | +| `BookListViewSchema` | | +| `CustomIDFieldSchema` | | +| `CustomTitleFieldSchema` | | +| `BookItem` (A two-field data structure.) | | + + After compiling the code example, open the .aspx page in Design view and then set the `DataSourceID` property to the ID of the custom data source control. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataSourceDesignerSample/CS/DataSourceDesignerSample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.vb" id="Snippet1"::: :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataSourceDesignerSample/CS/DataSourceDesignerSample.aspx" id="Snippet6"::: -:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.aspx" id="Snippet6"::: - +:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.aspx" id="Snippet6"::: + ]]> @@ -89,11 +89,11 @@ Initializes a new instance of the class. - constructor is called by the design host at design time. - + constructor is called by the design host at design time. + ]]> Extending Design-Time Support @@ -120,14 +120,14 @@ Gets a list of items that are used to create an action list menu at design time. A object containing the action list items for the control designer. - control and a control, along with properties to set the `Text` properties on both internal controls, as well as the and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control, and whose settings can be rolled back with the undo functionality in the design host. Although the code example does not use a custom object, it illustrates how to override the property. - + control and a control, along with properties to set the `Text` properties on both internal controls, as well as the and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control, and whose settings can be rolled back with the undo functionality in the design host. Although the code example does not use a custom object, it illustrates how to override the property. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DesignerInvokeTransactedChange/CS/InvokeTransactedChangeSample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DesignerInvokeTransactedChange/VB/InvokeTransactedChangeSample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DesignerInvokeTransactedChange/VB/InvokeTransactedChangeSample.vb" id="Snippet1"::: + ]]> @@ -163,13 +163,13 @@ if can be called; otherwise, . The default is . - property in a custom class to enable or disable design-time configuration for a specific data source. - - A design host such as Visual Studio 2005 uses the property to determine whether a command to configure the data source appears in the action list menu at design time. - + property in a custom class to enable or disable design-time configuration for a specific data source. + + A design host such as Visual Studio 2005 uses the property to determine whether a command to configure the data source appears in the action list menu at design time. + ]]> Extending Design-Time Support @@ -200,23 +200,23 @@ if the can be called; otherwise, . The default is . - property in a derived class to enable or disable the ability to refresh the schema at design time for a specific data source. If your application requires an invariant data structure and the schema will never change, you want the property to return `false`. - - A design host such as Visual Studio 2005 uses the property to determine whether a command to refresh the schema appears in the action list menu at design time. - - In a design host such as Visual Studio 2005, you can see the property in action by completing the following process: - -1. On your page, place a or an control. - -2. In Design view, on the action list, click **Configure**. - -3. Remove a few fields from the data source. - -4. On the action list, click **Refresh Schema**. - + property in a derived class to enable or disable the ability to refresh the schema at design time for a specific data source. If your application requires an invariant data structure and the schema will never change, you want the property to return `false`. + + A design host such as Visual Studio 2005 uses the property to determine whether a command to refresh the schema appears in the action list menu at design time. + + In a design host such as Visual Studio 2005, you can see the property in action by completing the following process: + +1. On your page, place a or an control. + +2. In Design view, on the action list, click **Configure**. + +3. Remove a few fields from the data source. + +4. On the action list, click **Refresh Schema**. + ]]> Extending Design-Time Support @@ -246,17 +246,17 @@ Launches the data source configuration utility in the design host. - method is not supported in the class; however, it can be overridden by custom data source designers inheriting from the class. - - In a design host such as Visual Studio 2005, you can see the method in action by completing the following process: - -1. Put a or an control on your page. - -2. In Design view, on the action list, clicking **Configure**. - + method is not supported in the class; however, it can be overridden by custom data source designers inheriting from the class. + + In a design host such as Visual Studio 2005, you can see the method in action by completing the following process: + +1. Put a or an control on your page. + +2. In Design view, on the action list, clicking **Configure**. + ]]> An attempt was made to invoke this method in the base class. @@ -322,11 +322,11 @@ Retrieves the HTML markup for displaying the associated data source control at design time. The markup for the design-time display. - method returns the result from the base method. - + method returns the result from the base method. + ]]> @@ -361,11 +361,11 @@ Retrieves a object that is identified by the view name. This implementation always returns . - method should return `null`. - + method should return `null`. + ]]> @@ -423,11 +423,11 @@ An object provided by the calling object. Raises the event when the properties of the data source have changed and the value is . - method notifies the control designers of each control that is bound to the associated data source to refresh its control in the design host. The method can be suppressed with the method or by calling the method with an argument of `false`. - + method notifies the control designers of each control that is bound to the associated data source to refresh its control in the design host. The method can be suppressed with the method or by calling the method with an argument of `false`. + ]]> @@ -459,11 +459,11 @@ An object. Raises the event when the schema of the data source has changed and the value is . - method notifies the control designers of each control that is bound to the associated data source that the fields in the schema have changed. The method can be suppressed with the method or by calling the property with an argument of `false`. - + method notifies the control designers of each control that is bound to the associated data source that the fields in the schema have changed. The method can be suppressed with the method or by calling the property with an argument of `false`. + ]]> @@ -499,11 +499,11 @@ to allow events when refreshing the schema; to disable the and events when refreshing the schema. Refreshes the schema from the data source, while optionally suppressing events. - method is not supported in the class. However, it is supported in derived classes, such as the class. - + method is not supported in the class. However, it is supported in derived classes, such as the class. + ]]> An attempt was made to invoke this method in the base class. @@ -536,11 +536,11 @@ Restores data source events after the data source events have been suppressed. - property to `false` or by calling the method with an argument of `true`. - + property to `false` or by calling the method with an argument of `true`. + ]]> An attempt was made to invoke this method in the base class. @@ -612,11 +612,11 @@ if both schemas are equivalent; otherwise, . - method can be used without an instance of the class. - + method can be used without an instance of the class. + ]]> @@ -672,11 +672,11 @@ if events are being suppressed; otherwise, . - property can be set by calling the or method with an argument of `true`. - + property can be set by calling the or method with an argument of `true`. + ]]> Extending Design-Time Support @@ -710,11 +710,11 @@ if both views are equivalent; otherwise, . - method can be used without an instance of the class. - + method can be used without an instance of the class. + ]]> diff --git a/xml/System.Windows.Controls/ComboBox.xml b/xml/System.Windows.Controls/ComboBox.xml index 08cd6af4298..981bf94b500 100644 --- a/xml/System.Windows.Controls/ComboBox.xml +++ b/xml/System.Windows.Controls/ComboBox.xml @@ -48,20 +48,17 @@ The and properties specify how the behaves when the user does one of the following: -- Enters a string to select an item in the . +- Enters a string to select an item in the . +- Enters a string that does not correspond to an item in the . +- Selects part of the string that is in the text box. +- Copies or pastes a value into the text box. -- Enters a string that does not correspond to an item in the . + The following table describes the actions the user can and can't take, depending on the values of and . -- Selects part of the string that is in the text box. - -- Copies or pastes a value into the text box. - - The following table describes the actions the user can and cannot take, depending on the values of and . - -|| is `true`| is `false`| -|-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| is `true`|- Cannot select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy the string in the text box, but cannot paste a string into the text box.|- Can select an item in the by entering a string.
- Can enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy or paste the string in the text box.| -| is `false`|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .| +| value | is `true`| is `false`| +| - | - | - | +| `true` |- Cannot select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy the string in the text box, but cannot paste a string into the text box.|- Can select an item in the by entering a string.
- Can enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy or paste the string in the text box.| +| `false` |- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .| The property has an effect only if is `true`. @@ -331,8 +328,6 @@ |Identifier field|| |Metadata properties set to `true`|| - - ## Examples The following example shows how to use the property to create a combo box with the drop down control opened when the combo box is initiated. @@ -399,20 +394,17 @@ ## Remarks The and properties specify how the behaves when the user does one of the following: -- Enters a string to select an item in the . - -- Enters a string that does not correspond to an item in the . - -- Selects part of the string that is in the text box. - -- Copies or pastes a value into the text box. +- Enters a string to select an item in the . +- Enters a string that does not correspond to an item in the . +- Selects part of the string that is in the text box. +- Copies or pastes a value into the text box. The following table describes the actions the user can and cannot take, depending on the values of and . -|| is `true`| is `false`| -|-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| is `true`|- Cannot select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy the string in the text box, but cannot paste a string into the text box.|- Can select an item in the by entering a string.
- Can enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy or paste the string in the text box.| -| is `false`|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .| +| value | is `true`| is `false`| +| - | - | - | +| `true` |- Cannot select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy the string in the text box, but cannot paste a string into the text box.|- Can select an item in the by entering a string.
- Can enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy or paste the string in the text box.| +| `false` |- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .| When is equal to `false`, the uses a to display the currently selected item; when is equal to `true`, a is used for this purpose instead. Note that a only displays plain text, and that a may include non-plain text content, such as images. @@ -424,8 +416,6 @@ |Identifier field|| |Metadata properties set to `true`|None| - - ## Examples The following examples create controls that contain images as items instead of text. If the property is set to `true`, the displays the value returned by the image's method. To avoid a with unexpected text, use the and properties to assign text to be displayed. @@ -532,20 +522,17 @@ ## Remarks The and properties specify how the behaves when the user does one of the following: -- Enters a string to select an item in the . - -- Enters a string that does not correspond to an item in the . - -- Selects part of the string that is in the text box. - -- Copies or pastes a value into the text box. +- Enters a string to select an item in the . +- Enters a string that does not correspond to an item in the . +- Selects part of the string that is in the text box. +- Copies or pastes a value into the text box. The following table describes the actions the user can and cannot take, depending on the values of and . -|| is `true`| is `false`| -|-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| is `true`|- Cannot select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy the string in the text box, but cannot paste a string into the text box.|- Can select an item in the by entering a string.
- Can enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy or paste the string in the text box.| -| is `false`|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .| +| value | is `true`| is `false`| +| - | - | - | +| `true` |- Cannot select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy the string in the text box, but cannot paste a string into the text box.|- Can select an item in the by entering a string.
- Can enter a string that does not correspond to an item in the .
- Can select part of the string in the text box.
- Can copy or paste the string in the text box.| +| `false` |- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .|- Can select an item in the by entering a string.
- Cannot enter a string that does not correspond to an item in the .
- Cannot select part of the string in the .
- Cannot copy or paste the string in the .| When is equal to `false`, the uses a to display the currently selected item; when is equal to `true`, a is used for this purpose instead. Note that a only displays plain text, and that a may include non-plain text content, such as images. @@ -557,8 +544,6 @@ |Identifier field|| |Metadata properties set to `true`|| - - ## Examples The following example shows a with an editable . The property is set to `true`, so the user cannot enter text into the . @@ -715,8 +700,6 @@ `Auto` Enables autosizing behavior. See Remarks. - - ## Examples The following example shows how to use the property to specify the height of the control's drop-down. @@ -1415,8 +1398,6 @@ |Identifier field|| |Metadata properties set to `true`|None| - - ## Examples This example shows how to use the property to create a combo box whose drop-down control stays open while the user enters information into the text box. @@ -1490,8 +1471,6 @@ |Identifier field|| |Metadata properties set to `true`|, | - - ## Examples This example shows how the property can be used to set text into the before the user makes a selection. diff --git a/xml/System.Windows.Forms.Design.Behavior/Behavior.xml b/xml/System.Windows.Forms.Design.Behavior/Behavior.xml index 1680f940ff5..90aaa8ff465 100644 --- a/xml/System.Windows.Forms.Design.Behavior/Behavior.xml +++ b/xml/System.Windows.Forms.Design.Behavior/Behavior.xml @@ -40,25 +40,25 @@ Represents the objects that are managed by a . - [!NOTE] -> Your type must be associated with a type. Glyph-independent behaviors are not supported. - - - -## Examples - The following code example demonstrates how to create your own class based on the class that responds to user clicks. This code example is part of a larger example provided for the class. - +> Your type must be associated with a type. Glyph-independent behaviors are not supported. + + + +## Examples + The following code example demonstrates how to create your own class based on the class that responds to user clicks. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.BehaviorService/cpp/Form1.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms.Design.Behavior/Adorner/Overview/Form1.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.BehaviorService/VB/Form1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.BehaviorService/VB/Form1.vb" id="Snippet5"::: + ]]> @@ -108,15 +108,15 @@ Initializes a new instance of the class. - class. This code example is part of a larger example provided for the class. - + class. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.BehaviorService/cpp/Form1.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms.Design.Behavior/Adorner/Overview/Form1.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.BehaviorService/VB/Form1.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.BehaviorService/VB/Form1.vb" id="Snippet7"::: + ]]> @@ -159,13 +159,13 @@ The to use. Initializes a new instance of the class with the given . - . If the `callParentBehavior` parameter is `true`, then the `behaviorService` parameter must not be `null`. - - `callParentBehavior` indicates whether the base class should call the parent behavior, and then allow the select the correct parent behavior. - + . If the `callParentBehavior` parameter is `true`, then the `behaviorService` parameter must not be `null`. + + `callParentBehavior` indicates whether the base class should call the parent behavior, and then allow the select the correct parent behavior. + ]]> @@ -239,18 +239,18 @@ if all objects the designer receives should have states set to Enabled = false when this is active; otherwise, . - property indicates to the that all objects the designer receives should have their state disabled when this behavior is active. - - The property works in conjunction with the method so you can customize the interaction between glyphs and behaviors. The following table summarizes the results of a call to for a particular . - -|| is `true`| is `false`| -|-|-|-| -|Hit-tested glyph has an assigned behavior|If the with the specified `command ID` is found in the , that is disabled and returned. Otherwise, `null` is returned.| is called on the behavior and, if found, the behavior's is returned. Otherwise, the result of with the specified `command ID` is returned.| -|Hit-tested glyph has no assigned behavior|The result of with the specified `command ID` is returned.|The result of with the specified `command ID` is returned.| - + property indicates to the that all objects the designer receives should have their state disabled when this behavior is active. + + The property works in conjunction with the method so you can customize the interaction between glyphs and behaviors. The following table summarizes the results of a call to for a particular . + +| Hit-tested glyph has an assigned behavior | is `true`| is `false`| +| - | - | - | +| Yes | If the with the specified `command ID` is found in the , that is disabled and returned. Otherwise, `null` is returned. | is called on the behavior and, if found, the behavior's is returned. Otherwise, the result of with the specified `command ID` is returned. | +| No | The result of with the specified `command ID` is returned. | The result of with the specified `command ID` is returned. | + ]]> @@ -298,11 +298,11 @@ Intercepts commands. A . By default, returns . - method is called from the . It provides an opportunity for the to return its own custom , thereby intercepting this message. - + method is called from the . It provides an opportunity for the to return its own custom , thereby intercepting this message. + ]]> @@ -608,19 +608,19 @@ An that contains the event data. Called by the adorner window when it loses mouse capture. - method. If it does so, it will be notified through the method when capture is lost. Generally the behavior removes itself from the stack at this time. Capture is lost when one of the following actions occurs: - -- Someone else requests capture. - -- Another behavior is pushed. - -- This behavior is removed. - - In each of these cases, will be called on the behavior. - + method. If it does so, it will be notified through the method when capture is lost. Generally the behavior removes itself from the stack at this time. Capture is lost when one of the following actions occurs: + +- Someone else requests capture. + +- Another behavior is pushed. + +- This behavior is removed. + + In each of these cases, will be called on the behavior. + ]]> @@ -668,19 +668,19 @@ if the message was handled; otherwise, . - method is called when any double-click message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. - - - -## Examples - The following code example demonstrates how to handle a double-click message. For a full code listing, see [How to: Extend the Appearance and Behavior of Controls in Design Mode](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ms171820(v=vs.120)). - + method is called when any double-click message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. + + + +## Examples + The following code example demonstrates how to handle a double-click message. For a full code listing, see [How to: Extend the Appearance and Behavior of Controls in Design Mode](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ms171820(v=vs.120)). + :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms.Design.Behavior/Adorner/Enabled/DesignerDemoControl.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.Glyph.MarginBorderAnchorGlyphs/VB/DesignerDemoControl.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Design.Behavior.Glyph.MarginBorderAnchorGlyphs/VB/DesignerDemoControl.vb" id="Snippet10"::: + ]]> @@ -728,11 +728,11 @@ if the message was handled; otherwise, . - method is called when any mouse-down message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. - + method is called when any mouse-down message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. + ]]> @@ -776,13 +776,13 @@ if the message was handled; otherwise, . - method is called when any mouse-enter message enters the `WndProc` of the adorner window of the . From here, the message is sent to the appropriate behavior. - - When the mouse pointer's location is positively hit-tested with a different than previous hit tests, this method is called on the associated with the . - + method is called when any mouse-enter message enters the `WndProc` of the adorner window of the . From here, the message is sent to the appropriate behavior. + + When the mouse pointer's location is positively hit-tested with a different than previous hit tests, this method is called on the associated with the . + ]]> @@ -828,11 +828,11 @@ if the message was handled; otherwise, . - method is called when any mouse-hover message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. - + method is called when any mouse-hover message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. + ]]> @@ -876,13 +876,13 @@ if the message was handled; otherwise, . - method is called when any mouse-leave message enters the `WndProc` of the adorner window of the . From here, the message is sent to the appropriate behavior. - - When the mouse pointer leaves a positively hit-tested with a valid , this method is invoked. - + method is called when any mouse-leave message enters the `WndProc` of the adorner window of the . From here, the message is sent to the appropriate behavior. + + When the mouse pointer leaves a positively hit-tested with a valid , this method is invoked. + ]]> @@ -930,11 +930,11 @@ if the message was handled; otherwise, . - method is called when any mouse-move message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. - + method is called when any mouse-move message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. + ]]> @@ -980,11 +980,11 @@ if the message was handled; otherwise, . - method is called when any mouse-up message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. - + method is called when any mouse-up message enters the `WndProc` of the adorner window of the . The message is first passed here, to the top-most in the behavior stack. Returning `true` from this method signifies that the message was handled by the and should not continue to be processed. From here, the message is sent to the appropriate behavior. + ]]> diff --git a/xml/System.Windows.Media/BitmapCacheBrush.xml b/xml/System.Windows.Media/BitmapCacheBrush.xml index 9ec57f774ab..2088576009f 100644 --- a/xml/System.Windows.Media/BitmapCacheBrush.xml +++ b/xml/System.Windows.Media/BitmapCacheBrush.xml @@ -22,51 +22,51 @@ Paints an area with cached content. - class to reuse a cached element efficiently. This is useful when you need to paint complex content onto multiple elements. Use the class to cache a complex element. - - Assign a to the property and optionally assign a to the property. The of the brush and the target interact to produce different behaviors. The following table describes this interaction. - -||Target has no CacheMode|Target has CacheMode| -|-|-----------------------------|--------------------------| -|Brush has no CacheMode|Target visual renders normally; brush uses default cache behavior.|Target visual renders into its own cache; brush uses target's cache when rendering.| -|Brush has CacheMode|Target visual renders normally; brush renders target into its own cache and uses this to render.|Target visual renders into its own cache; brush renders target into brush's own cache and uses this to render.| - - The class is similar to the class, but always renders from a cache on the target element, or from a cache defined by the property. The class also supports dirty regions. - - The following table shows the default bitmap cache settings for the class. - -|Bitmap Cache Property|Default Setting| -|---------------------------|---------------------| -||`false`| -||`false`| -||1| - - The property is ignored by the class. - - The class ignores the following properties on the root . This behavior differs from the class. - -- - -- - -- - -- - -- - -- - - - -## Examples - The following code example shows how to associate a with a . You can use the resource on multiple elements and achieve good performance. For the complete code listing, see [How to: Use a Cached Element as a Brush](/dotnet/framework/wpf/graphics-multimedia/how-to-use-a-cached-element-as-a-brush). - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Media/BitmapCacheBrush/Overview/window1.xaml" id="Snippet_bitmapcachebrushcreation"::: - + class to reuse a cached element efficiently. This is useful when you need to paint complex content onto multiple elements. Use the class to cache a complex element. + + Assign a to the property and optionally assign a to the property. The of the brush and the target interact to produce different behaviors. The following table describes this interaction. + +| Brush has CacheMode | Target has no CacheMode | Target has CacheMode | +|---------------------|-------------------------|----------------------| +| No | Target visual renders normally; brush uses default cache behavior. | Target visual renders into its own cache; brush uses target's cache when rendering. | +| Yes | Target visual renders normally; brush renders target into its own cache and uses this to render. | Target visual renders into its own cache; brush renders target into brush's own cache and uses this to render. | + + The class is similar to the class, but always renders from a cache on the target element, or from a cache defined by the property. The class also supports dirty regions. + + The following table shows the default bitmap cache settings for the class. + +| Bitmap Cache Property | Default Setting | +|----------------------------------------------------------------|-----------------| +| | `false` | +| | `false` | +| | 1 | + + The property is ignored by the class. + + The class ignores the following properties on the root . This behavior differs from the class. + +- + +- + +- + +- + +- + +- + + + +## Examples + The following code example shows how to associate a with a . You can use the resource on multiple elements and achieve good performance. For the complete code listing, see [How to: Use a Cached Element as a Brush](/dotnet/framework/wpf/graphics-multimedia/how-to-use-a-cached-element-as-a-brush). + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Media/BitmapCacheBrush/Overview/window1.xaml" id="Snippet_bitmapcachebrushcreation"::: + ]]> @@ -155,11 +155,11 @@ if layout is applied; otherwise, . The default is . - property is `true`, layout is applied to the contents of the brush if is a with no parent. - + property is `true`, layout is applied to the contents of the brush if is a with no parent. + ]]> @@ -213,11 +213,11 @@ Gets or sets a that represents cached content. A that represents cached content. - property interacts with the property. For a table that shows this interaction, see the class overview. - + property interacts with the property. For a table that shows this interaction, see the class overview. + ]]> @@ -383,11 +383,11 @@ Gets or sets the target visual to cache. A to cache and paint with. - property interacts with the property. For a table that shows this interaction, see the class overview. - + property interacts with the property. For a table that shows this interaction, see the class overview. + ]]> diff --git a/xml/System.Xml/XmlDocument.xml b/xml/System.Xml/XmlDocument.xml index 0ff2f28cde9..ebd57798597 100644 --- a/xml/System.Xml/XmlDocument.xml +++ b/xml/System.Xml/XmlDocument.xml @@ -1498,49 +1498,47 @@ elem=doc.CreateElement("xy", "item", "urn:abc"); ## Remarks The `nodeTypeString` parameter is case sensitive and must be one of the values in the following table. -|nodeTypeString|XmlNodeType| -|--------------------|-----------------| -|attribute|Attribute| -|cdatasection|CDATA| -|comment|Comment| -|document|Document| -|documentfragment|DocumentFragment| -|documenttype|DocumentType| -|element|Element| -|entityreference|EntityReference| -|processinginstruction|ProcessingInstruction| -|significantwhitespace|SignificantWhitespace| -|text|Text| -|whitespace|Whitespace| +| nodeTypeString | XmlNodeType | +|-----------------------|-----------------------| +| attribute | Attribute | +| cdatasection | CDATA | +| comment | Comment | +| document | Document | +| documentfragment | DocumentFragment | +| documenttype | DocumentType | +| element | Element | +| entityreference | EntityReference | +| processinginstruction | ProcessingInstruction | +| significantwhitespace | SignificantWhitespace | +| text | Text | +| whitespace | Whitespace | Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. To add the new object, you must explicitly call one of the node insert methods. The following table shows you what NodeType[row] is allowed inside another NodeType[column] according to the W3C [Extensible Markup Language (XML) 1.0 recommendation](https://www.w3.org/TR/1998/REC-xml-19980210). -||Document|DocumentType|XmlDeclaration|Element|Attribute|Text|CDATA|Markup|EntityReference| -|------|--------------|------------------|--------------------|-------------|---------------|----------|-----------|------------|---------------------| -|`Document`|no|no|no|no|no|no|no|no|no| -|`DocumentType`|yes|no|no|no|no|no|no|no|no| -|`XmlDeclaration`|yes*|no|no|no|no|no|no|no|no| -|`Element`|yes|no|no|yes|no|no|no|no|yes***| -|`Attribute`|no|no|no|yes****|no|no|no|no|no| -|`Text`|no|no|no|yes|yes|no|no|no|yes| -|`CDATA`|no|no|no|yes|no|no|no|no|yes***| -|`Markup**`|yes|no|no|yes|no|no|no|no|no| -|`EntityReference`|no|no|no|yes|yes|no|no|no|yes| +| Node type | Document | DocumentType | XmlDeclaration | Element | Attribute | Text | CDATA | Markup | EntityReference | +|-------------------|----------|--------------|----------------|---------|-----------|------|-------|--------|-----------------| +| `Document` | no | no | no | no | no | no | no | no | no | +| `DocumentType` | yes | no | no | no | no | no | no | no | no | +| `XmlDeclaration` | yes\* | no | no | no | no | no | no | no | no | +| `Element` | yes | no | no | yes | no | no | no | no | yes† | +| `Attribute` | no | no | no | yes‡ | no | no | no | no | no | +| `Text` | no | no | no | yes | yes | no | no | no | yes | +| `CDATA` | no | no | no | yes | no | no | no | no | yes† | +| `Markup`§ | yes | no | no | yes | no | no | no | no | no | +| `EntityReference` | no | no | no | yes | yes | no | no | no | yes | - \* The XmlDeclaration node must be the first child of the Document node. + \* The `XmlDeclaration` node must be the first child of the Document node. - ** Markup includes ProcessingInstruction and Comment nodes. + § `Markup` includes `ProcessingInstruction` and `Comment` nodes. - *** Element and CDATA nodes are only allowed in EntityReference nodes when the EntityReference node is not a child of an Attribute node. + † `Element` and `CDATA` nodes are only allowed in `EntityReference` nodes when the `EntityReference` node is not a child of an `Attribute` node. - **** Attributes are not children of an Element node. Attributes are contained inside an attribute collection that belongs to an Element node. + ‡ Attributes are not children of an `Element` node. Attributes are contained inside an attribute collection that belongs to an `Element` node. This method is a Microsoft extension to the Document Object Model (DOM). - - ## Examples The following example creates a new element and inserts it into the document. @@ -1625,30 +1623,28 @@ elem=doc.CreateElement("xy", "item", "urn:abc"); The following table shows you what NodeType[row] is allowed inside another NodeType[column] according to the W3C [Extensible Markup Language (XML) 1.0 recommendation](https://www.w3.org/TR/1998/REC-xml-19980210). -||Document|DocumentType|XmlDeclaration|Element|Attribute|Text|CDATA|Markup|EntityReference| -|------|--------------|------------------|--------------------|-------------|---------------|----------|-----------|------------|---------------------| -|`Document`|no|no|no|no|no|no|no|no|no| -|`DocumentType`|yes|no|no|no|no|no|no|no|no| -|`XmlDeclaration`|yes*|no|no|no|no|no|no|no|no| -|`Element`|yes|no|no|yes|no|no|no|no|yes***| -|`Attribute`|no|no|no|yes****|no|no|no|no|no| -|`Text`|no|no|no|yes|yes|no|no|no|yes| -|`CDATA`|no|no|no|yes|no|no|no|no|yes***| -|`Markup**`|yes|no|no|yes|no|no|no|no|no| -|`EntityReference`|no|no|no|yes|yes|no|no|no|yes| +| Node type | Document | DocumentType | XmlDeclaration | Element | Attribute | Text | CDATA | Markup | EntityReference | +|-------------------|----------|--------------|----------------|---------|-----------|------|-------|--------|-----------------| +| `Document` | no | no | no | no | no | no | no | no | no | +| `DocumentType` | yes | no | no | no | no | no | no | no | no | +| `XmlDeclaration` | yes\* | no | no | no | no | no | no | no | no | +| `Element` | yes | no | no | yes | no | no | no | no | yes† | +| `Attribute` | no | no | no | yes‡ | no | no | no | no | no | +| `Text` | no | no | no | yes | yes | no | no | no | yes | +| `CDATA` | no | no | no | yes | no | no | no | no | yes† | +| `Markup`§ | yes | no | no | yes | no | no | no | no | no | +| `EntityReference` | no | no | no | yes | yes | no | no | no | yes | - \* The XmlDeclaration node must be the first child of the Document node. + \* The `XmlDeclaration` node must be the first child of the Document node. - ** Markup includes ProcessingInstruction and Comment nodes. + § `Markup` includes `ProcessingInstruction` and `Comment` nodes. - *** Element and CDATA nodes are only allowed in EntityReference nodes when the EntityReference node is not a child of an Attribute node. + † `Element` and `CDATA` nodes are only allowed in `EntityReference` nodes when the `EntityReference` node is not a child of an `Attribute` node. - **** Attributes are not children of an Element node. Attributes are contained inside an attribute collection that belongs to an Element node. + ‡ Attributes are not children of an `Element` node. Attributes are contained inside an attribute collection that belongs to an `Element` node. This method is a Microsoft extension to the Document Object Model (DOM). - - ## Examples The following example creates a new element and inserts it into an XML document. @@ -1736,30 +1732,28 @@ elem=doc.CreateElement("xy", "item", "urn:abc"); The following table shows you what NodeType[row] is allowed inside another NodeType[column] according to the W3C [Extensible Markup Language (XML) 1.0 recommendation](https://www.w3.org/TR/1998/REC-xml-19980210). -||Document|DocumentType|XmlDeclaration|Element|Attribute|Text|CDATA|Markup|EntityReference| -|------|--------------|------------------|--------------------|-------------|---------------|----------|-----------|------------|---------------------| -|`Document`|no|no|no|no|no|no|no|no|no| -|`DocumentType`|yes|no|no|no|no|no|no|no|no| -|`XmlDeclaration`|yes*|no|no|no|no|no|no|no|no| -|`Element`|yes|no|no|yes|no|no|no|no|yes***| -|`Attribute`|no|no|no|yes****|no|no|no|no|no| -|`Text`|no|no|no|yes|yes|no|no|no|yes| -|`CDATA`|no|no|no|yes|no|no|no|no|yes***| -|`Markup**`|yes|no|no|yes|no|no|no|no|no| -|`EntityReference`|no|no|no|yes|yes|no|no|no|yes| +| | Document | DocumentType | XmlDeclaration | Element | Attribute | Text | CDATA | Markup | EntityReference | +|-------------------|----------|--------------|----------------|---------|-----------|------|-------|--------|-----------------| +| `Document` | no | no | no | no | no | no | no | no | no | +| `DocumentType` | yes | no | no | no | no | no | no | no | no | +| `XmlDeclaration` | yes\* | no | no | no | no | no | no | no | no | +| `Element` | yes | no | no | yes | no | no | no | no | yes† | +| `Attribute` | no | no | no | yes‡ | no | no | no | no | no | +| `Text` | no | no | no | yes | yes | no | no | no | yes | +| `CDATA` | no | no | no | yes | no | no | no | no | yes† | +| `Markup`§ | yes | no | no | yes | no | no | no | no | no | +| `EntityReference` | no | no | no | yes | yes | no | no | no | yes | \* The XmlDeclaration node must be the first child of the Document node. - ** Markup includes ProcessingInstruction and Comment nodes. + § `Markup` includes `ProcessingInstruction` and `Comment` nodes. - *** Element and CDATA nodes are only allowed in EntityReference nodes when the EntityReference node is not a child of an Attribute node. + † `Element` and `CDATA` nodes are only allowed in `EntityReference` nodes when the `EntityReference` node is not a child of an `Attribute` node. - **** Attributes are not children of an Element node. Attributes are contained inside an attribute collection that belongs to the Element node. + ‡ Attributes are not children of an `Element` node. Attributes are contained inside an attribute collection that belongs to an `Element` node. This method is a Microsoft extension to the Document Object Model (DOM). - - ## Examples The following example adds a new element to the document. diff --git a/xml/System.Xml/XmlWriterSettings.xml b/xml/System.Xml/XmlWriterSettings.xml index 9671a0bf21b..dfb9df9ab53 100644 --- a/xml/System.Xml/XmlWriterSettings.xml +++ b/xml/System.Xml/XmlWriterSettings.xml @@ -913,34 +913,34 @@ using (StreamWriter output = The following tables show the output of the method when supplied with the input value depending on the property setting. The tables show the output when writing text content and also when writing an attribute value. - `Text Node Value:` +Text Node Value: -||\r\n|\n|\r|\t| -|-|------------|---------|---------|---------| -|Entitize|&#D;\n|\n|&#D;|\t| -|Replace|\r\n|\r\n|\r\n|\t| -|None|\r\n|\n|\r|\t| +| `NewLineHandling` | \r\n | \n | \r | \t | +|-------------------|--------|------|------|----| +| `Entitize` | &#D;\n | \n | &#D; | \t | +| `Replace` | \r\n | \r\n | \r\n | \t | +| `None` | \r\n | \n | \r | \t | - `Attribute Value:` +Attribute Value: -||\r\n|\n|\r|\t| -|-|------------|---------|---------|---------| -|Entitize|&#D;&#A;|&#A;|&#D;|&\#9;| -|Replace|&#D;&#A;|&#A;|&#D;|&\#9;| -|None|\r\n|\n|\r|\t| +| `NewLineHandling` | \r\n | \n | \r | \t | +|-------------------|----------|------|------|-------| +| `Entitize` | &#D;&#A; | &#A; | &#D; | &\#9; | +| `Replace` | &#D;&#A; | &#A; | &#D; | &\#9; | +| `None` | \r\n | \n | \r | \t | > [!NOTE] > The has the following behavior when writing content within a CDATA section, comment, or processing instruction. New lines are never replaced with their character entities, even when the property is set to . This is because character entities are not recognized in CDATA sections, comments or processing instructions. If the property is set to or , the behavior is the same as when writing a text node value. The following table describes what a normalizing returns for each white space input. For more information, see sections 2.11 and 3.3.3 of the W3C [XML 1.0 Recommendation](https://www.w3.org/TR/REC-xml/). -> [!NOTE] -> A normalizing reader is any object created by the method. These objects always perform line break normalization and full normalization of attributes. The object can also be a normalizing reader if it's property is set to `true`. +| Value type | \r\n | \n | \r | \t | +|------------|--------------|--------------|--------------|--------------| +| Text Node | \n | \n | \n | \t | +| Attribute | single space | single space | single space | single space | -||\r\n|\n|\r|\t| -|-|------------|---------|---------|---------| -|Text Node Value|\n|\n|\n|\t| -|Attribute Value|single space|single space|single space|single space| +> [!NOTE] +> A normalizing reader is any object created by the method. These objects always perform line break normalization and full normalization of attributes. The object can also be a normalizing reader if its property is set to `true`. ]]> diff --git a/xml/System/TimeZoneInfo+TransitionTime.xml b/xml/System/TimeZoneInfo+TransitionTime.xml index e441010c514..cf435171ef2 100644 --- a/xml/System/TimeZoneInfo+TransitionTime.xml +++ b/xml/System/TimeZoneInfo+TransitionTime.xml @@ -72,27 +72,27 @@ Provides information about a specific time change, such as the change from daylight saving time to standard time or vice versa, in a particular time zone. - structure to indicate when a transition from standard time to daylight saving time, or from daylight saving time back to standard time, occurs. This structure supports both fixed-date rules and floating-date rules. Use fixed-date rules for time transitions that occur on a specific day of a specific month (such as 2:00 A.M. on November 3). Use floating-date rules for time transitions that occur on a specific day of a specific week of a specific month (such as 2:00 A.M. on the first Sunday of November). - - The following table compares the properties used in fixed-date and floating-date transitions: - -||Month|Week|Day|Time| -|-|-----------|----------|---------|----------| -|Fixed-date rule||N/A||| -|Floating-date rule||||| - - For both fixed-date and floating-date transitions, the property gets the time at which the time change occurs. For transitions from standard to daylight saving time, this is the time zone's standard time value. For transitions from daylight saving to standard time, this is the time zone's daylight saving time value. This is a value whose date component is ignored; its year, month, and day value must always equal 1. - + structure to indicate when a transition from standard time to daylight saving time, or from daylight saving time back to standard time, occurs. This structure supports both fixed-date rules and floating-date rules. Use fixed-date rules for time transitions that occur on a specific day of a specific month (such as 2:00 A.M. on November 3). Use floating-date rules for time transitions that occur on a specific day of a specific week of a specific month (such as 2:00 A.M. on the first Sunday of November). + + The following table compares the properties used in fixed-date and floating-date transitions: + +| Rule type | Month | Week | Day | Time | +|-----------|-------|------|-----|------| +| Fixed-date rule | | N/A | | | +| Floating-date rule | | | | | + + For both fixed-date and floating-date transitions, the property gets the time at which the time change occurs. For transitions from standard to daylight saving time, this is the time zone's standard time value. For transitions from daylight saving to standard time, this is the time zone's daylight saving time value. This is a value whose date component is ignored; its year, month, and day value must always equal 1. + > [!NOTE] -> An instance of the structure is immutable. Once an object has been created, its values cannot be modified. - - A object can be created by calling the `static` (`Shared` in Visual Basic) and methods to create a fixed or floating-date rule, respectively. The starting and ending objects are then supplied as parameters to the method to create a new adjustment rule that includes this transition time information. - - The and properties of an object return a object. - +> An instance of the structure is immutable. Once an object has been created, its values cannot be modified. + + A object can be created by calling the `static` (`Shared` in Visual Basic) and methods to create a fixed or floating-date rule, respectively. The starting and ending objects are then supplied as parameters to the method to create a new adjustment rule that includes this transition time information. + + The and properties of an object return a object. + ]]> @@ -145,37 +145,37 @@ Defines a time change that uses a fixed-date rule (that is, a time change that occurs on a specific day of a specific month). Data about the time change. - value whose year, month, and date values must all equal 1. - - - -## Examples - The following example creates time zone transitions for an imaginary time zone by using both a fixed-date rule and a floating-date rule. The fixed-date rule defines a time zone adjustment that starts at 2:00 A.M. on March 15 and ends at 3:00 A.M. on November 15 for the years 1900 to 1955. - + value whose year, month, and date values must all equal 1. + + + +## Examples + The following example creates time zone transitions for an imaginary time zone by using both a fixed-date rule and a floating-date rule. The fixed-date rule defines a time zone adjustment that starts at 2:00 A.M. on March 15 and ends at 3:00 A.M. on November 15 for the years 1900 to 1955. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet2"::: + ]]> - The parameter has a non-default date component. - - -or- - - The parameter's property is not . - - -or- - + The parameter has a non-default date component. + + -or- + + The parameter's property is not . + + -or- + The parameter does not represent a whole number of milliseconds. - The parameter is less than 1 or greater than 12. - - -or- - + The parameter is less than 1 or greater than 12. + + -or- + The parameter is less than 1 or greater than 31. @@ -229,42 +229,42 @@ Defines a time change that uses a floating-date rule (that is, a time change that occurs on a specific day of a specific week of a specific month). Data about the time change. - value whose year, month, and date values must all equal 1. - - - -## Examples - The following example creates time zone transitions for an imaginary time zone by using both a fixed-date rule and a floating-date rule. The floating-date rule defines a time zone adjustment that starts at 2:00 A.M. on the last Sunday of March and ends at 3:00 A.M. on the fourth Sunday in October for the years 1956 onward. - + value whose year, month, and date values must all equal 1. + + + +## Examples + The following example creates time zone transitions for an imaginary time zone by using both a fixed-date rule and a floating-date rule. The floating-date rule defines a time zone adjustment that starts at 2:00 A.M. on the last Sunday of March and ends at 3:00 A.M. on the fourth Sunday in October for the years 1956 onward. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet2"::: + ]]> - The parameter has a non-default date component. - - -or- - - The parameter does not represent a whole number of milliseconds. - - -or- - + The parameter has a non-default date component. + + -or- + + The parameter does not represent a whole number of milliseconds. + + -or- + The parameter's property is not . - is less than 1 or greater than 12. - - -or- - - is less than 1 or greater than 5. - - -or- - + is less than 1 or greater than 12. + + -or- + + is less than 1 or greater than 5. + + -or- + The parameter is not a member of the enumeration. @@ -308,24 +308,24 @@ Gets the day on which the time change occurs. The day on which the time change occurs. - property returns a valid value only if the property is `true`. - - The property value corresponds to the value of the `day` parameter of the method. If its value is greater than the number of days in the month of the transition, the transition occurs on the last day of the month. - - The property indicates the day of the month on which a fixed-date rule is applied (for example, April 15). In contrast, the property indicates the day of the week on which a floating-date rule is applied (for example, the second Sunday of November). - - - -## Examples - The following example enumerates the time zones found on the local computer and displays transition time information for all fixed-date transitions. The time information includes the day on which the time change occurs. - + property returns a valid value only if the property is `true`. + + The property value corresponds to the value of the `day` parameter of the method. If its value is greater than the number of days in the month of the transition, the transition occurs on the last day of the month. + + The property indicates the day of the month on which a fixed-date rule is applied (for example, April 15). In contrast, the property indicates the day of the week on which a floating-date rule is applied (for example, the second Sunday of November). + + + +## Examples + The following example enumerates the time zones found on the local computer and displays transition time information for all fixed-date transitions. The time information includes the day on which the time change occurs. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet3"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet3"::: + ]]> @@ -370,22 +370,22 @@ Gets the day of the week on which the time change occurs. The day of the week on which the time change occurs. - property returns a valid value only if the property is `false`. - - The property indicates the day of the week on which a floating-date rule is applied (for example, the second Sunday of November). In contrast, the property indicates the day of the month on which a fixed-date rule is applied (for example, April 15). - - - -## Examples - The following example enumerates the time zones found on the local computer and displays transition time information for all floating-date transitions. The time information includes the day of the week on which the time change occurs. - + property returns a valid value only if the property is `false`. + + The property indicates the day of the week on which a floating-date rule is applied (for example, the second Sunday of November). In contrast, the property indicates the day of the month on which a fixed-date rule is applied (for example, April 15). + + + +## Examples + The following example enumerates the time zones found on the local computer and displays transition time information for all floating-date transitions. The time information includes the day of the week on which the time change occurs. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet4"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet4"::: + ]]> @@ -453,20 +453,20 @@ if the two objects are equal; otherwise, . - object and must have property values identical to the current object. - - - -## Examples - The following example illustrates calls to the method. - + object and must have property values identical to the current object. + + + +## Examples + The following example illustrates calls to the method. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet1"::: + ]]> @@ -519,20 +519,20 @@ if the two objects have identical property values; otherwise, . - objects are equal, this method performs a property-by-property comparison. The method returns `true` only if the current object and the `other` object have identical values for each of the object's six property values. - - - -## Examples - The following example illustrates calls to the method. - + objects are equal, this method performs a property-by-property comparison. The method returns `true` only if the current object and the `other` object have identical values for each of the object's six property values. + + + +## Examples + The following example illustrates calls to the method. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet7"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet7"::: + ]]> @@ -621,30 +621,30 @@ if the time change rule is fixed-date; if the time change rule is floating-date. - property determines which properties of a object have valid values. The following table indicates which properties are affected by the value of the property. - -|TransitionTime property|IsFixedDateRule = true|IsFixedDateRule = false| -|-----------------------------|-----------------------------|------------------------------| -|`Day`|Valid|Unused| -|`DayOfWeek`|Unused|Valid| -|`Week`|Unused|Valid| -|`Month`|Valid|Valid| -|`TimeOfDay`|Valid|Valid| - - - -## Examples - The following example lists the transition times to and from daylight saving time for all time zones that are available on the local system. For time zones with fixed-date rules, it displays transition time information from the properties of the object. For time zones without fixed-date rules, it uses a object that represents the current system calendar to determine the actual start and end dates of the transition. The example displays the results to the console. - + property determines which properties of a object have valid values. The following table indicates which properties are affected by the value of the property. + +|TransitionTime property|IsFixedDateRule = true|IsFixedDateRule = false| +|-----------------------------|-----------------------------|------------------------------| +|`Day`|Valid|Unused| +|`DayOfWeek`|Unused|Valid| +|`Week`|Unused|Valid| +|`Month`|Valid|Valid| +|`TimeOfDay`|Valid|Valid| + + + +## Examples + The following example lists the transition times to and from daylight saving time for all time zones that are available on the local system. For time zones with fixed-date rules, it displays transition time information from the properties of the object. For time zones without fixed-date rules, it uses a object that represents the current system calendar to determine the actual start and end dates of the transition. The example displays the results to the console. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/example1.cs" id="Snippet5"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/example1.fs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/example1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/example1.vb" id="Snippet5"::: + ]]> @@ -689,22 +689,22 @@ Gets the month in which the time change occurs. The month in which the time change occurs. - property range from 1 to 12. - - The property is used for both fixed-date and floating-date rules. - - - -## Examples - The following example enumerates the time zones found on the local computer and displays transition time information for all floating-date transitions. The time information includes the month in which the time change occurs. - + property range from 1 to 12. + + The property is used for both fixed-date and floating-date rules. + + + +## Examples + The following example enumerates the time zones found on the local computer and displays transition time information for all floating-date transitions. The time information includes the month in which the time change occurs. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet4"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet4"::: + ]]> @@ -765,11 +765,11 @@ if and have identical values; otherwise, . - objects are equal if they have identical values for each of their six properties. Otherwise, they are unequal. - + objects are equal if they have identical values for each of their six properties. Otherwise, they are unequal. + The equivalent method for this operator is .]]> @@ -830,11 +830,11 @@ if and have any different member values; otherwise, . - objects are unequal if they have different values for any of their six properties. Otherwise, they are equal. - + objects are unequal if they have different values for any of their six properties. Otherwise, they are equal. + The equivalent method for this operator is .]]> @@ -983,24 +983,24 @@ Gets the hour, minute, and second at which the time change occurs. The time of day at which the time change occurs. - value represents the time of the transition in the time zone's standard time. For transitions from daylight saving time to standard time, it represents the time of the transition in the time zone's daylight saving time. - - The property defines only the time of a time change, but not its date. The date is determined by the and properties for fixed-rule changes, and by the , , and properties for floating-rule changes. The date component of this value is ignored; the value of the year, month, and day is always 1. - - The property is used for both fixed-date and floating-date transitions. - - - -## Examples - The following example enumerates the time zones found on the local computer and displays transition time information for those time zones that have adjustment rules. The time information includes the time of day at which the time change occurs. - + value represents the time of the transition in the time zone's standard time. For transitions from daylight saving time to standard time, it represents the time of the transition in the time zone's daylight saving time. + + The property defines only the time of a time change, but not its date. The date is determined by the and properties for fixed-rule changes, and by the , , and properties for floating-rule changes. The date component of this value is ignored; the value of the year, month, and day is always 1. + + The property is used for both fixed-date and floating-date transitions. + + + +## Examples + The following example enumerates the time zones found on the local computer and displays transition time information for those time zones that have adjustment rules. The time information includes the time of day at which the time change occurs. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet6"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet6"::: + ]]> @@ -1045,32 +1045,32 @@ Gets the week of the month in which a time change occurs. The week of the month in which the time change occurs. - property is used only for time changes with floating-date rules. Valid values can range from 1 to 5. - - The property defines the month in which the time change occurs. The property determines the week on which the transition occurs. The property defines the day of the week on which the transition occurs. The value of the property is determined as shown in the following table. - -|If the Week property value is|The transition occurs on| -|-----------------------------------|------------------------------| -|1|The first occurrence of the value in .| -|2|The second occurrence of the value in .| -|3|The third occurrence of the value in .| -|4|The fourth occurrence of the value in .| -|5|The last occurrence of the value in .| - - For example, if a transition occurs on the first Sunday of March, the value of the property is 1. If it occurs on the last Sunday of March, the value of the property is 5. - - - -## Examples - The following example enumerates the time zones found on the local computer and displays transition time information for all floating-date transitions. The time information includes the week of the month in which the time change occurs. The example also defines a `WeekOfMonth` enumeration to display a string that represents the ordinal value of the property rather than an integer. - + property is used only for time changes with floating-date rules. Valid values can range from 1 to 5. + + The property defines the month in which the time change occurs. The property determines the week on which the transition occurs. The property defines the day of the week on which the transition occurs. The value of the property is determined as shown in the following table. + +|If the Week property value is|The transition occurs on| +|-----------------------------------|------------------------------| +|1|The first occurrence of the value in .| +|2|The second occurrence of the value in .| +|3|The third occurrence of the value in .| +|4|The fourth occurrence of the value in .| +|5|The last occurrence of the value in .| + + For example, if a transition occurs on the first Sunday of March, the value of the property is 1. If it occurs on the last Sunday of March, the value of the property is 5. + + + +## Examples + The following example enumerates the time zones found on the local computer and displays transition time information for all floating-date transitions. The time information includes the week of the month in which the time change occurs. The example also defines a `WeekOfMonth` enumeration to display a string that represents the ordinal value of the property rather than an integer. + :::code language="csharp" source="~/snippets/csharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.cs" id="Snippet4"::: :::code language="fsharp" source="~/snippets/fsharp/System/TimeZoneInfo+TransitionTime/CreateFixedDateRule/System.TimeZone2.TransitionTime.Class.fs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.TimeZone2.TransitionTime.Class/vb/System.TimeZone2.TransitionTime.Class.vb" id="Snippet4"::: + ]]>